diff --git a/docs/dyn/accesscontextmanager_v1.accessPolicies.accessLevels.html b/docs/dyn/accesscontextmanager_v1.accessPolicies.accessLevels.html index 558a2d04924..fa9f3f99417 100644 --- a/docs/dyn/accesscontextmanager_v1.accessPolicies.accessLevels.html +++ b/docs/dyn/accesscontextmanager_v1.accessPolicies.accessLevels.html @@ -154,7 +154,7 @@

Method Details

], "vpcNetworkSources": [ # The request must originate from one of the provided VPC networks in Google Cloud. Cannot specify this field together with `ip_subnetworks`. { # The originating network source in Google Cloud. - "vpcSubnetwork": { # Sub-segment ranges inside of a VPC Network. # Sub-segment ranges of a VPC network. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "vpcSubnetwork": { # Sub-segment ranges inside of a VPC Network. # Sub-segment ranges of a VPC network. "network": "A String", # Required. Network name. If the network is not part of the organization, the `compute.network.get` permission must be granted to the caller. Format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NETWORK_NAME}` Example: `//compute.googleapis.com/projects/my-project/global/networks/network-1` "vpcIpSubnetworks": [ # CIDR block IP subnetwork specification. The IP address must be an IPv4 address and can be a public or private IP address. Note that for a CIDR IP address block, the specified IP address portion must be properly truncated (i.e. all the host bits must be zero) or the input is considered malformed. For example, "192.0.2.0/24" is accepted but "192.0.2.1/24" is not. If empty, all IP addresses are allowed. "A String", @@ -299,7 +299,7 @@

Method Details

], "vpcNetworkSources": [ # The request must originate from one of the provided VPC networks in Google Cloud. Cannot specify this field together with `ip_subnetworks`. { # The originating network source in Google Cloud. - "vpcSubnetwork": { # Sub-segment ranges inside of a VPC Network. # Sub-segment ranges of a VPC network. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "vpcSubnetwork": { # Sub-segment ranges inside of a VPC Network. # Sub-segment ranges of a VPC network. "network": "A String", # Required. Network name. If the network is not part of the organization, the `compute.network.get` permission must be granted to the caller. Format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NETWORK_NAME}` Example: `//compute.googleapis.com/projects/my-project/global/networks/network-1` "vpcIpSubnetworks": [ # CIDR block IP subnetwork specification. The IP address must be an IPv4 address and can be a public or private IP address. Note that for a CIDR IP address block, the specified IP address portion must be properly truncated (i.e. all the host bits must be zero) or the input is considered malformed. For example, "192.0.2.0/24" is accepted but "192.0.2.1/24" is not. If empty, all IP addresses are allowed. "A String", @@ -385,7 +385,7 @@

Method Details

], "vpcNetworkSources": [ # The request must originate from one of the provided VPC networks in Google Cloud. Cannot specify this field together with `ip_subnetworks`. { # The originating network source in Google Cloud. - "vpcSubnetwork": { # Sub-segment ranges inside of a VPC Network. # Sub-segment ranges of a VPC network. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "vpcSubnetwork": { # Sub-segment ranges inside of a VPC Network. # Sub-segment ranges of a VPC network. "network": "A String", # Required. Network name. If the network is not part of the organization, the `compute.network.get` permission must be granted to the caller. Format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NETWORK_NAME}` Example: `//compute.googleapis.com/projects/my-project/global/networks/network-1` "vpcIpSubnetworks": [ # CIDR block IP subnetwork specification. The IP address must be an IPv4 address and can be a public or private IP address. Note that for a CIDR IP address block, the specified IP address portion must be properly truncated (i.e. all the host bits must be zero) or the input is considered malformed. For example, "192.0.2.0/24" is accepted but "192.0.2.1/24" is not. If empty, all IP addresses are allowed. "A String", @@ -474,7 +474,7 @@

Method Details

], "vpcNetworkSources": [ # The request must originate from one of the provided VPC networks in Google Cloud. Cannot specify this field together with `ip_subnetworks`. { # The originating network source in Google Cloud. - "vpcSubnetwork": { # Sub-segment ranges inside of a VPC Network. # Sub-segment ranges of a VPC network. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "vpcSubnetwork": { # Sub-segment ranges inside of a VPC Network. # Sub-segment ranges of a VPC network. "network": "A String", # Required. Network name. If the network is not part of the organization, the `compute.network.get` permission must be granted to the caller. Format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NETWORK_NAME}` Example: `//compute.googleapis.com/projects/my-project/global/networks/network-1` "vpcIpSubnetworks": [ # CIDR block IP subnetwork specification. The IP address must be an IPv4 address and can be a public or private IP address. Note that for a CIDR IP address block, the specified IP address portion must be properly truncated (i.e. all the host bits must be zero) or the input is considered malformed. For example, "192.0.2.0/24" is accepted but "192.0.2.1/24" is not. If empty, all IP addresses are allowed. "A String", @@ -577,7 +577,7 @@

Method Details

], "vpcNetworkSources": [ # The request must originate from one of the provided VPC networks in Google Cloud. Cannot specify this field together with `ip_subnetworks`. { # The originating network source in Google Cloud. - "vpcSubnetwork": { # Sub-segment ranges inside of a VPC Network. # Sub-segment ranges of a VPC network. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "vpcSubnetwork": { # Sub-segment ranges inside of a VPC Network. # Sub-segment ranges of a VPC network. "network": "A String", # Required. Network name. If the network is not part of the organization, the `compute.network.get` permission must be granted to the caller. Format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NETWORK_NAME}` Example: `//compute.googleapis.com/projects/my-project/global/networks/network-1` "vpcIpSubnetworks": [ # CIDR block IP subnetwork specification. The IP address must be an IPv4 address and can be a public or private IP address. Note that for a CIDR IP address block, the specified IP address portion must be properly truncated (i.e. all the host bits must be zero) or the input is considered malformed. For example, "192.0.2.0/24" is accepted but "192.0.2.1/24" is not. If empty, all IP addresses are allowed. "A String", diff --git a/docs/dyn/accesscontextmanager_v1.accessPolicies.servicePerimeters.html b/docs/dyn/accesscontextmanager_v1.accessPolicies.servicePerimeters.html index f2fa669849b..4c57a03e76a 100644 --- a/docs/dyn/accesscontextmanager_v1.accessPolicies.servicePerimeters.html +++ b/docs/dyn/accesscontextmanager_v1.accessPolicies.servicePerimeters.html @@ -177,9 +177,9 @@

Method Details

], "identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. "sourceRestriction": "A String", # Whether to enforce traffic restrictions based on `sources` field. If the `sources` fields is non-empty, then this field must be set to `SOURCE_RESTRICTION_ENABLED`. - "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. - "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. }, ], }, @@ -261,9 +261,9 @@

Method Details

], "identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. "sourceRestriction": "A String", # Whether to enforce traffic restrictions based on `sources` field. If the `sources` fields is non-empty, then this field must be set to `SOURCE_RESTRICTION_ENABLED`. - "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. - "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. }, ], }, @@ -431,9 +431,9 @@

Method Details

], "identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. "sourceRestriction": "A String", # Whether to enforce traffic restrictions based on `sources` field. If the `sources` fields is non-empty, then this field must be set to `SOURCE_RESTRICTION_ENABLED`. - "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. - "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. }, ], }, @@ -515,9 +515,9 @@

Method Details

], "identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. "sourceRestriction": "A String", # Whether to enforce traffic restrictions based on `sources` field. If the `sources` fields is non-empty, then this field must be set to `SOURCE_RESTRICTION_ENABLED`. - "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. - "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. }, ], }, @@ -627,9 +627,9 @@

Method Details

], "identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. "sourceRestriction": "A String", # Whether to enforce traffic restrictions based on `sources` field. If the `sources` fields is non-empty, then this field must be set to `SOURCE_RESTRICTION_ENABLED`. - "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. - "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. }, ], }, @@ -711,9 +711,9 @@

Method Details

], "identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. "sourceRestriction": "A String", # Whether to enforce traffic restrictions based on `sources` field. If the `sources` fields is non-empty, then this field must be set to `SOURCE_RESTRICTION_ENABLED`. - "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. - "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. }, ], }, @@ -829,9 +829,9 @@

Method Details

], "identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. "sourceRestriction": "A String", # Whether to enforce traffic restrictions based on `sources` field. If the `sources` fields is non-empty, then this field must be set to `SOURCE_RESTRICTION_ENABLED`. - "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. - "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. }, ], }, @@ -913,9 +913,9 @@

Method Details

], "identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. "sourceRestriction": "A String", # Whether to enforce traffic restrictions based on `sources` field. If the `sources` fields is non-empty, then this field must be set to `SOURCE_RESTRICTION_ENABLED`. - "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. - "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. }, ], }, @@ -1047,9 +1047,9 @@

Method Details

], "identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. "sourceRestriction": "A String", # Whether to enforce traffic restrictions based on `sources` field. If the `sources` fields is non-empty, then this field must be set to `SOURCE_RESTRICTION_ENABLED`. - "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. - "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. }, ], }, @@ -1131,9 +1131,9 @@

Method Details

], "identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. "sourceRestriction": "A String", # Whether to enforce traffic restrictions based on `sources` field. If the `sources` fields is non-empty, then this field must be set to `SOURCE_RESTRICTION_ENABLED`. - "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. - "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. }, ], }, diff --git a/docs/dyn/adsenseplatform_v1.html b/docs/dyn/adsenseplatform_v1.html new file mode 100644 index 00000000000..ba547cb16b8 --- /dev/null +++ b/docs/dyn/adsenseplatform_v1.html @@ -0,0 +1,111 @@ + + + +

AdSense Platform API

+

Instance Methods

+

+ platforms() +

+

Returns the platforms Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ new_batch_http_request()

+

Create a BatchHttpRequest object based on the discovery document.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ 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.
+                
+
+ + \ No newline at end of file diff --git a/docs/dyn/adsenseplatform_v1.platforms.accounts.events.html b/docs/dyn/adsenseplatform_v1.platforms.accounts.events.html new file mode 100644 index 00000000000..7f12463dc4b --- /dev/null +++ b/docs/dyn/adsenseplatform_v1.platforms.accounts.events.html @@ -0,0 +1,147 @@ + + + +

AdSense Platform API . platforms . accounts . events

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ create(parent, body=None, x__xgafv=None)

+

Creates an account event.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) +
Creates an account event.
+
+Args:
+  parent: string, Required. Account to log events about. Format: platforms/{platform}/accounts/{account} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A platform sub-account event to record spam signals.
+  "eventInfo": { # Private information for partner recorded events (PII). # Required. Information associated with the event.
+    "billingAddress": { # Address data. # The billing address of the publisher associated with this event, if available.
+      "address1": "A String", # First line of address. Max length 64 bytes or 30 characters.
+      "address2": "A String", # Second line of address. Max length 64 bytes or 30 characters.
+      "city": "A String", # City. Max length 60 bytes or 30 characters.
+      "company": "A String", # Name of the company. Max length 255 bytes or 34 characters.
+      "contact": "A String", # Contact name of the company. Max length 128 bytes or 34 characters.
+      "fax": "A String", # Fax number with international code (i.e. +441234567890).
+      "phone": "A String", # Phone number with international code (i.e. +441234567890).
+      "regionCode": "A String", # Country/Region code. The region is specified as a CLDR region code (e.g. "US", "FR").
+      "state": "A String", # State. Max length 60 bytes or 30 characters.
+      "zip": "A String", # Zip/post code. Max length 10 bytes or 10 characters.
+    },
+    "email": "A String", # Required. The email address that is associated with the publisher when performing the event.
+  },
+  "eventTime": "A String", # Required. Event timestamp.
+  "eventType": "A String", # Required. Event type.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A platform sub-account event to record spam signals.
+  "eventInfo": { # Private information for partner recorded events (PII). # Required. Information associated with the event.
+    "billingAddress": { # Address data. # The billing address of the publisher associated with this event, if available.
+      "address1": "A String", # First line of address. Max length 64 bytes or 30 characters.
+      "address2": "A String", # Second line of address. Max length 64 bytes or 30 characters.
+      "city": "A String", # City. Max length 60 bytes or 30 characters.
+      "company": "A String", # Name of the company. Max length 255 bytes or 34 characters.
+      "contact": "A String", # Contact name of the company. Max length 128 bytes or 34 characters.
+      "fax": "A String", # Fax number with international code (i.e. +441234567890).
+      "phone": "A String", # Phone number with international code (i.e. +441234567890).
+      "regionCode": "A String", # Country/Region code. The region is specified as a CLDR region code (e.g. "US", "FR").
+      "state": "A String", # State. Max length 60 bytes or 30 characters.
+      "zip": "A String", # Zip/post code. Max length 10 bytes or 10 characters.
+    },
+    "email": "A String", # Required. The email address that is associated with the publisher when performing the event.
+  },
+  "eventTime": "A String", # Required. Event timestamp.
+  "eventType": "A String", # Required. Event type.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/adsenseplatform_v1.platforms.accounts.html b/docs/dyn/adsenseplatform_v1.platforms.accounts.html new file mode 100644 index 00000000000..06f3491d1fa --- /dev/null +++ b/docs/dyn/adsenseplatform_v1.platforms.accounts.html @@ -0,0 +1,271 @@ + + + +

AdSense Platform API . platforms . accounts

+

Instance Methods

+

+ events() +

+

Returns the events Resource.

+ +

+ sites() +

+

Returns the sites Resource.

+ +

+ close(name, body=None, x__xgafv=None)

+

Closes a sub-account.

+

+ create(parent, body=None, x__xgafv=None)

+

Creates a sub-account.

+

+ get(name, x__xgafv=None)

+

Gets information about the selected sub-account.

+

+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists a partial view of sub-accounts for a specific parent account.

+

+ list_next()

+

Retrieves the next page of results.

+

+ lookup(parent, creationRequestId=None, x__xgafv=None)

+

Looks up information about a sub-account for a specified creation_request_id. If no account exists for the given creation_request_id, returns 404.

+

Method Details

+
+ close(name, body=None, x__xgafv=None) +
Closes a sub-account.
+
+Args:
+  name: string, Required. Account to close. Format: platforms/{platform}/accounts/{account_id} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request definition for the account close rpc.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response definition for the account close rpc.
+}
+
+ +
+ create(parent, body=None, x__xgafv=None) +
Creates a sub-account.
+
+Args:
+  parent: string, Required. Platform to create an account for. Format: platforms/{platform} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Representation of an Account.
+  "createTime": "A String", # Output only. Creation time of the account.
+  "creationRequestId": "A String", # Required. An opaque token that uniquely identifies the account among all the platform's accounts. This string may contain at most 64 non-whitespace ASCII characters, but otherwise has no predefined structure. However, it is expected to be a platform-specific identifier for the user creating the account, so that only a single account can be created for any given user. This field must not contain any information that is recognizable as personally identifiable information. e.g. it should not be an email address or login name. Once an account has been created, a second attempt to create an account using the same creation_request_id will result in an ALREADY_EXISTS error.
+  "displayName": "A String", # Display name of this account.
+  "name": "A String", # Output only. Resource name of the account. Format: platforms/pub-[0-9]+/accounts/pub-[0-9]+
+  "regionCode": "A String", # Required. Input only. CLDR region code of the country/region of the address. Set this to country code of the child account if known, otherwise to your own country code.
+  "state": "A String", # Output only. Approval state of the account.
+  "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Required. The IANA TZ timezone code of this account. For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. This field is used for reporting. It is recommended to set it to the same value for all child accounts.
+    "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
+    "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Representation of an Account.
+  "createTime": "A String", # Output only. Creation time of the account.
+  "creationRequestId": "A String", # Required. An opaque token that uniquely identifies the account among all the platform's accounts. This string may contain at most 64 non-whitespace ASCII characters, but otherwise has no predefined structure. However, it is expected to be a platform-specific identifier for the user creating the account, so that only a single account can be created for any given user. This field must not contain any information that is recognizable as personally identifiable information. e.g. it should not be an email address or login name. Once an account has been created, a second attempt to create an account using the same creation_request_id will result in an ALREADY_EXISTS error.
+  "displayName": "A String", # Display name of this account.
+  "name": "A String", # Output only. Resource name of the account. Format: platforms/pub-[0-9]+/accounts/pub-[0-9]+
+  "regionCode": "A String", # Required. Input only. CLDR region code of the country/region of the address. Set this to country code of the child account if known, otherwise to your own country code.
+  "state": "A String", # Output only. Approval state of the account.
+  "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Required. The IANA TZ timezone code of this account. For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. This field is used for reporting. It is recommended to set it to the same value for all child accounts.
+    "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
+    "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+  },
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets information about the selected sub-account.
+
+Args:
+  name: string, Required. Account to get information about. Format: platforms/{platform}/accounts/{account_id} (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Representation of an Account.
+  "createTime": "A String", # Output only. Creation time of the account.
+  "creationRequestId": "A String", # Required. An opaque token that uniquely identifies the account among all the platform's accounts. This string may contain at most 64 non-whitespace ASCII characters, but otherwise has no predefined structure. However, it is expected to be a platform-specific identifier for the user creating the account, so that only a single account can be created for any given user. This field must not contain any information that is recognizable as personally identifiable information. e.g. it should not be an email address or login name. Once an account has been created, a second attempt to create an account using the same creation_request_id will result in an ALREADY_EXISTS error.
+  "displayName": "A String", # Display name of this account.
+  "name": "A String", # Output only. Resource name of the account. Format: platforms/pub-[0-9]+/accounts/pub-[0-9]+
+  "regionCode": "A String", # Required. Input only. CLDR region code of the country/region of the address. Set this to country code of the child account if known, otherwise to your own country code.
+  "state": "A String", # Output only. Approval state of the account.
+  "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Required. The IANA TZ timezone code of this account. For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. This field is used for reporting. It is recommended to set it to the same value for all child accounts.
+    "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
+    "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+  },
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Lists a partial view of sub-accounts for a specific parent account.
+
+Args:
+  parent: string, Required. Platform who parents the accounts. Format: platforms/{platform} (required)
+  pageSize: integer, Optional. The maximum number of accounts to include in the response, used for paging. If unspecified, at most 10000 accounts will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.
+  pageToken: string, Optional. A page token, received from a previous `ListAccounts` call. Provide this to retrieve 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:
+
+    { # Response definition for the list accounts rpc.
+  "accounts": [ # The Accounts returned in the list response. Represented by a partial view of the Account resource, populating `name` and `creation_request_id`.
+    { # Representation of an Account.
+      "createTime": "A String", # Output only. Creation time of the account.
+      "creationRequestId": "A String", # Required. An opaque token that uniquely identifies the account among all the platform's accounts. This string may contain at most 64 non-whitespace ASCII characters, but otherwise has no predefined structure. However, it is expected to be a platform-specific identifier for the user creating the account, so that only a single account can be created for any given user. This field must not contain any information that is recognizable as personally identifiable information. e.g. it should not be an email address or login name. Once an account has been created, a second attempt to create an account using the same creation_request_id will result in an ALREADY_EXISTS error.
+      "displayName": "A String", # Display name of this account.
+      "name": "A String", # Output only. Resource name of the account. Format: platforms/pub-[0-9]+/accounts/pub-[0-9]+
+      "regionCode": "A String", # Required. Input only. CLDR region code of the country/region of the address. Set this to country code of the child account if known, otherwise to your own country code.
+      "state": "A String", # Output only. Approval state of the account.
+      "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Required. The IANA TZ timezone code of this account. For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. This field is used for reporting. It is recommended to set it to the same value for all child accounts.
+        "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
+        "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+      },
+    },
+  ],
+  "nextPageToken": "A String", # Continuation token used to page through accounts. To retrieve the next page of the results, set the next request's "page_token" value to this.
+}
+
+ +
+ 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.
+        
+
+ +
+ lookup(parent, creationRequestId=None, x__xgafv=None) +
Looks up information about a sub-account for a specified creation_request_id. If no account exists for the given creation_request_id, returns 404.
+
+Args:
+  parent: string, Required. Platform who parents the account. Format: platforms/{platform} (required)
+  creationRequestId: string, Optional. The creation_request_id provided when calling createAccount.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response definition for the lookup account rpc.
+  "name": "A String", # The name of the Account Format: platforms/{platform}/accounts/{account_id}
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/adsenseplatform_v1.platforms.accounts.sites.html b/docs/dyn/adsenseplatform_v1.platforms.accounts.sites.html new file mode 100644 index 00000000000..4a95b8d4c14 --- /dev/null +++ b/docs/dyn/adsenseplatform_v1.platforms.accounts.sites.html @@ -0,0 +1,233 @@ + + + +

AdSense Platform API . platforms . accounts . sites

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ create(parent, body=None, x__xgafv=None)

+

Creates a site for a specified account.

+

+ delete(name, x__xgafv=None)

+

Deletes a site from a specified account.

+

+ get(name, x__xgafv=None)

+

Gets a site from a specified sub-account.

+

+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists sites for a specific account.

+

+ list_next()

+

Retrieves the next page of results.

+

+ requestReview(name, x__xgafv=None)

+

Requests the review of a site. The site should be in REQUIRES_REVIEW or NEEDS_ATTENTION state. Note: Make sure you place an [ad tag](https://developers.google.com/adsense/platforms/direct/ad-tags) on your site before requesting a review.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) +
Creates a site for a specified account.
+
+Args:
+  parent: string, Required. Account to create site. Format: platforms/{platform}/accounts/{account_id} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Representation of a Site.
+  "domain": "A String", # Domain/sub-domain of the site. Must be a valid domain complying with [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt) and formatted as punycode [RFC 3492](https://www.ietf.org/rfc/rfc3492.txt) in case the domain contains unicode characters.
+  "name": "A String", # Output only. Resource name of a site. Format: platforms/{platform}/accounts/{account}/sites/{site}
+  "state": "A String", # Output only. State of a site.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Representation of a Site.
+  "domain": "A String", # Domain/sub-domain of the site. Must be a valid domain complying with [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt) and formatted as punycode [RFC 3492](https://www.ietf.org/rfc/rfc3492.txt) in case the domain contains unicode characters.
+  "name": "A String", # Output only. Resource name of a site. Format: platforms/{platform}/accounts/{account}/sites/{site}
+  "state": "A String", # Output only. State of a site.
+}
+
+ +
+ delete(name, x__xgafv=None) +
Deletes a site from a specified account.
+
+Args:
+  name: string, Required. The name of the site to delete. Format: platforms/{platform}/accounts/{account}/sites/{site} (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 a site from a specified sub-account.
+
+Args:
+  name: string, Required. The name of the site to retrieve. Format: platforms/{platform}/accounts/{account}/sites/{site} (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Representation of a Site.
+  "domain": "A String", # Domain/sub-domain of the site. Must be a valid domain complying with [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt) and formatted as punycode [RFC 3492](https://www.ietf.org/rfc/rfc3492.txt) in case the domain contains unicode characters.
+  "name": "A String", # Output only. Resource name of a site. Format: platforms/{platform}/accounts/{account}/sites/{site}
+  "state": "A String", # Output only. State of a site.
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Lists sites for a specific account.
+
+Args:
+  parent: string, Required. The account which owns the sites. Format: platforms/{platform}/accounts/{account} (required)
+  pageSize: integer, The maximum number of sites to include in the response, used for paging. If unspecified, at most 10000 sites will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.
+  pageToken: string, A page token, received from a previous `ListSites` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSites` must 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:
+
+    { # Response definition for the site list rpc.
+  "nextPageToken": "A String", # Continuation token used to page through sites. To retrieve the next page of the results, set the next request's "page_token" value to this.
+  "sites": [ # The sites returned in this list response.
+    { # Representation of a Site.
+      "domain": "A String", # Domain/sub-domain of the site. Must be a valid domain complying with [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt) and formatted as punycode [RFC 3492](https://www.ietf.org/rfc/rfc3492.txt) in case the domain contains unicode characters.
+      "name": "A String", # Output only. Resource name of a site. Format: platforms/{platform}/accounts/{account}/sites/{site}
+      "state": "A String", # Output only. State of a site.
+    },
+  ],
+}
+
+ +
+ 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.
+        
+
+ +
+ requestReview(name, x__xgafv=None) +
Requests the review of a site. The site should be in REQUIRES_REVIEW or NEEDS_ATTENTION state. Note: Make sure you place an [ad tag](https://developers.google.com/adsense/platforms/direct/ad-tags) on your site before requesting a review.
+
+Args:
+  name: string, Required. The name of the site to submit for review. Format: platforms/{platform}/accounts/{account}/sites/{site} (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response definition for the site request review rpc.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/adsenseplatform_v1.platforms.html b/docs/dyn/adsenseplatform_v1.platforms.html new file mode 100644 index 00000000000..f29fbe80cf9 --- /dev/null +++ b/docs/dyn/adsenseplatform_v1.platforms.html @@ -0,0 +1,91 @@ + + + +

AdSense Platform API . platforms

+

Instance Methods

+

+ accounts() +

+

Returns the accounts Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.projects.locations.customJobs.html b/docs/dyn/aiplatform_v1.projects.locations.customJobs.html index 6144b94f678..e8f43c5be17 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.customJobs.html +++ b/docs/dyn/aiplatform_v1.projects.locations.customJobs.html @@ -175,6 +175,7 @@

Method Details

"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob. "disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false. "restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job. + "strategy": "A String", # Optional. This determines which type of scheduling strategy to use. "timeout": "A String", # The maximum job running time. The default is 7 days. }, "serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used. @@ -289,6 +290,7 @@

Method Details

"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob. "disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false. "restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job. + "strategy": "A String", # Optional. This determines which type of scheduling strategy to use. "timeout": "A String", # The maximum job running time. The default is 7 days. }, "serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used. @@ -445,6 +447,7 @@

Method Details

"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob. "disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false. "restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job. + "strategy": "A String", # Optional. This determines which type of scheduling strategy to use. "timeout": "A String", # The maximum job running time. The default is 7 days. }, "serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used. @@ -572,6 +575,7 @@

Method Details

"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob. "disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false. "restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job. + "strategy": "A String", # Optional. This determines which type of scheduling strategy to use. "timeout": "A String", # The maximum job running time. The default is 7 days. }, "serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used. diff --git a/docs/dyn/aiplatform_v1.projects.locations.datasets.datasetVersions.html b/docs/dyn/aiplatform_v1.projects.locations.datasets.datasetVersions.html index d834f3c933d..27ac91cb8ce 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.datasets.datasetVersions.html +++ b/docs/dyn/aiplatform_v1.projects.locations.datasets.datasetVersions.html @@ -120,7 +120,7 @@

Method Details

"etag": "A String", # Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. "metadata": "", # Required. Output only. Additional information about the DatasetVersion. "modelReference": "A String", # Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions. - "name": "A String", # Output only. The resource name of the DatasetVersion. + "name": "A String", # Output only. Identifier. The resource name of the DatasetVersion. "updateTime": "A String", # Output only. Timestamp when this DatasetVersion was last updated. } @@ -210,7 +210,7 @@

Method Details

"etag": "A String", # Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. "metadata": "", # Required. Output only. Additional information about the DatasetVersion. "modelReference": "A String", # Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions. - "name": "A String", # Output only. The resource name of the DatasetVersion. + "name": "A String", # Output only. Identifier. The resource name of the DatasetVersion. "updateTime": "A String", # Output only. Timestamp when this DatasetVersion was last updated. } @@ -243,7 +243,7 @@

Method Details

"etag": "A String", # Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. "metadata": "", # Required. Output only. Additional information about the DatasetVersion. "modelReference": "A String", # Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions. - "name": "A String", # Output only. The resource name of the DatasetVersion. + "name": "A String", # Output only. Identifier. The resource name of the DatasetVersion. "updateTime": "A String", # Output only. Timestamp when this DatasetVersion was last updated. }, ], @@ -270,7 +270,7 @@

Method Details

Updates a DatasetVersion.
 
 Args:
-  name: string, Output only. The resource name of the DatasetVersion. (required)
+  name: string, Output only. Identifier. The resource name of the DatasetVersion. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -281,7 +281,7 @@ 

Method Details

"etag": "A String", # Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. "metadata": "", # Required. Output only. Additional information about the DatasetVersion. "modelReference": "A String", # Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions. - "name": "A String", # Output only. The resource name of the DatasetVersion. + "name": "A String", # Output only. Identifier. The resource name of the DatasetVersion. "updateTime": "A String", # Output only. Timestamp when this DatasetVersion was last updated. } @@ -301,7 +301,7 @@

Method Details

"etag": "A String", # Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. "metadata": "", # Required. Output only. Additional information about the DatasetVersion. "modelReference": "A String", # Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions. - "name": "A String", # Output only. The resource name of the DatasetVersion. + "name": "A String", # Output only. Identifier. The resource name of the DatasetVersion. "updateTime": "A String", # Output only. Timestamp when this DatasetVersion was last updated. }
diff --git a/docs/dyn/aiplatform_v1.projects.locations.datasets.html b/docs/dyn/aiplatform_v1.projects.locations.datasets.html index 039f667f418..b14cce7c329 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.datasets.html +++ b/docs/dyn/aiplatform_v1.projects.locations.datasets.html @@ -163,7 +163,7 @@

Method Details

"metadataArtifact": "A String", # Output only. The resource name of the Artifact that was created in MetadataStore when creating the Dataset. The Artifact resource name pattern is `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`. "metadataSchemaUri": "A String", # Required. Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/. "modelReference": "A String", # Optional. Reference to the public base model last used by the dataset. Only set for prompt datasets. - "name": "A String", # Output only. The resource name of the Dataset. + "name": "A String", # Output only. Identifier. The resource name of the Dataset. "savedQueries": [ # All SavedQueries belong to the Dataset will be returned in List/Get Dataset response. The annotation_specs field will not be populated except for UI cases which will only use annotation_spec_count. In CreateDataset request, a SavedQuery is created together if this field is set, up to one SavedQuery can be set in CreateDatasetRequest. The SavedQuery should not contain any AnnotationSpec. { # A SavedQuery is a view of the dataset. It references a subset of annotations by problem type and filters. "annotationFilter": "A String", # Output only. Filters on the Annotations in the dataset. @@ -336,7 +336,7 @@

Method Details

"metadataArtifact": "A String", # Output only. The resource name of the Artifact that was created in MetadataStore when creating the Dataset. The Artifact resource name pattern is `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`. "metadataSchemaUri": "A String", # Required. Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/. "modelReference": "A String", # Optional. Reference to the public base model last used by the dataset. Only set for prompt datasets. - "name": "A String", # Output only. The resource name of the Dataset. + "name": "A String", # Output only. Identifier. The resource name of the Dataset. "savedQueries": [ # All SavedQueries belong to the Dataset will be returned in List/Get Dataset response. The annotation_specs field will not be populated except for UI cases which will only use annotation_spec_count. In CreateDataset request, a SavedQuery is created together if this field is set, up to one SavedQuery can be set in CreateDatasetRequest. The SavedQuery should not contain any AnnotationSpec. { # A SavedQuery is a view of the dataset. It references a subset of annotations by problem type and filters. "annotationFilter": "A String", # Output only. Filters on the Annotations in the dataset. @@ -449,7 +449,7 @@

Method Details

"metadataArtifact": "A String", # Output only. The resource name of the Artifact that was created in MetadataStore when creating the Dataset. The Artifact resource name pattern is `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`. "metadataSchemaUri": "A String", # Required. Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/. "modelReference": "A String", # Optional. Reference to the public base model last used by the dataset. Only set for prompt datasets. - "name": "A String", # Output only. The resource name of the Dataset. + "name": "A String", # Output only. Identifier. The resource name of the Dataset. "savedQueries": [ # All SavedQueries belong to the Dataset will be returned in List/Get Dataset response. The annotation_specs field will not be populated except for UI cases which will only use annotation_spec_count. In CreateDataset request, a SavedQuery is created together if this field is set, up to one SavedQuery can be set in CreateDatasetRequest. The SavedQuery should not contain any AnnotationSpec. { # A SavedQuery is a view of the dataset. It references a subset of annotations by problem type and filters. "annotationFilter": "A String", # Output only. Filters on the Annotations in the dataset. @@ -490,7 +490,7 @@

Method Details

Updates a Dataset.
 
 Args:
-  name: string, Output only. The resource name of the Dataset. (required)
+  name: string, Output only. Identifier. The resource name of the Dataset. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -510,7 +510,7 @@ 

Method Details

"metadataArtifact": "A String", # Output only. The resource name of the Artifact that was created in MetadataStore when creating the Dataset. The Artifact resource name pattern is `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`. "metadataSchemaUri": "A String", # Required. Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/. "modelReference": "A String", # Optional. Reference to the public base model last used by the dataset. Only set for prompt datasets. - "name": "A String", # Output only. The resource name of the Dataset. + "name": "A String", # Output only. Identifier. The resource name of the Dataset. "savedQueries": [ # All SavedQueries belong to the Dataset will be returned in List/Get Dataset response. The annotation_specs field will not be populated except for UI cases which will only use annotation_spec_count. In CreateDataset request, a SavedQuery is created together if this field is set, up to one SavedQuery can be set in CreateDatasetRequest. The SavedQuery should not contain any AnnotationSpec. { # A SavedQuery is a view of the dataset. It references a subset of annotations by problem type and filters. "annotationFilter": "A String", # Output only. Filters on the Annotations in the dataset. @@ -553,7 +553,7 @@

Method Details

"metadataArtifact": "A String", # Output only. The resource name of the Artifact that was created in MetadataStore when creating the Dataset. The Artifact resource name pattern is `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`. "metadataSchemaUri": "A String", # Required. Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/. "modelReference": "A String", # Optional. Reference to the public base model last used by the dataset. Only set for prompt datasets. - "name": "A String", # Output only. The resource name of the Dataset. + "name": "A String", # Output only. Identifier. The resource name of the Dataset. "savedQueries": [ # All SavedQueries belong to the Dataset will be returned in List/Get Dataset response. The annotation_specs field will not be populated except for UI cases which will only use annotation_spec_count. In CreateDataset request, a SavedQuery is created together if this field is set, up to one SavedQuery can be set in CreateDatasetRequest. The SavedQuery should not contain any AnnotationSpec. { # A SavedQuery is a view of the dataset. It references a subset of annotations by problem type and filters. "annotationFilter": "A String", # Output only. Filters on the Annotations in the dataset. diff --git a/docs/dyn/aiplatform_v1.projects.locations.endpoints.html b/docs/dyn/aiplatform_v1.projects.locations.endpoints.html index 15a076e84f3..3b52e278156 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.endpoints.html +++ b/docs/dyn/aiplatform_v1.projects.locations.endpoints.html @@ -158,7 +158,7 @@

Method Details

The object takes the form of: { # Request message for ComputeTokens RPC call. - "contents": [ # Required. Input content. + "contents": [ # Optional. Input 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. "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. @@ -192,10 +192,10 @@

Method Details

"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. }, ], - "instances": [ # Required. The instances that are the input to token computing API call. Schema is identical to the prediction schema of the text model, even for the non-text models, like chat models, or Codey models. + "instances": [ # Optional. The instances that are the input to token computing API call. Schema is identical to the prediction schema of the text model, even for the non-text models, like chat models, or Codey models. "", ], - "model": "A String", # Required. The name of the publisher model requested to serve the prediction. Format: projects/{project}/locations/{location}/publishers/*/models/* + "model": "A String", # Optional. The name of the publisher model requested to serve the prediction. Format: projects/{project}/locations/{location}/publishers/*/models/* } x__xgafv: string, V1 error format. @@ -231,7 +231,7 @@

Method Details

The object takes the form of: { # Request message for PredictionService.CountTokens. - "contents": [ # Required. Input content. + "contents": [ # Optional. Input 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. "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. @@ -265,10 +265,88 @@

Method Details

"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. }, ], - "instances": [ # Required. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model. + "instances": [ # Optional. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model. "", ], - "model": "A String", # Required. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*` + "model": "A String", # Optional. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*` + "systemInstruction": { # 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. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. + "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. 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. + "a_key": "", # Properties of the object. + }, + "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + }, + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "response": { # Required. The function response in JSON object format. + "a_key": "", # Properties of the object. + }, + }, + "inlineData": { # Content blob. It's preferred to send as text directly rather than raw bytes. # Optional. Inlined bytes data. + "data": "A String", # Required. Raw bytes. + "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. + "endOffset": "A String", # Optional. The end offset of the video. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "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. + }, + "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. + { # 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. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "functionDeclarations": [ # Optional. Function tool type. 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. + { # 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, dots and dashes, with a maximum length of 64. + "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. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "default": "", # Optional. Default value of the data. + "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", + ], + "example": "", # Optional. Example of the object. Will only populated when the object is the root. + "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maxLength": "A String", # Optional. Maximum length of the Type.STRING + "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT. + "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING + "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT. + "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER + "nullable": True or False, # Optional. Indicates if the value may be null. + "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression. + "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the Schema. + "type": "A String", # Optional. The type of the data. + }, + }, + ], + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. + }, + "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. + "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported. + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/vertex-ai-search-and-conversation # Set to use data source powered by Vertex AI Search. + "datastore": "A String", # Required. Fully-qualified Vertex AI Search's datastore resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + }, + }, + }, + ], } x__xgafv: string, V1 error format. @@ -296,6 +374,8 @@

Method Details

{ # Models are deployed into it, and afterwards Endpoint is called to obtain predictions and explanations. "createTime": "A String", # Output only. Timestamp when this Endpoint was created. + "dedicatedEndpointDns": "A String", # Output only. DNS of the dedicated endpoint. Will only be populated if dedicated_endpoint_enabled is true. Format: `https://{endpoint_id}.{region}-{project_number}.prediction.vertexai.goog`. + "dedicatedEndpointEnabled": True or False, # If true, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitation will be removed soon. "deployedModels": [ # Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively. { # A deployment of a Model. Endpoints contain one or more DeployedModels. "automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. @@ -1262,7 +1342,7 @@

Method Details

"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. }, "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. - "disableAttribution": True or False, # Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation. + "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported. "vertexAiSearch": { # Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/vertex-ai-search-and-conversation # Set to use data source powered by Vertex AI Search. "datastore": "A String", # Required. Fully-qualified Vertex AI Search's datastore resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` }, @@ -1333,21 +1413,6 @@

Method Details

"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. "groundingMetadata": { # Metadata returned to client when grounding is enabled. # Output only. Metadata specifies sources used to ground generated content. - "groundingAttributions": [ # Optional. List of grounding attributions. - { # Grounding attribution. - "confidenceScore": 3.14, # Optional. Output only. Confidence score of the attribution. Ranges from 0 to 1. 1 is the most confident. - "segment": { # Segment of the content. # Output only. Segment of the content this attribution belongs to. - "endIndex": 42, # Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero. - "partIndex": 42, # Output only. The index of a Part object within its parent Content object. - "startIndex": 42, # Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero. - "text": "A String", # Output only. The text corresponding to the segment from the response. - }, - "web": { # Attribution from the web. # Optional. Attribution from the web. - "title": "A String", # Output only. Title of the attribution. - "uri": "A String", # Output only. URI reference of the attribution. - }, - }, - ], "groundingChunks": [ # List of supporting references retrieved from specified grounding source. { # Grounding chunk. "retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools. @@ -1395,6 +1460,7 @@

Method Details

"severityScore": 3.14, # Output only. Harm severity score. }, ], + "score": 3.14, # Output only. Confidence score of the candidate. }, ], "promptFeedback": { # Content filter results for a prompt sent in the request. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. @@ -1435,6 +1501,8 @@

Method Details

{ # Models are deployed into it, and afterwards Endpoint is called to obtain predictions and explanations. "createTime": "A String", # Output only. Timestamp when this Endpoint was created. + "dedicatedEndpointDns": "A String", # Output only. DNS of the dedicated endpoint. Will only be populated if dedicated_endpoint_enabled is true. Format: `https://{endpoint_id}.{region}-{project_number}.prediction.vertexai.goog`. + "dedicatedEndpointEnabled": True or False, # If true, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitation will be removed soon. "deployedModels": [ # Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively. { # A deployment of a Model. Endpoints contain one or more DeployedModels. "automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. @@ -1639,6 +1707,8 @@

Method Details

"endpoints": [ # List of Endpoints in the requested page. { # Models are deployed into it, and afterwards Endpoint is called to obtain predictions and explanations. "createTime": "A String", # Output only. Timestamp when this Endpoint was created. + "dedicatedEndpointDns": "A String", # Output only. DNS of the dedicated endpoint. Will only be populated if dedicated_endpoint_enabled is true. Format: `https://{endpoint_id}.{region}-{project_number}.prediction.vertexai.goog`. + "dedicatedEndpointEnabled": True or False, # If true, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitation will be removed soon. "deployedModels": [ # Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively. { # A deployment of a Model. Endpoints contain one or more DeployedModels. "automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. @@ -2036,6 +2106,8 @@

Method Details

{ # Models are deployed into it, and afterwards Endpoint is called to obtain predictions and explanations. "createTime": "A String", # Output only. Timestamp when this Endpoint was created. + "dedicatedEndpointDns": "A String", # Output only. DNS of the dedicated endpoint. Will only be populated if dedicated_endpoint_enabled is true. Format: `https://{endpoint_id}.{region}-{project_number}.prediction.vertexai.goog`. + "dedicatedEndpointEnabled": True or False, # If true, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitation will be removed soon. "deployedModels": [ # Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively. { # A deployment of a Model. Endpoints contain one or more DeployedModels. "automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. @@ -2227,6 +2299,8 @@

Method Details

{ # Models are deployed into it, and afterwards Endpoint is called to obtain predictions and explanations. "createTime": "A String", # Output only. Timestamp when this Endpoint was created. + "dedicatedEndpointDns": "A String", # Output only. DNS of the dedicated endpoint. Will only be populated if dedicated_endpoint_enabled is true. Format: `https://{endpoint_id}.{region}-{project_number}.prediction.vertexai.goog`. + "dedicatedEndpointEnabled": True or False, # If true, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitation will be removed soon. "deployedModels": [ # Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively. { # A deployment of a Model. Endpoints contain one or more DeployedModels. "automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. @@ -2843,7 +2917,7 @@

Method Details

"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. }, "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. - "disableAttribution": True or False, # Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation. + "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported. "vertexAiSearch": { # Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/vertex-ai-search-and-conversation # Set to use data source powered by Vertex AI Search. "datastore": "A String", # Required. Fully-qualified Vertex AI Search's datastore resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` }, @@ -2914,21 +2988,6 @@

Method Details

"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. "groundingMetadata": { # Metadata returned to client when grounding is enabled. # Output only. Metadata specifies sources used to ground generated content. - "groundingAttributions": [ # Optional. List of grounding attributions. - { # Grounding attribution. - "confidenceScore": 3.14, # Optional. Output only. Confidence score of the attribution. Ranges from 0 to 1. 1 is the most confident. - "segment": { # Segment of the content. # Output only. Segment of the content this attribution belongs to. - "endIndex": 42, # Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero. - "partIndex": 42, # Output only. The index of a Part object within its parent Content object. - "startIndex": 42, # Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero. - "text": "A String", # Output only. The text corresponding to the segment from the response. - }, - "web": { # Attribution from the web. # Optional. Attribution from the web. - "title": "A String", # Output only. Title of the attribution. - "uri": "A String", # Output only. URI reference of the attribution. - }, - }, - ], "groundingChunks": [ # List of supporting references retrieved from specified grounding source. { # Grounding chunk. "retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools. @@ -2976,6 +3035,7 @@

Method Details

"severityScore": 3.14, # Output only. Harm severity score. }, ], + "score": 3.14, # Output only. Confidence score of the candidate. }, ], "promptFeedback": { # Content filter results for a prompt sent in the request. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. diff --git a/docs/dyn/aiplatform_v1.projects.locations.featureOnlineStores.featureViews.html b/docs/dyn/aiplatform_v1.projects.locations.featureOnlineStores.featureViews.html index a19f08ffba7..4f891b3ba45 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.featureOnlineStores.featureViews.html +++ b/docs/dyn/aiplatform_v1.projects.locations.featureOnlineStores.featureViews.html @@ -570,6 +570,15 @@

Method Details

}, "entityId": "A String", # Optional. The entity id whose similar entities should be searched for. If embedding is set, search will use embedding instead of entity_id. "neighborCount": 42, # Optional. The number of similar entities to be retrieved from feature view for each query. + "numericFilters": [ # Optional. The list of numeric filters. + { # Numeric filter is used to search a subset of the entities by using boolean rules on numeric columns. For example: Database Point 0: {name: “a” value_int: 42} {name: “b” value_float: 1.0} Database Point 1: {name: “a” value_int: 10} {name: “b” value_float: 2.0} Database Point 2: {name: “a” value_int: -1} {name: “b” value_float: 3.0} Query: {name: “a” value_int: 12 operator: LESS} // Matches Point 1, 2 {name: “b” value_float: 2.0 operator: EQUAL} // Matches Point 1 + "name": "A String", # Required. Column name in BigQuery that used as filters. + "op": "A String", # Optional. This MUST be specified for queries and must NOT be specified for database points. + "valueDouble": 3.14, # double value type. + "valueFloat": 3.14, # float value type. + "valueInt": "A String", # int value type. + }, + ], "parameters": { # Parameters that can be overrided in each query to tune query latency and recall. # Optional. Parameters that can be set to tune query on the fly. "approximateNeighborCandidates": 42, # Optional. The number of neighbors to find via approximate search before exact reordering is performed; if set, this value must be > neighbor_count. "leafNodesSearchFraction": 3.14, # Optional. The fraction of the number of leaves to search, set at query time allows user to tune search performance. This value increase result in both search accuracy and latency increase. The value should be between 0.0 and 1.0. diff --git a/docs/dyn/aiplatform_v1.projects.locations.hyperparameterTuningJobs.html b/docs/dyn/aiplatform_v1.projects.locations.hyperparameterTuningJobs.html index db0bc1330e6..b6d1cb1a1cc 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.hyperparameterTuningJobs.html +++ b/docs/dyn/aiplatform_v1.projects.locations.hyperparameterTuningJobs.html @@ -276,6 +276,7 @@

Method Details

"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob. "disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false. "restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job. + "strategy": "A String", # Optional. This determines which type of scheduling strategy to use. "timeout": "A String", # The maximum job running time. The default is 7 days. }, "serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used. @@ -525,6 +526,7 @@

Method Details

"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob. "disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false. "restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job. + "strategy": "A String", # Optional. This determines which type of scheduling strategy to use. "timeout": "A String", # The maximum job running time. The default is 7 days. }, "serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used. @@ -816,6 +818,7 @@

Method Details

"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob. "disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false. "restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job. + "strategy": "A String", # Optional. This determines which type of scheduling strategy to use. "timeout": "A String", # The maximum job running time. The default is 7 days. }, "serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used. @@ -1078,6 +1081,7 @@

Method Details

"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob. "disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false. "restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job. + "strategy": "A String", # Optional. This determines which type of scheduling strategy to use. "timeout": "A String", # The maximum job running time. The default is 7 days. }, "serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used. diff --git a/docs/dyn/aiplatform_v1.projects.locations.nasJobs.html b/docs/dyn/aiplatform_v1.projects.locations.nasJobs.html index 3b6a4c7c463..8c5da88f63b 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.nasJobs.html +++ b/docs/dyn/aiplatform_v1.projects.locations.nasJobs.html @@ -231,6 +231,7 @@

Method Details

"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob. "disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false. "restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job. + "strategy": "A String", # Optional. This determines which type of scheduling strategy to use. "timeout": "A String", # The maximum job running time. The default is 7 days. }, "serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used. @@ -313,6 +314,7 @@

Method Details

"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob. "disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false. "restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job. + "strategy": "A String", # Optional. This determines which type of scheduling strategy to use. "timeout": "A String", # The maximum job running time. The default is 7 days. }, "serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used. @@ -481,6 +483,7 @@

Method Details

"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob. "disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false. "restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job. + "strategy": "A String", # Optional. This determines which type of scheduling strategy to use. "timeout": "A String", # The maximum job running time. The default is 7 days. }, "serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used. @@ -563,6 +566,7 @@

Method Details

"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob. "disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false. "restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job. + "strategy": "A String", # Optional. This determines which type of scheduling strategy to use. "timeout": "A String", # The maximum job running time. The default is 7 days. }, "serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used. @@ -773,6 +777,7 @@

Method Details

"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob. "disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false. "restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job. + "strategy": "A String", # Optional. This determines which type of scheduling strategy to use. "timeout": "A String", # The maximum job running time. The default is 7 days. }, "serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used. @@ -855,6 +860,7 @@

Method Details

"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob. "disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false. "restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job. + "strategy": "A String", # Optional. This determines which type of scheduling strategy to use. "timeout": "A String", # The maximum job running time. The default is 7 days. }, "serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used. @@ -1036,6 +1042,7 @@

Method Details

"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob. "disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false. "restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job. + "strategy": "A String", # Optional. This determines which type of scheduling strategy to use. "timeout": "A String", # The maximum job running time. The default is 7 days. }, "serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used. @@ -1118,6 +1125,7 @@

Method Details

"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob. "disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false. "restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job. + "strategy": "A String", # Optional. This determines which type of scheduling strategy to use. "timeout": "A String", # The maximum job running time. The default is 7 days. }, "serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used. diff --git a/docs/dyn/aiplatform_v1.projects.locations.notebookExecutionJobs.html b/docs/dyn/aiplatform_v1.projects.locations.notebookExecutionJobs.html index d753195ab0f..a0ec7bf8358 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.notebookExecutionJobs.html +++ b/docs/dyn/aiplatform_v1.projects.locations.notebookExecutionJobs.html @@ -82,10 +82,273 @@

Instance Methods

close()

Close httplib2 connections.

+

+ create(parent, body=None, notebookExecutionJobId=None, x__xgafv=None)

+

Creates a NotebookExecutionJob.

+

+ delete(name, x__xgafv=None)

+

Deletes a NotebookExecutionJob.

+

+ get(name, view=None, x__xgafv=None)

+

Gets a NotebookExecutionJob.

+

+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)

+

Lists NotebookExecutionJobs in a Location.

+

+ list_next()

+

Retrieves the next page of results.

Method Details

close()
Close httplib2 connections.
+
+ create(parent, body=None, notebookExecutionJobId=None, x__xgafv=None) +
Creates a NotebookExecutionJob.
+
+Args:
+  parent: string, Required. The resource name of the Location to create the NotebookExecutionJob. Format: `projects/{project}/locations/{location}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # NotebookExecutionJob represents an instance of a notebook execution.
+  "createTime": "A String", # Output only. Timestamp when this NotebookExecutionJob was created.
+  "dataformRepositorySource": { # The Dataform Repository containing the input notebook. # The Dataform Repository pointing to a single file notebook repository.
+    "commitSha": "A String", # The commit SHA to read repository with. If unset, the file will be read at HEAD.
+    "dataformRepositoryResourceName": "A String", # The resource name of the Dataform Repository. Format: `projects/{project_id}/locations/{location}/repositories/{repository_id}`
+  },
+  "directNotebookSource": { # The content of the input notebook in ipynb format. # The contents of an input notebook file.
+    "content": "A String", # The base64-encoded contents of the input notebook file.
+  },
+  "displayName": "A String", # The display name of the NotebookExecutionJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.
+  "executionTimeout": "A String", # Max running time of the execution job in seconds (default 86400s / 24 hrs).
+  "executionUser": "A String", # The user email to run the execution as. Only supported by Colab runtimes.
+  "gcsNotebookSource": { # The Cloud Storage uri for the input notebook. # The Cloud Storage url pointing to the ipynb file. Format: `gs://bucket/notebook_file.ipynb`
+    "generation": "A String", # The version of the Cloud Storage object to read. If unset, the current version of the object is read. See https://cloud.google.com/storage/docs/metadata#generation-number.
+    "uri": "A String", # The Cloud Storage uri pointing to the ipynb file. Format: `gs://bucket/notebook_file.ipynb`
+  },
+  "gcsOutputUri": "A String", # The Cloud Storage location to upload the result to. Format: `gs://bucket-name`
+  "jobState": "A String", # Output only. The state of the NotebookExecutionJob.
+  "labels": { # The labels with user-defined metadata to organize NotebookExecutionJobs. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.
+    "a_key": "A String",
+  },
+  "name": "A String", # Output only. The resource name of this NotebookExecutionJob. Format: `projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}`
+  "notebookRuntimeTemplateResourceName": "A String", # The NotebookRuntimeTemplate to source compute configuration from.
+  "scheduleResourceName": "A String", # Output only. The Schedule resource name if this job is triggered by one. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
+  "serviceAccount": "A String", # The service account to run the execution as.
+  "status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Populated when the NotebookExecutionJob is completed. When there is an error during notebook execution, the error details are populated.
+    "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.
+  },
+  "updateTime": "A String", # Output only. Timestamp when this NotebookExecutionJob was most recently updated.
+}
+
+  notebookExecutionJobId: string, Optional. User specified ID for the NotebookExecutionJob.
+  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, x__xgafv=None) +
Deletes a NotebookExecutionJob.
+
+Args:
+  name: string, Required. The name of the NotebookExecutionJob 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:
+
+    { # 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, view=None, x__xgafv=None) +
Gets a NotebookExecutionJob.
+
+Args:
+  name: string, Required. The name of the NotebookExecutionJob resource. (required)
+  view: string, Optional. The NotebookExecutionJob view. Defaults to BASIC.
+    Allowed values
+      NOTEBOOK_EXECUTION_JOB_VIEW_UNSPECIFIED - When unspecified, the API defaults to the BASIC view.
+      NOTEBOOK_EXECUTION_JOB_VIEW_BASIC - Includes all fields except for direct notebook inputs.
+      NOTEBOOK_EXECUTION_JOB_VIEW_FULL - Includes all fields.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # NotebookExecutionJob represents an instance of a notebook execution.
+  "createTime": "A String", # Output only. Timestamp when this NotebookExecutionJob was created.
+  "dataformRepositorySource": { # The Dataform Repository containing the input notebook. # The Dataform Repository pointing to a single file notebook repository.
+    "commitSha": "A String", # The commit SHA to read repository with. If unset, the file will be read at HEAD.
+    "dataformRepositoryResourceName": "A String", # The resource name of the Dataform Repository. Format: `projects/{project_id}/locations/{location}/repositories/{repository_id}`
+  },
+  "directNotebookSource": { # The content of the input notebook in ipynb format. # The contents of an input notebook file.
+    "content": "A String", # The base64-encoded contents of the input notebook file.
+  },
+  "displayName": "A String", # The display name of the NotebookExecutionJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.
+  "executionTimeout": "A String", # Max running time of the execution job in seconds (default 86400s / 24 hrs).
+  "executionUser": "A String", # The user email to run the execution as. Only supported by Colab runtimes.
+  "gcsNotebookSource": { # The Cloud Storage uri for the input notebook. # The Cloud Storage url pointing to the ipynb file. Format: `gs://bucket/notebook_file.ipynb`
+    "generation": "A String", # The version of the Cloud Storage object to read. If unset, the current version of the object is read. See https://cloud.google.com/storage/docs/metadata#generation-number.
+    "uri": "A String", # The Cloud Storage uri pointing to the ipynb file. Format: `gs://bucket/notebook_file.ipynb`
+  },
+  "gcsOutputUri": "A String", # The Cloud Storage location to upload the result to. Format: `gs://bucket-name`
+  "jobState": "A String", # Output only. The state of the NotebookExecutionJob.
+  "labels": { # The labels with user-defined metadata to organize NotebookExecutionJobs. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.
+    "a_key": "A String",
+  },
+  "name": "A String", # Output only. The resource name of this NotebookExecutionJob. Format: `projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}`
+  "notebookRuntimeTemplateResourceName": "A String", # The NotebookRuntimeTemplate to source compute configuration from.
+  "scheduleResourceName": "A String", # Output only. The Schedule resource name if this job is triggered by one. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
+  "serviceAccount": "A String", # The service account to run the execution as.
+  "status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Populated when the NotebookExecutionJob is completed. When there is an error during notebook execution, the error details are populated.
+    "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.
+  },
+  "updateTime": "A String", # Output only. Timestamp when this NotebookExecutionJob was most recently updated.
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, view=None, x__xgafv=None) +
Lists NotebookExecutionJobs in a Location.
+
+Args:
+  parent: string, Required. The resource name of the Location from which to list the NotebookExecutionJobs. Format: `projects/{project}/locations/{location}` (required)
+  filter: string, Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookExecutionJob` supports = and !=. `notebookExecutionJob` represents the NotebookExecutionJob ID. * `displayName` supports = and != and regex. * `schedule` supports = and != and regex. Some examples: * `notebookExecutionJob="123"` * `notebookExecutionJob="my-execution-job"` * `displayName="myDisplayName"` and `displayName=~"myDisplayNameRegex"`
+  orderBy: string, Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`.
+  pageSize: integer, Optional. The standard list page size.
+  pageToken: string, Optional. The standard list page token. Typically obtained via ListNotebookExecutionJobs.next_page_token of the previous NotebookService.ListNotebookExecutionJobs call.
+  view: string, Optional. The NotebookExecutionJob view. Defaults to BASIC.
+    Allowed values
+      NOTEBOOK_EXECUTION_JOB_VIEW_UNSPECIFIED - When unspecified, the API defaults to the BASIC view.
+      NOTEBOOK_EXECUTION_JOB_VIEW_BASIC - Includes all fields except for direct notebook inputs.
+      NOTEBOOK_EXECUTION_JOB_VIEW_FULL - Includes all fields.
+  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 [NotebookService.CreateNotebookExecutionJob]
+  "nextPageToken": "A String", # A token to retrieve next page of results. Pass to ListNotebookExecutionJobs.page_token to obtain that page.
+  "notebookExecutionJobs": [ # List of NotebookExecutionJobs in the requested page.
+    { # NotebookExecutionJob represents an instance of a notebook execution.
+      "createTime": "A String", # Output only. Timestamp when this NotebookExecutionJob was created.
+      "dataformRepositorySource": { # The Dataform Repository containing the input notebook. # The Dataform Repository pointing to a single file notebook repository.
+        "commitSha": "A String", # The commit SHA to read repository with. If unset, the file will be read at HEAD.
+        "dataformRepositoryResourceName": "A String", # The resource name of the Dataform Repository. Format: `projects/{project_id}/locations/{location}/repositories/{repository_id}`
+      },
+      "directNotebookSource": { # The content of the input notebook in ipynb format. # The contents of an input notebook file.
+        "content": "A String", # The base64-encoded contents of the input notebook file.
+      },
+      "displayName": "A String", # The display name of the NotebookExecutionJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.
+      "executionTimeout": "A String", # Max running time of the execution job in seconds (default 86400s / 24 hrs).
+      "executionUser": "A String", # The user email to run the execution as. Only supported by Colab runtimes.
+      "gcsNotebookSource": { # The Cloud Storage uri for the input notebook. # The Cloud Storage url pointing to the ipynb file. Format: `gs://bucket/notebook_file.ipynb`
+        "generation": "A String", # The version of the Cloud Storage object to read. If unset, the current version of the object is read. See https://cloud.google.com/storage/docs/metadata#generation-number.
+        "uri": "A String", # The Cloud Storage uri pointing to the ipynb file. Format: `gs://bucket/notebook_file.ipynb`
+      },
+      "gcsOutputUri": "A String", # The Cloud Storage location to upload the result to. Format: `gs://bucket-name`
+      "jobState": "A String", # Output only. The state of the NotebookExecutionJob.
+      "labels": { # The labels with user-defined metadata to organize NotebookExecutionJobs. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.
+        "a_key": "A String",
+      },
+      "name": "A String", # Output only. The resource name of this NotebookExecutionJob. Format: `projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}`
+      "notebookRuntimeTemplateResourceName": "A String", # The NotebookRuntimeTemplate to source compute configuration from.
+      "scheduleResourceName": "A String", # Output only. The Schedule resource name if this job is triggered by one. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
+      "serviceAccount": "A String", # The service account to run the execution as.
+      "status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Populated when the NotebookExecutionJob is completed. When there is an error during notebook execution, the error details are populated.
+        "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.
+      },
+      "updateTime": "A String", # Output only. Timestamp when this NotebookExecutionJob was most recently updated.
+    },
+  ],
+}
+
+ +
+ 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/aiplatform_v1.projects.locations.persistentResources.html b/docs/dyn/aiplatform_v1.projects.locations.persistentResources.html index 3159bb89dd7..e7e0fc42d12 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.persistentResources.html +++ b/docs/dyn/aiplatform_v1.projects.locations.persistentResources.html @@ -138,6 +138,9 @@

Method Details

}, "name": "A String", # Immutable. Resource name of a PersistentResource. "network": "A String", # Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to peered with Vertex AI to host the persistent resources. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the resources aren't peered with any network. + "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I for PersistentResource. + "networkAttachment": "A String", # Optional. The full name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource. For example, `projects/12345/regions/us-central1/networkAttachments/myNA`. is of the form `projects/{project}/regions/{region}/networkAttachments/{networkAttachment}`. Where {project} is a project number, as in `12345`, and {networkAttachment} is a network attachment name. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I. + }, "reservedIpRanges": [ # Optional. A list of names for the reserved IP ranges under the VPC network that can be used for this persistent resource. If set, we will deploy the persistent resource within the provided IP ranges. Otherwise, the persistent resource is deployed to any IP ranges under the provided VPC network. Example: ['vertex-ai-ip-range']. "A String", ], @@ -171,6 +174,9 @@

Method Details

"raySpec": { # Configuration information for the Ray cluster. For experimental launch, Ray cluster creation and Persistent cluster creation are 1:1 mapping: We will provision all the nodes within the Persistent cluster as Ray nodes. # Optional. Ray cluster configuration. Required when creating a dedicated RayCluster on the PersistentResource. "headNodeResourcePoolId": "A String", # Optional. This will be used to indicate which resource pool will serve as the Ray head node(the first node within that pool). Will use the machine from the first workerpool as the head node by default if this field isn't set. "imageUri": "A String", # Optional. Default image for user to choose a preferred ML framework (for example, TensorFlow or Pytorch) by choosing from [Vertex prebuilt images](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). Either this or the resource_pool_images is required. Use this field if you need all the resource pools to have the same Ray image. Otherwise, use the {@code resource_pool_images} field. + "rayLogsSpec": { # Configuration for the Ray OSS Logs. # Optional. OSS Ray logging configurations. + "disabled": True or False, # Optional. Flag to disable the export of Ray OSS logs to Cloud Logging. + }, "rayMetricSpec": { # Configuration for the Ray metrics. # Optional. Ray metrics configurations. "disabled": True or False, # Optional. Flag to disable the Ray metrics collection. }, @@ -287,6 +293,9 @@

Method Details

}, "name": "A String", # Immutable. Resource name of a PersistentResource. "network": "A String", # Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to peered with Vertex AI to host the persistent resources. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the resources aren't peered with any network. + "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I for PersistentResource. + "networkAttachment": "A String", # Optional. The full name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource. For example, `projects/12345/regions/us-central1/networkAttachments/myNA`. is of the form `projects/{project}/regions/{region}/networkAttachments/{networkAttachment}`. Where {project} is a project number, as in `12345`, and {networkAttachment} is a network attachment name. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I. + }, "reservedIpRanges": [ # Optional. A list of names for the reserved IP ranges under the VPC network that can be used for this persistent resource. If set, we will deploy the persistent resource within the provided IP ranges. Otherwise, the persistent resource is deployed to any IP ranges under the provided VPC network. Example: ['vertex-ai-ip-range']. "A String", ], @@ -320,6 +329,9 @@

Method Details

"raySpec": { # Configuration information for the Ray cluster. For experimental launch, Ray cluster creation and Persistent cluster creation are 1:1 mapping: We will provision all the nodes within the Persistent cluster as Ray nodes. # Optional. Ray cluster configuration. Required when creating a dedicated RayCluster on the PersistentResource. "headNodeResourcePoolId": "A String", # Optional. This will be used to indicate which resource pool will serve as the Ray head node(the first node within that pool). Will use the machine from the first workerpool as the head node by default if this field isn't set. "imageUri": "A String", # Optional. Default image for user to choose a preferred ML framework (for example, TensorFlow or Pytorch) by choosing from [Vertex prebuilt images](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). Either this or the resource_pool_images is required. Use this field if you need all the resource pools to have the same Ray image. Otherwise, use the {@code resource_pool_images} field. + "rayLogsSpec": { # Configuration for the Ray OSS Logs. # Optional. OSS Ray logging configurations. + "disabled": True or False, # Optional. Flag to disable the export of Ray OSS logs to Cloud Logging. + }, "rayMetricSpec": { # Configuration for the Ray metrics. # Optional. Ray metrics configurations. "disabled": True or False, # Optional. Flag to disable the Ray metrics collection. }, @@ -377,6 +389,9 @@

Method Details

}, "name": "A String", # Immutable. Resource name of a PersistentResource. "network": "A String", # Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to peered with Vertex AI to host the persistent resources. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the resources aren't peered with any network. + "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I for PersistentResource. + "networkAttachment": "A String", # Optional. The full name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource. For example, `projects/12345/regions/us-central1/networkAttachments/myNA`. is of the form `projects/{project}/regions/{region}/networkAttachments/{networkAttachment}`. Where {project} is a project number, as in `12345`, and {networkAttachment} is a network attachment name. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I. + }, "reservedIpRanges": [ # Optional. A list of names for the reserved IP ranges under the VPC network that can be used for this persistent resource. If set, we will deploy the persistent resource within the provided IP ranges. Otherwise, the persistent resource is deployed to any IP ranges under the provided VPC network. Example: ['vertex-ai-ip-range']. "A String", ], @@ -410,6 +425,9 @@

Method Details

"raySpec": { # Configuration information for the Ray cluster. For experimental launch, Ray cluster creation and Persistent cluster creation are 1:1 mapping: We will provision all the nodes within the Persistent cluster as Ray nodes. # Optional. Ray cluster configuration. Required when creating a dedicated RayCluster on the PersistentResource. "headNodeResourcePoolId": "A String", # Optional. This will be used to indicate which resource pool will serve as the Ray head node(the first node within that pool). Will use the machine from the first workerpool as the head node by default if this field isn't set. "imageUri": "A String", # Optional. Default image for user to choose a preferred ML framework (for example, TensorFlow or Pytorch) by choosing from [Vertex prebuilt images](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). Either this or the resource_pool_images is required. Use this field if you need all the resource pools to have the same Ray image. Otherwise, use the {@code resource_pool_images} field. + "rayLogsSpec": { # Configuration for the Ray OSS Logs. # Optional. OSS Ray logging configurations. + "disabled": True or False, # Optional. Flag to disable the export of Ray OSS logs to Cloud Logging. + }, "rayMetricSpec": { # Configuration for the Ray metrics. # Optional. Ray metrics configurations. "disabled": True or False, # Optional. Flag to disable the Ray metrics collection. }, @@ -473,6 +491,9 @@

Method Details

}, "name": "A String", # Immutable. Resource name of a PersistentResource. "network": "A String", # Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to peered with Vertex AI to host the persistent resources. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the resources aren't peered with any network. + "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I for PersistentResource. + "networkAttachment": "A String", # Optional. The full name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource. For example, `projects/12345/regions/us-central1/networkAttachments/myNA`. is of the form `projects/{project}/regions/{region}/networkAttachments/{networkAttachment}`. Where {project} is a project number, as in `12345`, and {networkAttachment} is a network attachment name. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I. + }, "reservedIpRanges": [ # Optional. A list of names for the reserved IP ranges under the VPC network that can be used for this persistent resource. If set, we will deploy the persistent resource within the provided IP ranges. Otherwise, the persistent resource is deployed to any IP ranges under the provided VPC network. Example: ['vertex-ai-ip-range']. "A String", ], @@ -506,6 +527,9 @@

Method Details

"raySpec": { # Configuration information for the Ray cluster. For experimental launch, Ray cluster creation and Persistent cluster creation are 1:1 mapping: We will provision all the nodes within the Persistent cluster as Ray nodes. # Optional. Ray cluster configuration. Required when creating a dedicated RayCluster on the PersistentResource. "headNodeResourcePoolId": "A String", # Optional. This will be used to indicate which resource pool will serve as the Ray head node(the first node within that pool). Will use the machine from the first workerpool as the head node by default if this field isn't set. "imageUri": "A String", # Optional. Default image for user to choose a preferred ML framework (for example, TensorFlow or Pytorch) by choosing from [Vertex prebuilt images](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). Either this or the resource_pool_images is required. Use this field if you need all the resource pools to have the same Ray image. Otherwise, use the {@code resource_pool_images} field. + "rayLogsSpec": { # Configuration for the Ray OSS Logs. # Optional. OSS Ray logging configurations. + "disabled": True or False, # Optional. Flag to disable the export of Ray OSS logs to Cloud Logging. + }, "rayMetricSpec": { # Configuration for the Ray metrics. # Optional. Ray metrics configurations. "disabled": True or False, # Optional. Flag to disable the Ray metrics collection. }, diff --git a/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html b/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html index 7ef17416903..c249a2af3a6 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html +++ b/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html @@ -117,7 +117,7 @@

Method Details

The object takes the form of: { # Request message for ComputeTokens RPC call. - "contents": [ # Required. Input content. + "contents": [ # Optional. Input 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. "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. @@ -151,10 +151,10 @@

Method Details

"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. }, ], - "instances": [ # Required. The instances that are the input to token computing API call. Schema is identical to the prediction schema of the text model, even for the non-text models, like chat models, or Codey models. + "instances": [ # Optional. The instances that are the input to token computing API call. Schema is identical to the prediction schema of the text model, even for the non-text models, like chat models, or Codey models. "", ], - "model": "A String", # Required. The name of the publisher model requested to serve the prediction. Format: projects/{project}/locations/{location}/publishers/*/models/* + "model": "A String", # Optional. The name of the publisher model requested to serve the prediction. Format: projects/{project}/locations/{location}/publishers/*/models/* } x__xgafv: string, V1 error format. @@ -190,7 +190,7 @@

Method Details

The object takes the form of: { # Request message for PredictionService.CountTokens. - "contents": [ # Required. Input content. + "contents": [ # Optional. Input 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. "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. @@ -224,10 +224,88 @@

Method Details

"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. }, ], - "instances": [ # Required. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model. + "instances": [ # Optional. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model. "", ], - "model": "A String", # Required. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*` + "model": "A String", # Optional. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*` + "systemInstruction": { # 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. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. + "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. 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. + "a_key": "", # Properties of the object. + }, + "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + }, + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "response": { # Required. The function response in JSON object format. + "a_key": "", # Properties of the object. + }, + }, + "inlineData": { # Content blob. It's preferred to send as text directly rather than raw bytes. # Optional. Inlined bytes data. + "data": "A String", # Required. Raw bytes. + "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. + "endOffset": "A String", # Optional. The end offset of the video. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "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. + }, + "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. + { # 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. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "functionDeclarations": [ # Optional. Function tool type. 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. + { # 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, dots and dashes, with a maximum length of 64. + "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. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "default": "", # Optional. Default value of the data. + "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", + ], + "example": "", # Optional. Example of the object. Will only populated when the object is the root. + "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maxLength": "A String", # Optional. Maximum length of the Type.STRING + "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT. + "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING + "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT. + "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER + "nullable": True or False, # Optional. Indicates if the value may be null. + "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression. + "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the Schema. + "type": "A String", # Optional. The type of the data. + }, + }, + ], + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. + }, + "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. + "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported. + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/vertex-ai-search-and-conversation # Set to use data source powered by Vertex AI Search. + "datastore": "A String", # Required. Fully-qualified Vertex AI Search's datastore resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + }, + }, + }, + ], } x__xgafv: string, V1 error format. @@ -415,7 +493,7 @@

Method Details

"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. }, "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. - "disableAttribution": True or False, # Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation. + "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported. "vertexAiSearch": { # Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/vertex-ai-search-and-conversation # Set to use data source powered by Vertex AI Search. "datastore": "A String", # Required. Fully-qualified Vertex AI Search's datastore resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` }, @@ -486,21 +564,6 @@

Method Details

"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. "groundingMetadata": { # Metadata returned to client when grounding is enabled. # Output only. Metadata specifies sources used to ground generated content. - "groundingAttributions": [ # Optional. List of grounding attributions. - { # Grounding attribution. - "confidenceScore": 3.14, # Optional. Output only. Confidence score of the attribution. Ranges from 0 to 1. 1 is the most confident. - "segment": { # Segment of the content. # Output only. Segment of the content this attribution belongs to. - "endIndex": 42, # Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero. - "partIndex": 42, # Output only. The index of a Part object within its parent Content object. - "startIndex": 42, # Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero. - "text": "A String", # Output only. The text corresponding to the segment from the response. - }, - "web": { # Attribution from the web. # Optional. Attribution from the web. - "title": "A String", # Output only. Title of the attribution. - "uri": "A String", # Output only. URI reference of the attribution. - }, - }, - ], "groundingChunks": [ # List of supporting references retrieved from specified grounding source. { # Grounding chunk. "retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools. @@ -548,6 +611,7 @@

Method Details

"severityScore": 3.14, # Output only. Harm severity score. }, ], + "score": 3.14, # Output only. Confidence score of the candidate. }, ], "promptFeedback": { # Content filter results for a prompt sent in the request. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. @@ -1007,7 +1071,7 @@

Method Details

"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. }, "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. - "disableAttribution": True or False, # Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation. + "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported. "vertexAiSearch": { # Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/vertex-ai-search-and-conversation # Set to use data source powered by Vertex AI Search. "datastore": "A String", # Required. Fully-qualified Vertex AI Search's datastore resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` }, @@ -1078,21 +1142,6 @@

Method Details

"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. "groundingMetadata": { # Metadata returned to client when grounding is enabled. # Output only. Metadata specifies sources used to ground generated content. - "groundingAttributions": [ # Optional. List of grounding attributions. - { # Grounding attribution. - "confidenceScore": 3.14, # Optional. Output only. Confidence score of the attribution. Ranges from 0 to 1. 1 is the most confident. - "segment": { # Segment of the content. # Output only. Segment of the content this attribution belongs to. - "endIndex": 42, # Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero. - "partIndex": 42, # Output only. The index of a Part object within its parent Content object. - "startIndex": 42, # Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero. - "text": "A String", # Output only. The text corresponding to the segment from the response. - }, - "web": { # Attribution from the web. # Optional. Attribution from the web. - "title": "A String", # Output only. Title of the attribution. - "uri": "A String", # Output only. URI reference of the attribution. - }, - }, - ], "groundingChunks": [ # List of supporting references retrieved from specified grounding source. { # Grounding chunk. "retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools. @@ -1140,6 +1189,7 @@

Method Details

"severityScore": 3.14, # Output only. Harm severity score. }, ], + "score": 3.14, # Output only. Confidence score of the candidate. }, ], "promptFeedback": { # Content filter results for a prompt sent in the request. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. diff --git a/docs/dyn/aiplatform_v1.publishers.models.html b/docs/dyn/aiplatform_v1.publishers.models.html index f3d99435a73..6fa9fc561a1 100644 --- a/docs/dyn/aiplatform_v1.publishers.models.html +++ b/docs/dyn/aiplatform_v1.publishers.models.html @@ -78,7 +78,7 @@

Instance Methods

close()

Close httplib2 connections.

- get(name, languageCode=None, view=None, x__xgafv=None)

+ get(name, isHuggingFaceModel=None, languageCode=None, view=None, x__xgafv=None)

Gets a Model Garden publisher model.

Method Details

@@ -87,12 +87,13 @@

Method Details

- get(name, languageCode=None, view=None, x__xgafv=None) + get(name, isHuggingFaceModel=None, languageCode=None, view=None, x__xgafv=None)
Gets a Model Garden publisher model.
 
 Args:
   name: string, Required. The name of the PublisherModel resource. Format: `publishers/{publisher}/models/{publisher_model}` (required)
-  languageCode: string, Optional. The IETF BCP-47 language code representing the language in which the publisher model's text information should be written in (see go/bcp47).
+  isHuggingFaceModel: boolean, Optional. Boolean indicates whether the requested model is a Hugging Face model.
+  languageCode: string, Optional. The IETF BCP-47 language code representing the language in which the publisher model's text information should be written in.
   view: string, Optional. PublisherModel view specifying which fields to read.
     Allowed values
       PUBLISHER_MODEL_VIEW_UNSPECIFIED - The default / unset value. The API will default to the BASIC view.
diff --git a/docs/dyn/aiplatform_v1beta1.media.html b/docs/dyn/aiplatform_v1beta1.media.html
index 789f4350106..6eeaeafdb35 100644
--- a/docs/dyn/aiplatform_v1beta1.media.html
+++ b/docs/dyn/aiplatform_v1beta1.media.html
@@ -115,9 +115,42 @@ 

Method Details

}, ], }, + "jiraSource": { # The Jira source for the ImportRagFilesRequest. # The RagFile is imported from a Jira query. + "jiraQueries": [ # Required. The Jira queries. + { # JiraQueries contains the Jira queries and corresponding authentication. + "apiKeyConfig": { # The API secret. # Required. The SecretManager secret version resource name (e.g. projects/{project}/secrets/{secret}/versions/{version}) storing the Jira API key (https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/). + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + }, + "customQueries": [ # A list of custom Jira queries to import. For information about JQL (Jira Query Language), see https://support.atlassian.com/jira-service-management-cloud/docs/use-advanced-search-with-jira-query-language-jql/ + "A String", + ], + "email": "A String", # Required. The Jira email address. + "projects": [ # A list of Jira projects to import in their entirety. + "A String", + ], + "serverUri": "A String", # Required. The Jira server URI. + }, + ], + }, "name": "A String", # Output only. The resource name of the RagFile. "ragFileType": "A String", # Output only. The type of the RagFile. "sizeBytes": "A String", # Output only. The size of the RagFile in bytes. + "slackSource": { # The Slack source for the ImportRagFilesRequest. # The RagFile is imported from a Slack channel. + "channels": [ # Required. The Slack channels. + { # SlackChannels contains the Slack channels and corresponding access token. + "apiKeyConfig": { # The API secret. # Required. The SecretManager secret version resource name (e.g. projects/{project}/secrets/{secret}/versions/{version}) storing the Slack channel access token that has access to the slack channel IDs. See: https://api.slack.com/tutorials/tracks/getting-a-token. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + }, + "channels": [ # Required. The Slack channel IDs. + { # SlackChannel contains the Slack channel ID and the time range to import. + "channelId": "A String", # Required. The Slack channel ID. + "endTime": "A String", # Optional. The ending timestamp for messages to import. + "startTime": "A String", # Optional. The starting timestamp for messages to import. + }, + ], + }, + ], + }, "updateTime": "A String", # Output only. Timestamp when this RagFile was last updated. }, "uploadRagFileConfig": { # Config for uploading RagFile. # Required. The config for the RagFiles to be uploaded into the RagCorpus. VertexRagDataService.UploadRagFile. @@ -167,9 +200,42 @@

Method Details

}, ], }, + "jiraSource": { # The Jira source for the ImportRagFilesRequest. # The RagFile is imported from a Jira query. + "jiraQueries": [ # Required. The Jira queries. + { # JiraQueries contains the Jira queries and corresponding authentication. + "apiKeyConfig": { # The API secret. # Required. The SecretManager secret version resource name (e.g. projects/{project}/secrets/{secret}/versions/{version}) storing the Jira API key (https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/). + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + }, + "customQueries": [ # A list of custom Jira queries to import. For information about JQL (Jira Query Language), see https://support.atlassian.com/jira-service-management-cloud/docs/use-advanced-search-with-jira-query-language-jql/ + "A String", + ], + "email": "A String", # Required. The Jira email address. + "projects": [ # A list of Jira projects to import in their entirety. + "A String", + ], + "serverUri": "A String", # Required. The Jira server URI. + }, + ], + }, "name": "A String", # Output only. The resource name of the RagFile. "ragFileType": "A String", # Output only. The type of the RagFile. "sizeBytes": "A String", # Output only. The size of the RagFile in bytes. + "slackSource": { # The Slack source for the ImportRagFilesRequest. # The RagFile is imported from a Slack channel. + "channels": [ # Required. The Slack channels. + { # SlackChannels contains the Slack channels and corresponding access token. + "apiKeyConfig": { # The API secret. # Required. The SecretManager secret version resource name (e.g. projects/{project}/secrets/{secret}/versions/{version}) storing the Slack channel access token that has access to the slack channel IDs. See: https://api.slack.com/tutorials/tracks/getting-a-token. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + }, + "channels": [ # Required. The Slack channel IDs. + { # SlackChannel contains the Slack channel ID and the time range to import. + "channelId": "A String", # Required. The Slack channel ID. + "endTime": "A String", # Optional. The ending timestamp for messages to import. + "startTime": "A String", # Optional. The starting timestamp for messages to import. + }, + ], + }, + ], + }, "updateTime": "A String", # Output only. Timestamp when this RagFile was last updated. }, }
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html b/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html index fc9ede35864..587346eeccb 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html @@ -257,7 +257,7 @@

Method Details

"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. }, "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. - "disableAttribution": True or False, # Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation. + "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported. "vertexAiSearch": { # Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/vertex-ai-search-and-conversation # Set to use data source powered by Vertex AI Search. "datastore": "A String", # Required. Fully-qualified Vertex AI Search's datastore resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` }, @@ -438,7 +438,7 @@

Method Details

"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. }, "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. - "disableAttribution": True or False, # Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation. + "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported. "vertexAiSearch": { # Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/vertex-ai-search-and-conversation # Set to use data source powered by Vertex AI Search. "datastore": "A String", # Required. Fully-qualified Vertex AI Search's datastore resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` }, @@ -644,7 +644,7 @@

Method Details

"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. }, "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. - "disableAttribution": True or False, # Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation. + "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported. "vertexAiSearch": { # Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/vertex-ai-search-and-conversation # Set to use data source powered by Vertex AI Search. "datastore": "A String", # Required. Fully-qualified Vertex AI Search's datastore resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` }, @@ -836,7 +836,7 @@

Method Details

"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. }, "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. - "disableAttribution": True or False, # Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation. + "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported. "vertexAiSearch": { # Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/vertex-ai-search-and-conversation # Set to use data source powered by Vertex AI Search. "datastore": "A String", # Required. Fully-qualified Vertex AI Search's datastore resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` }, @@ -1036,7 +1036,7 @@

Method Details

"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. }, "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. - "disableAttribution": True or False, # Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation. + "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported. "vertexAiSearch": { # Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/vertex-ai-search-and-conversation # Set to use data source powered by Vertex AI Search. "datastore": "A String", # Required. Fully-qualified Vertex AI Search's datastore resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` }, @@ -1218,7 +1218,7 @@

Method Details

"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. }, "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. - "disableAttribution": True or False, # Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation. + "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported. "vertexAiSearch": { # Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/vertex-ai-search-and-conversation # Set to use data source powered by Vertex AI Search. "datastore": "A String", # Required. Fully-qualified Vertex AI Search's datastore resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` }, diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.customJobs.html b/docs/dyn/aiplatform_v1beta1.projects.locations.customJobs.html index 2c923abb916..1bae8f70b91 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.customJobs.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.customJobs.html @@ -175,6 +175,7 @@

Method Details

"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob. "disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false. "restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job. + "strategy": "A String", # Optional. This determines which type of scheduling strategy to use. "timeout": "A String", # The maximum job running time. The default is 7 days. }, "serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used. @@ -289,6 +290,7 @@

Method Details

"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob. "disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false. "restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job. + "strategy": "A String", # Optional. This determines which type of scheduling strategy to use. "timeout": "A String", # The maximum job running time. The default is 7 days. }, "serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used. @@ -445,6 +447,7 @@

Method Details

"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob. "disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false. "restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job. + "strategy": "A String", # Optional. This determines which type of scheduling strategy to use. "timeout": "A String", # The maximum job running time. The default is 7 days. }, "serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used. @@ -572,6 +575,7 @@

Method Details

"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob. "disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false. "restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job. + "strategy": "A String", # Optional. This determines which type of scheduling strategy to use. "timeout": "A String", # The maximum job running time. The default is 7 days. }, "serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.datasetVersions.html b/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.datasetVersions.html index 254b37f6acf..a2257cdcb87 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.datasetVersions.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.datasetVersions.html @@ -120,7 +120,7 @@

Method Details

"etag": "A String", # Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. "metadata": "", # Required. Output only. Additional information about the DatasetVersion. "modelReference": "A String", # Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions. - "name": "A String", # Output only. The resource name of the DatasetVersion. + "name": "A String", # Output only. Identifier. The resource name of the DatasetVersion. "updateTime": "A String", # Output only. Timestamp when this DatasetVersion was last updated. } @@ -210,7 +210,7 @@

Method Details

"etag": "A String", # Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. "metadata": "", # Required. Output only. Additional information about the DatasetVersion. "modelReference": "A String", # Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions. - "name": "A String", # Output only. The resource name of the DatasetVersion. + "name": "A String", # Output only. Identifier. The resource name of the DatasetVersion. "updateTime": "A String", # Output only. Timestamp when this DatasetVersion was last updated. }
@@ -243,7 +243,7 @@

Method Details

"etag": "A String", # Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. "metadata": "", # Required. Output only. Additional information about the DatasetVersion. "modelReference": "A String", # Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions. - "name": "A String", # Output only. The resource name of the DatasetVersion. + "name": "A String", # Output only. Identifier. The resource name of the DatasetVersion. "updateTime": "A String", # Output only. Timestamp when this DatasetVersion was last updated. }, ], @@ -270,7 +270,7 @@

Method Details

Updates a DatasetVersion.
 
 Args:
-  name: string, Output only. The resource name of the DatasetVersion. (required)
+  name: string, Output only. Identifier. The resource name of the DatasetVersion. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -281,7 +281,7 @@ 

Method Details

"etag": "A String", # Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. "metadata": "", # Required. Output only. Additional information about the DatasetVersion. "modelReference": "A String", # Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions. - "name": "A String", # Output only. The resource name of the DatasetVersion. + "name": "A String", # Output only. Identifier. The resource name of the DatasetVersion. "updateTime": "A String", # Output only. Timestamp when this DatasetVersion was last updated. } @@ -301,7 +301,7 @@

Method Details

"etag": "A String", # Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. "metadata": "", # Required. Output only. Additional information about the DatasetVersion. "modelReference": "A String", # Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions. - "name": "A String", # Output only. The resource name of the DatasetVersion. + "name": "A String", # Output only. Identifier. The resource name of the DatasetVersion. "updateTime": "A String", # Output only. Timestamp when this DatasetVersion was last updated. }
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html b/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html index 9f4aba83646..d4c893e3801 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html @@ -163,7 +163,7 @@

Method Details

"metadataArtifact": "A String", # Output only. The resource name of the Artifact that was created in MetadataStore when creating the Dataset. The Artifact resource name pattern is `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`. "metadataSchemaUri": "A String", # Required. Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/. "modelReference": "A String", # Optional. Reference to the public base model last used by the dataset. Only set for prompt datasets. - "name": "A String", # Output only. The resource name of the Dataset. + "name": "A String", # Output only. Identifier. The resource name of the Dataset. "savedQueries": [ # All SavedQueries belong to the Dataset will be returned in List/Get Dataset response. The annotation_specs field will not be populated except for UI cases which will only use annotation_spec_count. In CreateDataset request, a SavedQuery is created together if this field is set, up to one SavedQuery can be set in CreateDatasetRequest. The SavedQuery should not contain any AnnotationSpec. { # A SavedQuery is a view of the dataset. It references a subset of annotations by problem type and filters. "annotationFilter": "A String", # Output only. Filters on the Annotations in the dataset. @@ -328,7 +328,7 @@

Method Details

"metadataArtifact": "A String", # Output only. The resource name of the Artifact that was created in MetadataStore when creating the Dataset. The Artifact resource name pattern is `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`. "metadataSchemaUri": "A String", # Required. Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/. "modelReference": "A String", # Optional. Reference to the public base model last used by the dataset. Only set for prompt datasets. - "name": "A String", # Output only. The resource name of the Dataset. + "name": "A String", # Output only. Identifier. The resource name of the Dataset. "savedQueries": [ # All SavedQueries belong to the Dataset will be returned in List/Get Dataset response. The annotation_specs field will not be populated except for UI cases which will only use annotation_spec_count. In CreateDataset request, a SavedQuery is created together if this field is set, up to one SavedQuery can be set in CreateDatasetRequest. The SavedQuery should not contain any AnnotationSpec. { # A SavedQuery is a view of the dataset. It references a subset of annotations by problem type and filters. "annotationFilter": "A String", # Output only. Filters on the Annotations in the dataset. @@ -441,7 +441,7 @@

Method Details

"metadataArtifact": "A String", # Output only. The resource name of the Artifact that was created in MetadataStore when creating the Dataset. The Artifact resource name pattern is `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`. "metadataSchemaUri": "A String", # Required. Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/. "modelReference": "A String", # Optional. Reference to the public base model last used by the dataset. Only set for prompt datasets. - "name": "A String", # Output only. The resource name of the Dataset. + "name": "A String", # Output only. Identifier. The resource name of the Dataset. "savedQueries": [ # All SavedQueries belong to the Dataset will be returned in List/Get Dataset response. The annotation_specs field will not be populated except for UI cases which will only use annotation_spec_count. In CreateDataset request, a SavedQuery is created together if this field is set, up to one SavedQuery can be set in CreateDatasetRequest. The SavedQuery should not contain any AnnotationSpec. { # A SavedQuery is a view of the dataset. It references a subset of annotations by problem type and filters. "annotationFilter": "A String", # Output only. Filters on the Annotations in the dataset. @@ -482,7 +482,7 @@

Method Details

Updates a Dataset.
 
 Args:
-  name: string, Output only. The resource name of the Dataset. (required)
+  name: string, Output only. Identifier. The resource name of the Dataset. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -502,7 +502,7 @@ 

Method Details

"metadataArtifact": "A String", # Output only. The resource name of the Artifact that was created in MetadataStore when creating the Dataset. The Artifact resource name pattern is `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`. "metadataSchemaUri": "A String", # Required. Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/. "modelReference": "A String", # Optional. Reference to the public base model last used by the dataset. Only set for prompt datasets. - "name": "A String", # Output only. The resource name of the Dataset. + "name": "A String", # Output only. Identifier. The resource name of the Dataset. "savedQueries": [ # All SavedQueries belong to the Dataset will be returned in List/Get Dataset response. The annotation_specs field will not be populated except for UI cases which will only use annotation_spec_count. In CreateDataset request, a SavedQuery is created together if this field is set, up to one SavedQuery can be set in CreateDatasetRequest. The SavedQuery should not contain any AnnotationSpec. { # A SavedQuery is a view of the dataset. It references a subset of annotations by problem type and filters. "annotationFilter": "A String", # Output only. Filters on the Annotations in the dataset. @@ -545,7 +545,7 @@

Method Details

"metadataArtifact": "A String", # Output only. The resource name of the Artifact that was created in MetadataStore when creating the Dataset. The Artifact resource name pattern is `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`. "metadataSchemaUri": "A String", # Required. Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/. "modelReference": "A String", # Optional. Reference to the public base model last used by the dataset. Only set for prompt datasets. - "name": "A String", # Output only. The resource name of the Dataset. + "name": "A String", # Output only. Identifier. The resource name of the Dataset. "savedQueries": [ # All SavedQueries belong to the Dataset will be returned in List/Get Dataset response. The annotation_specs field will not be populated except for UI cases which will only use annotation_spec_count. In CreateDataset request, a SavedQuery is created together if this field is set, up to one SavedQuery can be set in CreateDatasetRequest. The SavedQuery should not contain any AnnotationSpec. { # A SavedQuery is a view of the dataset. It references a subset of annotations by problem type and filters. "annotationFilter": "A String", # Output only. Filters on the Annotations in the dataset. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html index 8f82d31a3db..9264e906835 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html @@ -172,7 +172,7 @@

Method Details

The object takes the form of: { # Request message for ComputeTokens RPC call. - "contents": [ # Required. Input content. + "contents": [ # Optional. Input 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. "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. @@ -206,10 +206,10 @@

Method Details

"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. }, ], - "instances": [ # Required. The instances that are the input to token computing API call. Schema is identical to the prediction schema of the text model, even for the non-text models, like chat models, or Codey models. + "instances": [ # Optional. The instances that are the input to token computing API call. Schema is identical to the prediction schema of the text model, even for the non-text models, like chat models, or Codey models. "", ], - "model": "A String", # Required. The name of the publisher model requested to serve the prediction. Format: projects/{project}/locations/{location}/publishers/*/models/* + "model": "A String", # Optional. The name of the publisher model requested to serve the prediction. Format: projects/{project}/locations/{location}/publishers/*/models/* } x__xgafv: string, V1 error format. @@ -245,7 +245,7 @@

Method Details

The object takes the form of: { # Request message for PredictionService.CountTokens. - "contents": [ # Required. Input content. + "contents": [ # Optional. Input 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. "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. @@ -279,10 +279,131 @@

Method Details

"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. }, ], - "instances": [ # Required. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model. + "instances": [ # Optional. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model. "", ], - "model": "A String", # Required. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*` + "model": "A String", # Optional. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*` + "systemInstruction": { # 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. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. + "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. 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. + "a_key": "", # Properties of the object. + }, + "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + }, + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "response": { # Required. The function response in JSON object format. + "a_key": "", # Properties of the object. + }, + }, + "inlineData": { # Content blob. It's preferred to send as text directly rather than raw bytes. # Optional. Inlined bytes data. + "data": "A String", # Required. Raw bytes. + "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. + "endOffset": "A String", # Optional. The end offset of the video. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "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. + }, + "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. + { # 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. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "functionDeclarations": [ # Optional. Function tool type. 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. + { # 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, dots and dashes, with a maximum length of 64. + "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. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "default": "", # Optional. Default value of the data. + "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", + ], + "example": "", # Optional. Example of the object. Will only populated when the object is the root. + "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maxLength": "A String", # Optional. Maximum length of the Type.STRING + "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT. + "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING + "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT. + "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER + "nullable": True or False, # Optional. Indicates if the value may be null. + "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression. + "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the Schema. + "type": "A String", # Optional. The type of the data. + }, + "response": { # 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 output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "default": "", # Optional. Default value of the data. + "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", + ], + "example": "", # Optional. Example of the object. Will only populated when the object is the root. + "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maxLength": "A String", # Optional. Maximum length of the Type.STRING + "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT. + "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING + "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT. + "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER + "nullable": True or False, # Optional. Indicates if the value may be null. + "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression. + "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the Schema. + "type": "A String", # Optional. The type of the data. + }, + }, + ], + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. + }, + "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. + "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported. + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/vertex-ai-search-and-conversation # Set to use data source powered by Vertex AI Search. + "datastore": "A String", # Required. Fully-qualified Vertex AI Search's datastore resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead. + "A String", + ], + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + }, + ], } x__xgafv: string, V1 error format. @@ -310,6 +431,8 @@

Method Details

{ # Models are deployed into it, and afterwards Endpoint is called to obtain predictions and explanations. "createTime": "A String", # Output only. Timestamp when this Endpoint was created. + "dedicatedEndpointDns": "A String", # Output only. DNS of the dedicated endpoint. Will only be populated if dedicated_endpoint_enabled is true. Format: `https://{endpoint_id}.{region}-{project_number}.prediction.vertexai.goog`. + "dedicatedEndpointEnabled": True or False, # If true, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitation will be removed soon. "deployedModels": [ # Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively. { # A deployment of a Model. Endpoints contain one or more DeployedModels. "automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. @@ -1443,7 +1566,7 @@

Method Details

"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. }, "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. - "disableAttribution": True or False, # Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation. + "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported. "vertexAiSearch": { # Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/vertex-ai-search-and-conversation # Set to use data source powered by Vertex AI Search. "datastore": "A String", # Required. Fully-qualified Vertex AI Search's datastore resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` }, @@ -1529,25 +1652,6 @@

Method Details

"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. "groundingMetadata": { # Metadata returned to client when grounding is enabled. # Output only. Metadata specifies sources used to ground generated content. - "groundingAttributions": [ # Optional. List of grounding attributions. - { # Grounding attribution. - "confidenceScore": 3.14, # Optional. Output only. Confidence score of the attribution. Ranges from 0 to 1. 1 is the most confident. - "retrievedContext": { # Attribution from context retrieved by the retrieval tools. # Optional. Attribution from context retrieved by the retrieval tools. - "title": "A String", # Output only. Title of the attribution. - "uri": "A String", # Output only. URI reference of the attribution. - }, - "segment": { # Segment of the content. # Output only. Segment of the content this attribution belongs to. - "endIndex": 42, # Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero. - "partIndex": 42, # Output only. The index of a Part object within its parent Content object. - "startIndex": 42, # Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero. - "text": "A String", # Output only. The text corresponding to the segment from the response. - }, - "web": { # Attribution from the web. # Optional. Attribution from the web. - "title": "A String", # Output only. Title of the attribution. - "uri": "A String", # Output only. URI reference of the attribution. - }, - }, - ], "groundingChunks": [ # List of supporting references retrieved from specified grounding source. { # Grounding chunk. "retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools. @@ -1598,6 +1702,7 @@

Method Details

"severityScore": 3.14, # Output only. Harm severity score. }, ], + "score": 3.14, # Output only. Confidence score of the candidate. }, ], "promptFeedback": { # Content filter results for a prompt sent in the request. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. @@ -1638,6 +1743,8 @@

Method Details

{ # Models are deployed into it, and afterwards Endpoint is called to obtain predictions and explanations. "createTime": "A String", # Output only. Timestamp when this Endpoint was created. + "dedicatedEndpointDns": "A String", # Output only. DNS of the dedicated endpoint. Will only be populated if dedicated_endpoint_enabled is true. Format: `https://{endpoint_id}.{region}-{project_number}.prediction.vertexai.goog`. + "dedicatedEndpointEnabled": True or False, # If true, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitation will be removed soon. "deployedModels": [ # Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively. { # A deployment of a Model. Endpoints contain one or more DeployedModels. "automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. @@ -1881,6 +1988,8 @@

Method Details

"endpoints": [ # List of Endpoints in the requested page. { # Models are deployed into it, and afterwards Endpoint is called to obtain predictions and explanations. "createTime": "A String", # Output only. Timestamp when this Endpoint was created. + "dedicatedEndpointDns": "A String", # Output only. DNS of the dedicated endpoint. Will only be populated if dedicated_endpoint_enabled is true. Format: `https://{endpoint_id}.{region}-{project_number}.prediction.vertexai.goog`. + "dedicatedEndpointEnabled": True or False, # If true, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitation will be removed soon. "deployedModels": [ # Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively. { # A deployment of a Model. Endpoints contain one or more DeployedModels. "automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. @@ -2288,6 +2397,8 @@

Method Details

{ # Models are deployed into it, and afterwards Endpoint is called to obtain predictions and explanations. "createTime": "A String", # Output only. Timestamp when this Endpoint was created. + "dedicatedEndpointDns": "A String", # Output only. DNS of the dedicated endpoint. Will only be populated if dedicated_endpoint_enabled is true. Format: `https://{endpoint_id}.{region}-{project_number}.prediction.vertexai.goog`. + "dedicatedEndpointEnabled": True or False, # If true, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitation will be removed soon. "deployedModels": [ # Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively. { # A deployment of a Model. Endpoints contain one or more DeployedModels. "automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. @@ -2484,6 +2595,8 @@

Method Details

{ # Models are deployed into it, and afterwards Endpoint is called to obtain predictions and explanations. "createTime": "A String", # Output only. Timestamp when this Endpoint was created. + "dedicatedEndpointDns": "A String", # Output only. DNS of the dedicated endpoint. Will only be populated if dedicated_endpoint_enabled is true. Format: `https://{endpoint_id}.{region}-{project_number}.prediction.vertexai.goog`. + "dedicatedEndpointEnabled": True or False, # If true, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitation will be removed soon. "deployedModels": [ # Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively. { # A deployment of a Model. Endpoints contain one or more DeployedModels. "automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. @@ -3192,7 +3305,7 @@

Method Details

"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. }, "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. - "disableAttribution": True or False, # Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation. + "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported. "vertexAiSearch": { # Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/vertex-ai-search-and-conversation # Set to use data source powered by Vertex AI Search. "datastore": "A String", # Required. Fully-qualified Vertex AI Search's datastore resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` }, @@ -3278,25 +3391,6 @@

Method Details

"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. "groundingMetadata": { # Metadata returned to client when grounding is enabled. # Output only. Metadata specifies sources used to ground generated content. - "groundingAttributions": [ # Optional. List of grounding attributions. - { # Grounding attribution. - "confidenceScore": 3.14, # Optional. Output only. Confidence score of the attribution. Ranges from 0 to 1. 1 is the most confident. - "retrievedContext": { # Attribution from context retrieved by the retrieval tools. # Optional. Attribution from context retrieved by the retrieval tools. - "title": "A String", # Output only. Title of the attribution. - "uri": "A String", # Output only. URI reference of the attribution. - }, - "segment": { # Segment of the content. # Output only. Segment of the content this attribution belongs to. - "endIndex": 42, # Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero. - "partIndex": 42, # Output only. The index of a Part object within its parent Content object. - "startIndex": 42, # Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero. - "text": "A String", # Output only. The text corresponding to the segment from the response. - }, - "web": { # Attribution from the web. # Optional. Attribution from the web. - "title": "A String", # Output only. Title of the attribution. - "uri": "A String", # Output only. URI reference of the attribution. - }, - }, - ], "groundingChunks": [ # List of supporting references retrieved from specified grounding source. { # Grounding chunk. "retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools. @@ -3347,6 +3441,7 @@

Method Details

"severityScore": 3.14, # Output only. Harm severity score. }, ], + "score": 3.14, # Output only. Confidence score of the candidate. }, ], "promptFeedback": { # Content filter results for a prompt sent in the request. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.featureOnlineStores.featureViews.html b/docs/dyn/aiplatform_v1beta1.projects.locations.featureOnlineStores.featureViews.html index 6bdbea60ea3..f65bfb6047b 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.featureOnlineStores.featureViews.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.featureOnlineStores.featureViews.html @@ -683,6 +683,15 @@

Method Details

}, "entityId": "A String", # Optional. The entity id whose similar entities should be searched for. If embedding is set, search will use embedding instead of entity_id. "neighborCount": 42, # Optional. The number of similar entities to be retrieved from feature view for each query. + "numericFilters": [ # Optional. The list of numeric filters. + { # Numeric filter is used to search a subset of the entities by using boolean rules on numeric columns. For example: Database Point 0: {name: “a” value_int: 42} {name: “b” value_float: 1.0} Database Point 1: {name: “a” value_int: 10} {name: “b” value_float: 2.0} Database Point 2: {name: “a” value_int: -1} {name: “b” value_float: 3.0} Query: {name: “a” value_int: 12 operator: LESS} // Matches Point 1, 2 {name: “b” value_float: 2.0 operator: EQUAL} // Matches Point 1 + "name": "A String", # Required. Column name in BigQuery that used as filters. + "op": "A String", # Optional. This MUST be specified for queries and must NOT be specified for database points. + "valueDouble": 3.14, # double value type. + "valueFloat": 3.14, # float value type. + "valueInt": "A String", # int value type. + }, + ], "parameters": { # Parameters that can be overrided in each query to tune query latency and recall. # Optional. Parameters that can be set to tune query on the fly. "approximateNeighborCandidates": 42, # Optional. The number of neighbors to find via approximate search before exact reordering is performed; if set, this value must be > neighbor_count. "leafNodesSearchFraction": 3.14, # Optional. The fraction of the number of leaves to search, set at query time allows user to tune search performance. This value increase result in both search accuracy and latency increase. The value should be between 0.0 and 1.0. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.hyperparameterTuningJobs.html b/docs/dyn/aiplatform_v1beta1.projects.locations.hyperparameterTuningJobs.html index 2d9ce0d3080..d1c0026b8bd 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.hyperparameterTuningJobs.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.hyperparameterTuningJobs.html @@ -289,6 +289,7 @@

Method Details

"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob. "disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false. "restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job. + "strategy": "A String", # Optional. This determines which type of scheduling strategy to use. "timeout": "A String", # The maximum job running time. The default is 7 days. }, "serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used. @@ -551,6 +552,7 @@

Method Details

"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob. "disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false. "restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job. + "strategy": "A String", # Optional. This determines which type of scheduling strategy to use. "timeout": "A String", # The maximum job running time. The default is 7 days. }, "serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used. @@ -855,6 +857,7 @@

Method Details

"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob. "disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false. "restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job. + "strategy": "A String", # Optional. This determines which type of scheduling strategy to use. "timeout": "A String", # The maximum job running time. The default is 7 days. }, "serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used. @@ -1130,6 +1133,7 @@

Method Details

"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob. "disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false. "restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job. + "strategy": "A String", # Optional. This determines which type of scheduling strategy to use. "timeout": "A String", # The maximum job running time. The default is 7 days. }, "serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.modelMonitors.html b/docs/dyn/aiplatform_v1beta1.projects.locations.modelMonitors.html index c8be57a2d1b..464be714079 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.modelMonitors.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.modelMonitors.html @@ -296,6 +296,8 @@

Method Details

"outputUriPrefix": "A String", # Required. Google Cloud Storage URI to output directory. If the uri doesn't end with '/', a '/' will be automatically appended. The directory is created if it doesn't exist. }, }, + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "tabularObjective": { # Tabular monitoring objective. # Optional default tabular model monitoring objective. "featureAttributionSpec": { # Feature attribution monitoring spec. # Feature attribution monitoring spec. "batchExplanationDedicatedResources": { # A description of resources that are used for performing batch operations, are dedicated to a Model, and need manual configuration. # The config of resources used by the Model Monitoring during the batch explanation for non-AutoML models. If not set, `n1-standard-2` machine type will be used by default. @@ -634,6 +636,8 @@

Method Details

"outputUriPrefix": "A String", # Required. Google Cloud Storage URI to output directory. If the uri doesn't end with '/', a '/' will be automatically appended. The directory is created if it doesn't exist. }, }, + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "tabularObjective": { # Tabular monitoring objective. # Optional default tabular model monitoring objective. "featureAttributionSpec": { # Feature attribution monitoring spec. # Feature attribution monitoring spec. "batchExplanationDedicatedResources": { # A description of resources that are used for performing batch operations, are dedicated to a Model, and need manual configuration. # The config of resources used by the Model Monitoring during the batch explanation for non-AutoML models. If not set, `n1-standard-2` machine type will be used by default. @@ -913,6 +917,8 @@

Method Details

"outputUriPrefix": "A String", # Required. Google Cloud Storage URI to output directory. If the uri doesn't end with '/', a '/' will be automatically appended. The directory is created if it doesn't exist. }, }, + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "tabularObjective": { # Tabular monitoring objective. # Optional default tabular model monitoring objective. "featureAttributionSpec": { # Feature attribution monitoring spec. # Feature attribution monitoring spec. "batchExplanationDedicatedResources": { # A description of resources that are used for performing batch operations, are dedicated to a Model, and need manual configuration. # The config of resources used by the Model Monitoring during the batch explanation for non-AutoML models. If not set, `n1-standard-2` machine type will be used by default. @@ -1198,6 +1204,8 @@

Method Details

"outputUriPrefix": "A String", # Required. Google Cloud Storage URI to output directory. If the uri doesn't end with '/', a '/' will be automatically appended. The directory is created if it doesn't exist. }, }, + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "tabularObjective": { # Tabular monitoring objective. # Optional default tabular model monitoring objective. "featureAttributionSpec": { # Feature attribution monitoring spec. # Feature attribution monitoring spec. "batchExplanationDedicatedResources": { # A description of resources that are used for performing batch operations, are dedicated to a Model, and need manual configuration. # The config of resources used by the Model Monitoring during the batch explanation for non-AutoML models. If not set, `n1-standard-2` machine type will be used by default. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.nasJobs.html b/docs/dyn/aiplatform_v1beta1.projects.locations.nasJobs.html index f39f32c153c..45ec1d19b02 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.nasJobs.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.nasJobs.html @@ -231,6 +231,7 @@

Method Details

"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob. "disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false. "restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job. + "strategy": "A String", # Optional. This determines which type of scheduling strategy to use. "timeout": "A String", # The maximum job running time. The default is 7 days. }, "serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used. @@ -313,6 +314,7 @@

Method Details

"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob. "disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false. "restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job. + "strategy": "A String", # Optional. This determines which type of scheduling strategy to use. "timeout": "A String", # The maximum job running time. The default is 7 days. }, "serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used. @@ -481,6 +483,7 @@

Method Details

"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob. "disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false. "restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job. + "strategy": "A String", # Optional. This determines which type of scheduling strategy to use. "timeout": "A String", # The maximum job running time. The default is 7 days. }, "serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used. @@ -563,6 +566,7 @@

Method Details

"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob. "disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false. "restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job. + "strategy": "A String", # Optional. This determines which type of scheduling strategy to use. "timeout": "A String", # The maximum job running time. The default is 7 days. }, "serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used. @@ -773,6 +777,7 @@

Method Details

"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob. "disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false. "restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job. + "strategy": "A String", # Optional. This determines which type of scheduling strategy to use. "timeout": "A String", # The maximum job running time. The default is 7 days. }, "serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used. @@ -855,6 +860,7 @@

Method Details

"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob. "disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false. "restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job. + "strategy": "A String", # Optional. This determines which type of scheduling strategy to use. "timeout": "A String", # The maximum job running time. The default is 7 days. }, "serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used. @@ -1036,6 +1042,7 @@

Method Details

"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob. "disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false. "restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job. + "strategy": "A String", # Optional. This determines which type of scheduling strategy to use. "timeout": "A String", # The maximum job running time. The default is 7 days. }, "serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used. @@ -1118,6 +1125,7 @@

Method Details

"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob. "disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false. "restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job. + "strategy": "A String", # Optional. This determines which type of scheduling strategy to use. "timeout": "A String", # The maximum job running time. The default is 7 days. }, "serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.persistentResources.html b/docs/dyn/aiplatform_v1beta1.projects.locations.persistentResources.html index 395f3abe671..576dbd4d5e0 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.persistentResources.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.persistentResources.html @@ -138,6 +138,9 @@

Method Details

}, "name": "A String", # Immutable. Resource name of a PersistentResource. "network": "A String", # Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to peered with Vertex AI to host the persistent resources. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the resources aren't peered with any network. + "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I for PersistentResource. + "networkAttachment": "A String", # Optional. The full name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource. For example, `projects/12345/regions/us-central1/networkAttachments/myNA`. is of the form `projects/{project}/regions/{region}/networkAttachments/{networkAttachment}`. Where {project} is a project number, as in `12345`, and {networkAttachment} is a network attachment name. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I. + }, "reservedIpRanges": [ # Optional. A list of names for the reserved IP ranges under the VPC network that can be used for this persistent resource. If set, we will deploy the persistent resource within the provided IP ranges. Otherwise, the persistent resource is deployed to any IP ranges under the provided VPC network. Example: ['vertex-ai-ip-range']. "A String", ], @@ -172,6 +175,9 @@

Method Details

"raySpec": { # Configuration information for the Ray cluster. For experimental launch, Ray cluster creation and Persistent cluster creation are 1:1 mapping: We will provision all the nodes within the Persistent cluster as Ray nodes. # Optional. Ray cluster configuration. Required when creating a dedicated RayCluster on the PersistentResource. "headNodeResourcePoolId": "A String", # Optional. This will be used to indicate which resource pool will serve as the Ray head node(the first node within that pool). Will use the machine from the first workerpool as the head node by default if this field isn't set. "imageUri": "A String", # Optional. Default image for user to choose a preferred ML framework (for example, TensorFlow or Pytorch) by choosing from [Vertex prebuilt images](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). Either this or the resource_pool_images is required. Use this field if you need all the resource pools to have the same Ray image. Otherwise, use the {@code resource_pool_images} field. + "rayLogsSpec": { # Configuration for the Ray OSS Logs. # Optional. OSS Ray logging configurations. + "disabled": True or False, # Optional. Flag to disable the export of Ray OSS logs to Cloud Logging. + }, "rayMetricSpec": { # Configuration for the Ray metrics. # Optional. Ray metrics configurations. "disabled": True or False, # Optional. Flag to disable the Ray metrics collection. }, @@ -288,6 +294,9 @@

Method Details

}, "name": "A String", # Immutable. Resource name of a PersistentResource. "network": "A String", # Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to peered with Vertex AI to host the persistent resources. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the resources aren't peered with any network. + "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I for PersistentResource. + "networkAttachment": "A String", # Optional. The full name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource. For example, `projects/12345/regions/us-central1/networkAttachments/myNA`. is of the form `projects/{project}/regions/{region}/networkAttachments/{networkAttachment}`. Where {project} is a project number, as in `12345`, and {networkAttachment} is a network attachment name. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I. + }, "reservedIpRanges": [ # Optional. A list of names for the reserved IP ranges under the VPC network that can be used for this persistent resource. If set, we will deploy the persistent resource within the provided IP ranges. Otherwise, the persistent resource is deployed to any IP ranges under the provided VPC network. Example: ['vertex-ai-ip-range']. "A String", ], @@ -322,6 +331,9 @@

Method Details

"raySpec": { # Configuration information for the Ray cluster. For experimental launch, Ray cluster creation and Persistent cluster creation are 1:1 mapping: We will provision all the nodes within the Persistent cluster as Ray nodes. # Optional. Ray cluster configuration. Required when creating a dedicated RayCluster on the PersistentResource. "headNodeResourcePoolId": "A String", # Optional. This will be used to indicate which resource pool will serve as the Ray head node(the first node within that pool). Will use the machine from the first workerpool as the head node by default if this field isn't set. "imageUri": "A String", # Optional. Default image for user to choose a preferred ML framework (for example, TensorFlow or Pytorch) by choosing from [Vertex prebuilt images](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). Either this or the resource_pool_images is required. Use this field if you need all the resource pools to have the same Ray image. Otherwise, use the {@code resource_pool_images} field. + "rayLogsSpec": { # Configuration for the Ray OSS Logs. # Optional. OSS Ray logging configurations. + "disabled": True or False, # Optional. Flag to disable the export of Ray OSS logs to Cloud Logging. + }, "rayMetricSpec": { # Configuration for the Ray metrics. # Optional. Ray metrics configurations. "disabled": True or False, # Optional. Flag to disable the Ray metrics collection. }, @@ -379,6 +391,9 @@

Method Details

}, "name": "A String", # Immutable. Resource name of a PersistentResource. "network": "A String", # Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to peered with Vertex AI to host the persistent resources. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the resources aren't peered with any network. + "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I for PersistentResource. + "networkAttachment": "A String", # Optional. The full name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource. For example, `projects/12345/regions/us-central1/networkAttachments/myNA`. is of the form `projects/{project}/regions/{region}/networkAttachments/{networkAttachment}`. Where {project} is a project number, as in `12345`, and {networkAttachment} is a network attachment name. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I. + }, "reservedIpRanges": [ # Optional. A list of names for the reserved IP ranges under the VPC network that can be used for this persistent resource. If set, we will deploy the persistent resource within the provided IP ranges. Otherwise, the persistent resource is deployed to any IP ranges under the provided VPC network. Example: ['vertex-ai-ip-range']. "A String", ], @@ -413,6 +428,9 @@

Method Details

"raySpec": { # Configuration information for the Ray cluster. For experimental launch, Ray cluster creation and Persistent cluster creation are 1:1 mapping: We will provision all the nodes within the Persistent cluster as Ray nodes. # Optional. Ray cluster configuration. Required when creating a dedicated RayCluster on the PersistentResource. "headNodeResourcePoolId": "A String", # Optional. This will be used to indicate which resource pool will serve as the Ray head node(the first node within that pool). Will use the machine from the first workerpool as the head node by default if this field isn't set. "imageUri": "A String", # Optional. Default image for user to choose a preferred ML framework (for example, TensorFlow or Pytorch) by choosing from [Vertex prebuilt images](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). Either this or the resource_pool_images is required. Use this field if you need all the resource pools to have the same Ray image. Otherwise, use the {@code resource_pool_images} field. + "rayLogsSpec": { # Configuration for the Ray OSS Logs. # Optional. OSS Ray logging configurations. + "disabled": True or False, # Optional. Flag to disable the export of Ray OSS logs to Cloud Logging. + }, "rayMetricSpec": { # Configuration for the Ray metrics. # Optional. Ray metrics configurations. "disabled": True or False, # Optional. Flag to disable the Ray metrics collection. }, @@ -476,6 +494,9 @@

Method Details

}, "name": "A String", # Immutable. Resource name of a PersistentResource. "network": "A String", # Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to peered with Vertex AI to host the persistent resources. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the resources aren't peered with any network. + "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I for PersistentResource. + "networkAttachment": "A String", # Optional. The full name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource. For example, `projects/12345/regions/us-central1/networkAttachments/myNA`. is of the form `projects/{project}/regions/{region}/networkAttachments/{networkAttachment}`. Where {project} is a project number, as in `12345`, and {networkAttachment} is a network attachment name. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I. + }, "reservedIpRanges": [ # Optional. A list of names for the reserved IP ranges under the VPC network that can be used for this persistent resource. If set, we will deploy the persistent resource within the provided IP ranges. Otherwise, the persistent resource is deployed to any IP ranges under the provided VPC network. Example: ['vertex-ai-ip-range']. "A String", ], @@ -510,6 +531,9 @@

Method Details

"raySpec": { # Configuration information for the Ray cluster. For experimental launch, Ray cluster creation and Persistent cluster creation are 1:1 mapping: We will provision all the nodes within the Persistent cluster as Ray nodes. # Optional. Ray cluster configuration. Required when creating a dedicated RayCluster on the PersistentResource. "headNodeResourcePoolId": "A String", # Optional. This will be used to indicate which resource pool will serve as the Ray head node(the first node within that pool). Will use the machine from the first workerpool as the head node by default if this field isn't set. "imageUri": "A String", # Optional. Default image for user to choose a preferred ML framework (for example, TensorFlow or Pytorch) by choosing from [Vertex prebuilt images](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). Either this or the resource_pool_images is required. Use this field if you need all the resource pools to have the same Ray image. Otherwise, use the {@code resource_pool_images} field. + "rayLogsSpec": { # Configuration for the Ray OSS Logs. # Optional. OSS Ray logging configurations. + "disabled": True or False, # Optional. Flag to disable the export of Ray OSS logs to Cloud Logging. + }, "rayMetricSpec": { # Configuration for the Ray metrics. # Optional. Ray metrics configurations. "disabled": True or False, # Optional. Flag to disable the Ray metrics collection. }, diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.pipelineJobs.html b/docs/dyn/aiplatform_v1beta1.projects.locations.pipelineJobs.html index 44dc124addf..c16eeb2c6c1 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.pipelineJobs.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.pipelineJobs.html @@ -438,6 +438,8 @@

Method Details

}, }, }, + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "scheduleName": "A String", # Output only. The schedule resource name. Only returned if the Pipeline is created by Schedule API. "serviceAccount": "A String", # The service account that the pipeline workload runs as. If not specified, the Compute Engine default service account in the project will be used. See https://cloud.google.com/compute/docs/access/service-accounts#default_service_account Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account. "startTime": "A String", # Output only. Pipeline start time. @@ -663,6 +665,8 @@

Method Details

}, }, }, + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "scheduleName": "A String", # Output only. The schedule resource name. Only returned if the Pipeline is created by Schedule API. "serviceAccount": "A String", # The service account that the pipeline workload runs as. If not specified, the Compute Engine default service account in the project will be used. See https://cloud.google.com/compute/docs/access/service-accounts#default_service_account Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account. "startTime": "A String", # Output only. Pipeline start time. @@ -929,6 +933,8 @@

Method Details

}, }, }, + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "scheduleName": "A String", # Output only. The schedule resource name. Only returned if the Pipeline is created by Schedule API. "serviceAccount": "A String", # The service account that the pipeline workload runs as. If not specified, the Compute Engine default service account in the project will be used. See https://cloud.google.com/compute/docs/access/service-accounts#default_service_account Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account. "startTime": "A String", # Output only. Pipeline start time. @@ -1168,6 +1174,8 @@

Method Details

}, }, }, + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "scheduleName": "A String", # Output only. The schedule resource name. Only returned if the Pipeline is created by Schedule API. "serviceAccount": "A String", # The service account that the pipeline workload runs as. If not specified, the Compute Engine default service account in the project will be used. See https://cloud.google.com/compute/docs/access/service-accounts#default_service_account Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account. "startTime": "A String", # Output only. Pipeline start time. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html b/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html index cb2c9f05c0d..0d4ece94d7a 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html @@ -120,7 +120,7 @@

Method Details

The object takes the form of: { # Request message for ComputeTokens RPC call. - "contents": [ # Required. Input content. + "contents": [ # Optional. Input 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. "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. @@ -154,10 +154,10 @@

Method Details

"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. }, ], - "instances": [ # Required. The instances that are the input to token computing API call. Schema is identical to the prediction schema of the text model, even for the non-text models, like chat models, or Codey models. + "instances": [ # Optional. The instances that are the input to token computing API call. Schema is identical to the prediction schema of the text model, even for the non-text models, like chat models, or Codey models. "", ], - "model": "A String", # Required. The name of the publisher model requested to serve the prediction. Format: projects/{project}/locations/{location}/publishers/*/models/* + "model": "A String", # Optional. The name of the publisher model requested to serve the prediction. Format: projects/{project}/locations/{location}/publishers/*/models/* } x__xgafv: string, V1 error format. @@ -193,7 +193,7 @@

Method Details

The object takes the form of: { # Request message for PredictionService.CountTokens. - "contents": [ # Required. Input content. + "contents": [ # Optional. Input 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. "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. @@ -227,10 +227,131 @@

Method Details

"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. }, ], - "instances": [ # Required. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model. + "instances": [ # Optional. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model. "", ], - "model": "A String", # Required. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*` + "model": "A String", # Optional. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*` + "systemInstruction": { # 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. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. + "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. 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. + "a_key": "", # Properties of the object. + }, + "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + }, + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "response": { # Required. The function response in JSON object format. + "a_key": "", # Properties of the object. + }, + }, + "inlineData": { # Content blob. It's preferred to send as text directly rather than raw bytes. # Optional. Inlined bytes data. + "data": "A String", # Required. Raw bytes. + "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. + "endOffset": "A String", # Optional. The end offset of the video. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "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. + }, + "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. + { # 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. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "functionDeclarations": [ # Optional. Function tool type. 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. + { # 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, dots and dashes, with a maximum length of 64. + "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. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "default": "", # Optional. Default value of the data. + "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", + ], + "example": "", # Optional. Example of the object. Will only populated when the object is the root. + "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maxLength": "A String", # Optional. Maximum length of the Type.STRING + "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT. + "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING + "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT. + "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER + "nullable": True or False, # Optional. Indicates if the value may be null. + "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression. + "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the Schema. + "type": "A String", # Optional. The type of the data. + }, + "response": { # 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 output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "default": "", # Optional. Default value of the data. + "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", + ], + "example": "", # Optional. Example of the object. Will only populated when the object is the root. + "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maxLength": "A String", # Optional. Maximum length of the Type.STRING + "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT. + "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING + "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT. + "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER + "nullable": True or False, # Optional. Indicates if the value may be null. + "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression. + "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the Schema. + "type": "A String", # Optional. The type of the data. + }, + }, + ], + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. + }, + "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. + "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported. + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/vertex-ai-search-and-conversation # Set to use data source powered by Vertex AI Search. + "datastore": "A String", # Required. Fully-qualified Vertex AI Search's datastore resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead. + "A String", + ], + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + }, + ], } x__xgafv: string, V1 error format. @@ -447,7 +568,7 @@

Method Details

"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. }, "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. - "disableAttribution": True or False, # Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation. + "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported. "vertexAiSearch": { # Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/vertex-ai-search-and-conversation # Set to use data source powered by Vertex AI Search. "datastore": "A String", # Required. Fully-qualified Vertex AI Search's datastore resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` }, @@ -533,25 +654,6 @@

Method Details

"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. "groundingMetadata": { # Metadata returned to client when grounding is enabled. # Output only. Metadata specifies sources used to ground generated content. - "groundingAttributions": [ # Optional. List of grounding attributions. - { # Grounding attribution. - "confidenceScore": 3.14, # Optional. Output only. Confidence score of the attribution. Ranges from 0 to 1. 1 is the most confident. - "retrievedContext": { # Attribution from context retrieved by the retrieval tools. # Optional. Attribution from context retrieved by the retrieval tools. - "title": "A String", # Output only. Title of the attribution. - "uri": "A String", # Output only. URI reference of the attribution. - }, - "segment": { # Segment of the content. # Output only. Segment of the content this attribution belongs to. - "endIndex": 42, # Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero. - "partIndex": 42, # Output only. The index of a Part object within its parent Content object. - "startIndex": 42, # Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero. - "text": "A String", # Output only. The text corresponding to the segment from the response. - }, - "web": { # Attribution from the web. # Optional. Attribution from the web. - "title": "A String", # Output only. Title of the attribution. - "uri": "A String", # Output only. URI reference of the attribution. - }, - }, - ], "groundingChunks": [ # List of supporting references retrieved from specified grounding source. { # Grounding chunk. "retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools. @@ -602,6 +704,7 @@

Method Details

"severityScore": 3.14, # Output only. Harm severity score. }, ], + "score": 3.14, # Output only. Confidence score of the candidate. }, ], "promptFeedback": { # Content filter results for a prompt sent in the request. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. @@ -1125,7 +1228,7 @@

Method Details

"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. }, "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. - "disableAttribution": True or False, # Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation. + "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported. "vertexAiSearch": { # Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/vertex-ai-search-and-conversation # Set to use data source powered by Vertex AI Search. "datastore": "A String", # Required. Fully-qualified Vertex AI Search's datastore resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` }, @@ -1211,25 +1314,6 @@

Method Details

"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. "groundingMetadata": { # Metadata returned to client when grounding is enabled. # Output only. Metadata specifies sources used to ground generated content. - "groundingAttributions": [ # Optional. List of grounding attributions. - { # Grounding attribution. - "confidenceScore": 3.14, # Optional. Output only. Confidence score of the attribution. Ranges from 0 to 1. 1 is the most confident. - "retrievedContext": { # Attribution from context retrieved by the retrieval tools. # Optional. Attribution from context retrieved by the retrieval tools. - "title": "A String", # Output only. Title of the attribution. - "uri": "A String", # Output only. URI reference of the attribution. - }, - "segment": { # Segment of the content. # Output only. Segment of the content this attribution belongs to. - "endIndex": 42, # Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero. - "partIndex": 42, # Output only. The index of a Part object within its parent Content object. - "startIndex": 42, # Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero. - "text": "A String", # Output only. The text corresponding to the segment from the response. - }, - "web": { # Attribution from the web. # Optional. Attribution from the web. - "title": "A String", # Output only. Title of the attribution. - "uri": "A String", # Output only. URI reference of the attribution. - }, - }, - ], "groundingChunks": [ # List of supporting references retrieved from specified grounding source. { # Grounding chunk. "retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools. @@ -1280,6 +1364,7 @@

Method Details

"severityScore": 3.14, # Output only. Harm severity score. }, ], + "score": 3.14, # Output only. Confidence score of the candidate. }, ], "promptFeedback": { # Content filter results for a prompt sent in the request. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.ragCorpora.ragFiles.html b/docs/dyn/aiplatform_v1beta1.projects.locations.ragCorpora.ragFiles.html index 62ebe65c71b..fe542508d91 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.ragCorpora.ragFiles.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.ragCorpora.ragFiles.html @@ -171,9 +171,42 @@

Method Details

}, ], }, + "jiraSource": { # The Jira source for the ImportRagFilesRequest. # The RagFile is imported from a Jira query. + "jiraQueries": [ # Required. The Jira queries. + { # JiraQueries contains the Jira queries and corresponding authentication. + "apiKeyConfig": { # The API secret. # Required. The SecretManager secret version resource name (e.g. projects/{project}/secrets/{secret}/versions/{version}) storing the Jira API key (https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/). + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + }, + "customQueries": [ # A list of custom Jira queries to import. For information about JQL (Jira Query Language), see https://support.atlassian.com/jira-service-management-cloud/docs/use-advanced-search-with-jira-query-language-jql/ + "A String", + ], + "email": "A String", # Required. The Jira email address. + "projects": [ # A list of Jira projects to import in their entirety. + "A String", + ], + "serverUri": "A String", # Required. The Jira server URI. + }, + ], + }, "name": "A String", # Output only. The resource name of the RagFile. "ragFileType": "A String", # Output only. The type of the RagFile. "sizeBytes": "A String", # Output only. The size of the RagFile in bytes. + "slackSource": { # The Slack source for the ImportRagFilesRequest. # The RagFile is imported from a Slack channel. + "channels": [ # Required. The Slack channels. + { # SlackChannels contains the Slack channels and corresponding access token. + "apiKeyConfig": { # The API secret. # Required. The SecretManager secret version resource name (e.g. projects/{project}/secrets/{secret}/versions/{version}) storing the Slack channel access token that has access to the slack channel IDs. See: https://api.slack.com/tutorials/tracks/getting-a-token. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + }, + "channels": [ # Required. The Slack channel IDs. + { # SlackChannel contains the Slack channel ID and the time range to import. + "channelId": "A String", # Required. The Slack channel ID. + "endTime": "A String", # Optional. The ending timestamp for messages to import. + "startTime": "A String", # Optional. The starting timestamp for messages to import. + }, + ], + }, + ], + }, "updateTime": "A String", # Output only. Timestamp when this RagFile was last updated. }
@@ -202,11 +235,44 @@

Method Details

}, ], }, + "jiraSource": { # The Jira source for the ImportRagFilesRequest. # Jira queries with their corresponding authentication. + "jiraQueries": [ # Required. The Jira queries. + { # JiraQueries contains the Jira queries and corresponding authentication. + "apiKeyConfig": { # The API secret. # Required. The SecretManager secret version resource name (e.g. projects/{project}/secrets/{secret}/versions/{version}) storing the Jira API key (https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/). + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + }, + "customQueries": [ # A list of custom Jira queries to import. For information about JQL (Jira Query Language), see https://support.atlassian.com/jira-service-management-cloud/docs/use-advanced-search-with-jira-query-language-jql/ + "A String", + ], + "email": "A String", # Required. The Jira email address. + "projects": [ # A list of Jira projects to import in their entirety. + "A String", + ], + "serverUri": "A String", # Required. The Jira server URI. + }, + ], + }, "maxEmbeddingRequestsPerMin": 42, # Optional. The max number of queries per minute that this job is allowed to make to the embedding model specified on the corpus. This value is specific to this job and not shared across other import jobs. Consult the Quotas page on the project to set an appropriate value here. If unspecified, a default value of 1,000 QPM would be used. "ragFileChunkingConfig": { # Specifies the size and overlap of chunks for RagFiles. # Specifies the size and overlap of chunks after importing RagFiles. "chunkOverlap": 42, # The overlap between chunks. "chunkSize": 42, # The size of the chunks. }, + "slackSource": { # The Slack source for the ImportRagFilesRequest. # Slack channels with their corresponding access tokens. + "channels": [ # Required. The Slack channels. + { # SlackChannels contains the Slack channels and corresponding access token. + "apiKeyConfig": { # The API secret. # Required. The SecretManager secret version resource name (e.g. projects/{project}/secrets/{secret}/versions/{version}) storing the Slack channel access token that has access to the slack channel IDs. See: https://api.slack.com/tutorials/tracks/getting-a-token. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + }, + "channels": [ # Required. The Slack channel IDs. + { # SlackChannel contains the Slack channel ID and the time range to import. + "channelId": "A String", # Required. The Slack channel ID. + "endTime": "A String", # Optional. The ending timestamp for messages to import. + "startTime": "A String", # Optional. The starting timestamp for messages to import. + }, + ], + }, + ], + }, }, } @@ -277,9 +343,42 @@

Method Details

}, ], }, + "jiraSource": { # The Jira source for the ImportRagFilesRequest. # The RagFile is imported from a Jira query. + "jiraQueries": [ # Required. The Jira queries. + { # JiraQueries contains the Jira queries and corresponding authentication. + "apiKeyConfig": { # The API secret. # Required. The SecretManager secret version resource name (e.g. projects/{project}/secrets/{secret}/versions/{version}) storing the Jira API key (https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/). + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + }, + "customQueries": [ # A list of custom Jira queries to import. For information about JQL (Jira Query Language), see https://support.atlassian.com/jira-service-management-cloud/docs/use-advanced-search-with-jira-query-language-jql/ + "A String", + ], + "email": "A String", # Required. The Jira email address. + "projects": [ # A list of Jira projects to import in their entirety. + "A String", + ], + "serverUri": "A String", # Required. The Jira server URI. + }, + ], + }, "name": "A String", # Output only. The resource name of the RagFile. "ragFileType": "A String", # Output only. The type of the RagFile. "sizeBytes": "A String", # Output only. The size of the RagFile in bytes. + "slackSource": { # The Slack source for the ImportRagFilesRequest. # The RagFile is imported from a Slack channel. + "channels": [ # Required. The Slack channels. + { # SlackChannels contains the Slack channels and corresponding access token. + "apiKeyConfig": { # The API secret. # Required. The SecretManager secret version resource name (e.g. projects/{project}/secrets/{secret}/versions/{version}) storing the Slack channel access token that has access to the slack channel IDs. See: https://api.slack.com/tutorials/tracks/getting-a-token. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + }, + "channels": [ # Required. The Slack channel IDs. + { # SlackChannel contains the Slack channel ID and the time range to import. + "channelId": "A String", # Required. The Slack channel ID. + "endTime": "A String", # Optional. The ending timestamp for messages to import. + "startTime": "A String", # Optional. The starting timestamp for messages to import. + }, + ], + }, + ], + }, "updateTime": "A String", # Output only. Timestamp when this RagFile was last updated. }, ], diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.schedules.html b/docs/dyn/aiplatform_v1beta1.projects.locations.schedules.html index 3b47bbc3a91..1b7bdb0ff45 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.schedules.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.schedules.html @@ -680,6 +680,8 @@

Method Details

}, }, }, + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "scheduleName": "A String", # Output only. The schedule resource name. Only returned if the Pipeline is created by Schedule API. "serviceAccount": "A String", # The service account that the pipeline workload runs as. If not specified, the Compute Engine default service account in the project will be used. See https://cloud.google.com/compute/docs/access/service-accounts#default_service_account Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account. "startTime": "A String", # Output only. Pipeline start time. @@ -1279,6 +1281,8 @@

Method Details

}, }, }, + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "scheduleName": "A String", # Output only. The schedule resource name. Only returned if the Pipeline is created by Schedule API. "serviceAccount": "A String", # The service account that the pipeline workload runs as. If not specified, the Compute Engine default service account in the project will be used. See https://cloud.google.com/compute/docs/access/service-accounts#default_service_account Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account. "startTime": "A String", # Output only. Pipeline start time. @@ -1920,6 +1924,8 @@

Method Details

}, }, }, + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "scheduleName": "A String", # Output only. The schedule resource name. Only returned if the Pipeline is created by Schedule API. "serviceAccount": "A String", # The service account that the pipeline workload runs as. If not specified, the Compute Engine default service account in the project will be used. See https://cloud.google.com/compute/docs/access/service-accounts#default_service_account Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account. "startTime": "A String", # Output only. Pipeline start time. @@ -2533,6 +2539,8 @@

Method Details

}, }, }, + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "scheduleName": "A String", # Output only. The schedule resource name. Only returned if the Pipeline is created by Schedule API. "serviceAccount": "A String", # The service account that the pipeline workload runs as. If not specified, the Compute Engine default service account in the project will be used. See https://cloud.google.com/compute/docs/access/service-accounts#default_service_account Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account. "startTime": "A String", # Output only. Pipeline start time. @@ -3150,6 +3158,8 @@

Method Details

}, }, }, + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "scheduleName": "A String", # Output only. The schedule resource name. Only returned if the Pipeline is created by Schedule API. "serviceAccount": "A String", # The service account that the pipeline workload runs as. If not specified, the Compute Engine default service account in the project will be used. See https://cloud.google.com/compute/docs/access/service-accounts#default_service_account Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account. "startTime": "A String", # Output only. Pipeline start time. @@ -3750,6 +3760,8 @@

Method Details

}, }, }, + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "scheduleName": "A String", # Output only. The schedule resource name. Only returned if the Pipeline is created by Schedule API. "serviceAccount": "A String", # The service account that the pipeline workload runs as. If not specified, the Compute Engine default service account in the project will be used. See https://cloud.google.com/compute/docs/access/service-accounts#default_service_account Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account. "startTime": "A String", # Output only. Pipeline start time. diff --git a/docs/dyn/aiplatform_v1beta1.publishers.models.html b/docs/dyn/aiplatform_v1beta1.publishers.models.html index f4b7e8076e0..06a848f6991 100644 --- a/docs/dyn/aiplatform_v1beta1.publishers.models.html +++ b/docs/dyn/aiplatform_v1beta1.publishers.models.html @@ -78,7 +78,7 @@

Instance Methods

close()

Close httplib2 connections.

- get(name, languageCode=None, view=None, x__xgafv=None)

+ get(name, isHuggingFaceModel=None, languageCode=None, view=None, x__xgafv=None)

Gets a Model Garden publisher model.

list(parent, filter=None, languageCode=None, orderBy=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)

@@ -93,12 +93,13 @@

Method Details

- get(name, languageCode=None, view=None, x__xgafv=None) + get(name, isHuggingFaceModel=None, languageCode=None, view=None, x__xgafv=None)
Gets a Model Garden publisher model.
 
 Args:
   name: string, Required. The name of the PublisherModel resource. Format: `publishers/{publisher}/models/{publisher_model}` (required)
-  languageCode: string, Optional. The IETF BCP-47 language code representing the language in which the publisher model's text information should be written in (see go/bcp47).
+  isHuggingFaceModel: boolean, Optional. Boolean indicates whether the requested model is a Hugging Face model.
+  languageCode: string, Optional. The IETF BCP-47 language code representing the language in which the publisher model's text information should be written in.
   view: string, Optional. PublisherModel view specifying which fields to read.
     Allowed values
       PUBLISHER_MODEL_VIEW_UNSPECIFIED - The default / unset value. The API will default to the BASIC view.
@@ -394,7 +395,7 @@ 

Method Details

Args: parent: string, Required. The name of the Publisher from which to list the PublisherModels. Format: `publishers/{publisher}` (required) filter: string, Optional. The standard list filter. - languageCode: string, Optional. The IETF BCP-47 language code representing the language in which the publisher models' text information should be written in (see go/bcp47). If not set, by default English (en). + languageCode: string, Optional. The IETF BCP-47 language code representing the language in which the publisher models' text information should be written in. If not set, by default English (en). orderBy: string, Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. pageSize: integer, Optional. The standard list page size. pageToken: string, Optional. The standard list page token. Typically obtained via ListPublisherModelsResponse.next_page_token of the previous ModelGardenService.ListPublisherModels call. diff --git a/docs/dyn/analyticsadmin_v1alpha.accounts.html b/docs/dyn/analyticsadmin_v1alpha.accounts.html index e8b0bc7d2b8..15cb1feda2f 100644 --- a/docs/dyn/analyticsadmin_v1alpha.accounts.html +++ b/docs/dyn/analyticsadmin_v1alpha.accounts.html @@ -166,7 +166,7 @@

Method Details

Get data sharing settings on an account. Data sharing settings are singletons.
 
 Args:
-  name: string, Required. The name of the settings to lookup. Format: accounts/{account}/dataSharingSettings Example: "accounts/1000/dataSharingSettings" (required)
+  name: string, Required. The name of the settings to lookup. Format: accounts/{account}/dataSharingSettings Example: `accounts/1000/dataSharingSettings` (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -502,7 +502,7 @@ 

Method Details

Searches through all changes to an account or its children given the specified set of filters.
 
 Args:
-  account: string, Required. The account resource for which to return change history resources. Format: accounts/{account} Example: "accounts/100" (required)
+  account: string, Required. The account resource for which to return change history resources. Format: accounts/{account} Example: `accounts/100` (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -517,7 +517,7 @@ 

Method Details

"latestChangeTime": "A String", # Optional. If set, only return changes made before this time (inclusive). "pageSize": 42, # Optional. The maximum number of ChangeHistoryEvent items to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 items will be returned. The maximum value is 200 (higher values will be coerced to the maximum). "pageToken": "A String", # Optional. A page token, received from a previous `SearchChangeHistoryEvents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `SearchChangeHistoryEvents` must match the call that provided the page token. - "property": "A String", # Optional. Resource name for a child property. If set, only return changes made to this property or its child resources. Format: properties/{propertyId} Example: "properties/100" + "property": "A String", # Optional. Resource name for a child property. If set, only return changes made to this property or its child resources. Format: properties/{propertyId} Example: `properties/100` "resourceType": [ # Optional. If set, only return changes if they are for a resource that matches at least one of these types. "A String", ], diff --git a/docs/dyn/analyticsadmin_v1alpha.properties.conversionEvents.html b/docs/dyn/analyticsadmin_v1alpha.properties.conversionEvents.html index 94c5e06a8c9..2fe1b64766b 100644 --- a/docs/dyn/analyticsadmin_v1alpha.properties.conversionEvents.html +++ b/docs/dyn/analyticsadmin_v1alpha.properties.conversionEvents.html @@ -79,22 +79,22 @@

Instance Methods

Close httplib2 connections.

create(parent, body=None, x__xgafv=None)

-

Creates a conversion event with the specified attributes.

+

Deprecated: Use `CreateKeyEvent` instead. Creates a conversion event with the specified attributes.

delete(name, x__xgafv=None)

-

Deletes a conversion event in a property.

+

Deprecated: Use `DeleteKeyEvent` instead. Deletes a conversion event in a property.

get(name, x__xgafv=None)

-

Retrieve a single conversion event.

+

Deprecated: Use `GetKeyEvent` instead. Retrieve a single conversion event.

list(parent, pageSize=None, pageToken=None, x__xgafv=None)

-

Returns a list of conversion events in the specified parent property. Returns an empty list if no conversion events are found.

+

Deprecated: Use `ListKeyEvents` instead. Returns a list of conversion events in the specified parent property. Returns an empty list if no conversion events are found.

list_next()

Retrieves the next page of results.

patch(name, body=None, updateMask=None, x__xgafv=None)

-

Updates a conversion event with the specified attributes.

+

Deprecated: Use `UpdateKeyEvent` instead. Updates a conversion event with the specified attributes.

Method Details

close() @@ -103,7 +103,7 @@

Method Details

create(parent, body=None, x__xgafv=None) -
Creates a conversion event with the specified attributes.
+  
Deprecated: Use `CreateKeyEvent` instead. Creates a conversion event with the specified attributes.
 
 Args:
   parent: string, Required. The resource name of the parent property where this conversion event will be created. Format: properties/123 (required)
@@ -147,7 +147,7 @@ 

Method Details

delete(name, x__xgafv=None) -
Deletes a conversion event in a property.
+  
Deprecated: Use `DeleteKeyEvent` instead. Deletes a conversion event in a property.
 
 Args:
   name: string, Required. The resource name of the conversion event to delete. Format: properties/{property}/conversionEvents/{conversion_event} Example: "properties/123/conversionEvents/456" (required)
@@ -165,7 +165,7 @@ 

Method Details

get(name, x__xgafv=None) -
Retrieve a single conversion event.
+  
Deprecated: Use `GetKeyEvent` instead. Retrieve a single conversion event.
 
 Args:
   name: string, Required. The resource name of the conversion event to retrieve. Format: properties/{property}/conversionEvents/{conversion_event} Example: "properties/123/conversionEvents/456" (required)
@@ -193,7 +193,7 @@ 

Method Details

list(parent, pageSize=None, pageToken=None, x__xgafv=None) -
Returns a list of conversion events in the specified parent property. Returns an empty list if no conversion events are found.
+  
Deprecated: Use `ListKeyEvents` instead. Returns a list of conversion events in the specified parent property. Returns an empty list if no conversion events are found.
 
 Args:
   parent: string, Required. The resource name of the parent property. Example: 'properties/123' (required)
@@ -242,7 +242,7 @@ 

Method Details

patch(name, body=None, updateMask=None, x__xgafv=None) -
Updates a conversion event with the specified attributes.
+  
Deprecated: Use `UpdateKeyEvent` instead. Updates a conversion event with the specified attributes.
 
 Args:
   name: string, Output only. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event} (required)
diff --git a/docs/dyn/analyticsadmin_v1alpha.properties.dataStreams.html b/docs/dyn/analyticsadmin_v1alpha.properties.dataStreams.html
index 23e2ba6562b..397abbaef32 100644
--- a/docs/dyn/analyticsadmin_v1alpha.properties.dataStreams.html
+++ b/docs/dyn/analyticsadmin_v1alpha.properties.dataStreams.html
@@ -79,11 +79,6 @@ 

Instance Methods

Returns the eventCreateRules Resource.

-

- eventEditRules() -

-

Returns the eventEditRules Resource.

-

measurementProtocolSecrets()

@@ -308,7 +303,7 @@

Method Details

Returns the Site Tag for the specified web stream. Site Tags are immutable singletons.
 
 Args:
-  name: string, Required. The name of the site tag to lookup. Note that site tags are singletons and do not have unique IDs. Format: properties/{property_id}/dataStreams/{stream_id}/globalSiteTag Example: "properties/123/dataStreams/456/globalSiteTag" (required)
+  name: string, Required. The name of the site tag to lookup. Note that site tags are singletons and do not have unique IDs. Format: properties/{property_id}/dataStreams/{stream_id}/globalSiteTag Example: `properties/123/dataStreams/456/globalSiteTag` (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
diff --git a/docs/dyn/analyticsadmin_v1alpha.properties.firebaseLinks.html b/docs/dyn/analyticsadmin_v1alpha.properties.firebaseLinks.html
index ceb2fd7c37c..5df2bec7b91 100644
--- a/docs/dyn/analyticsadmin_v1alpha.properties.firebaseLinks.html
+++ b/docs/dyn/analyticsadmin_v1alpha.properties.firebaseLinks.html
@@ -100,7 +100,7 @@ 

Method Details

Creates a FirebaseLink. Properties can have at most one FirebaseLink.
 
 Args:
-  parent: string, Required. Format: properties/{property_id} Example: properties/1234 (required)
+  parent: string, Required. Format: properties/{property_id} Example: `properties/1234` (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -130,7 +130,7 @@ 

Method Details

Deletes a FirebaseLink on a property
 
 Args:
-  name: string, Required. Format: properties/{property_id}/firebaseLinks/{firebase_link_id} Example: properties/1234/firebaseLinks/5678 (required)
+  name: string, Required. Format: properties/{property_id}/firebaseLinks/{firebase_link_id} Example: `properties/1234/firebaseLinks/5678` (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -148,7 +148,7 @@ 

Method Details

Lists FirebaseLinks on a property. Properties can have at most one FirebaseLink.
 
 Args:
-  parent: string, Required. Format: properties/{property_id} Example: properties/1234 (required)
+  parent: string, Required. Format: properties/{property_id} Example: `properties/1234` (required)
   pageSize: integer, The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)
   pageToken: string, A page token, received from a previous `ListFirebaseLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListFirebaseLinks` must match the call that provided the page token.
   x__xgafv: string, V1 error format.
diff --git a/docs/dyn/analyticsadmin_v1beta.accounts.html b/docs/dyn/analyticsadmin_v1beta.accounts.html
index fe5ed33c84b..fce75e43add 100644
--- a/docs/dyn/analyticsadmin_v1beta.accounts.html
+++ b/docs/dyn/analyticsadmin_v1beta.accounts.html
@@ -161,7 +161,7 @@ 

Method Details

Get data sharing settings on an account. Data sharing settings are singletons.
 
 Args:
-  name: string, Required. The name of the settings to lookup. Format: accounts/{account}/dataSharingSettings Example: "accounts/1000/dataSharingSettings" (required)
+  name: string, Required. The name of the settings to lookup. Format: accounts/{account}/dataSharingSettings Example: `accounts/1000/dataSharingSettings` (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -497,7 +497,7 @@ 

Method Details

Searches through all changes to an account or its children given the specified set of filters.
 
 Args:
-  account: string, Required. The account resource for which to return change history resources. Format: accounts/{account} Example: "accounts/100" (required)
+  account: string, Required. The account resource for which to return change history resources. Format: accounts/{account} Example: `accounts/100` (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -512,7 +512,7 @@ 

Method Details

"latestChangeTime": "A String", # Optional. If set, only return changes made before this time (inclusive). "pageSize": 42, # Optional. The maximum number of ChangeHistoryEvent items to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 items will be returned. The maximum value is 200 (higher values will be coerced to the maximum). "pageToken": "A String", # Optional. A page token, received from a previous `SearchChangeHistoryEvents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `SearchChangeHistoryEvents` must match the call that provided the page token. - "property": "A String", # Optional. Resource name for a child property. If set, only return changes made to this property or its child resources. Format: properties/{propertyId} Example: "properties/100" + "property": "A String", # Optional. Resource name for a child property. If set, only return changes made to this property or its child resources. Format: properties/{propertyId} Example: `properties/100` "resourceType": [ # Optional. If set, only return changes if they are for a resource that matches at least one of these types. "A String", ], diff --git a/docs/dyn/analyticsadmin_v1beta.properties.conversionEvents.html b/docs/dyn/analyticsadmin_v1beta.properties.conversionEvents.html index cf252513141..042317e3ef5 100644 --- a/docs/dyn/analyticsadmin_v1beta.properties.conversionEvents.html +++ b/docs/dyn/analyticsadmin_v1beta.properties.conversionEvents.html @@ -79,22 +79,22 @@

Instance Methods

Close httplib2 connections.

create(parent, body=None, x__xgafv=None)

-

Creates a conversion event with the specified attributes.

+

Deprecated: Use `CreateKeyEvent` instead. Creates a conversion event with the specified attributes.

delete(name, x__xgafv=None)

-

Deletes a conversion event in a property.

+

Deprecated: Use `DeleteKeyEvent` instead. Deletes a conversion event in a property.

get(name, x__xgafv=None)

-

Retrieve a single conversion event.

+

Deprecated: Use `GetKeyEvent` instead. Retrieve a single conversion event.

list(parent, pageSize=None, pageToken=None, x__xgafv=None)

-

Returns a list of conversion events in the specified parent property. Returns an empty list if no conversion events are found.

+

Deprecated: Use `ListKeyEvents` instead. Returns a list of conversion events in the specified parent property. Returns an empty list if no conversion events are found.

list_next()

Retrieves the next page of results.

patch(name, body=None, updateMask=None, x__xgafv=None)

-

Updates a conversion event with the specified attributes.

+

Deprecated: Use `UpdateKeyEvent` instead. Updates a conversion event with the specified attributes.

Method Details

close() @@ -103,7 +103,7 @@

Method Details

create(parent, body=None, x__xgafv=None) -
Creates a conversion event with the specified attributes.
+  
Deprecated: Use `CreateKeyEvent` instead. Creates a conversion event with the specified attributes.
 
 Args:
   parent: string, Required. The resource name of the parent property where this conversion event will be created. Format: properties/123 (required)
@@ -147,7 +147,7 @@ 

Method Details

delete(name, x__xgafv=None) -
Deletes a conversion event in a property.
+  
Deprecated: Use `DeleteKeyEvent` instead. Deletes a conversion event in a property.
 
 Args:
   name: string, Required. The resource name of the conversion event to delete. Format: properties/{property}/conversionEvents/{conversion_event} Example: "properties/123/conversionEvents/456" (required)
@@ -165,7 +165,7 @@ 

Method Details

get(name, x__xgafv=None) -
Retrieve a single conversion event.
+  
Deprecated: Use `GetKeyEvent` instead. Retrieve a single conversion event.
 
 Args:
   name: string, Required. The resource name of the conversion event to retrieve. Format: properties/{property}/conversionEvents/{conversion_event} Example: "properties/123/conversionEvents/456" (required)
@@ -193,7 +193,7 @@ 

Method Details

list(parent, pageSize=None, pageToken=None, x__xgafv=None) -
Returns a list of conversion events in the specified parent property. Returns an empty list if no conversion events are found.
+  
Deprecated: Use `ListKeyEvents` instead. Returns a list of conversion events in the specified parent property. Returns an empty list if no conversion events are found.
 
 Args:
   parent: string, Required. The resource name of the parent property. Example: 'properties/123' (required)
@@ -242,7 +242,7 @@ 

Method Details

patch(name, body=None, updateMask=None, x__xgafv=None) -
Updates a conversion event with the specified attributes.
+  
Deprecated: Use `UpdateKeyEvent` instead. Updates a conversion event with the specified attributes.
 
 Args:
   name: string, Output only. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event} (required)
diff --git a/docs/dyn/analyticsadmin_v1beta.properties.dataStreams.html b/docs/dyn/analyticsadmin_v1beta.properties.dataStreams.html
index b3a1636bb64..ffa13534241 100644
--- a/docs/dyn/analyticsadmin_v1beta.properties.dataStreams.html
+++ b/docs/dyn/analyticsadmin_v1beta.properties.dataStreams.html
@@ -74,11 +74,6 @@
 
 

Google Analytics Admin API . properties . dataStreams

Instance Methods

-

- eventEditRules() -

-

Returns the eventEditRules Resource.

-

measurementProtocolSecrets()

diff --git a/docs/dyn/analyticsadmin_v1beta.properties.firebaseLinks.html b/docs/dyn/analyticsadmin_v1beta.properties.firebaseLinks.html index 939d87d0477..77cae83ee4a 100644 --- a/docs/dyn/analyticsadmin_v1beta.properties.firebaseLinks.html +++ b/docs/dyn/analyticsadmin_v1beta.properties.firebaseLinks.html @@ -100,7 +100,7 @@

Method Details

Creates a FirebaseLink. Properties can have at most one FirebaseLink.
 
 Args:
-  parent: string, Required. Format: properties/{property_id} Example: properties/1234 (required)
+  parent: string, Required. Format: properties/{property_id} Example: `properties/1234` (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -130,7 +130,7 @@ 

Method Details

Deletes a FirebaseLink on a property
 
 Args:
-  name: string, Required. Format: properties/{property_id}/firebaseLinks/{firebase_link_id} Example: properties/1234/firebaseLinks/5678 (required)
+  name: string, Required. Format: properties/{property_id}/firebaseLinks/{firebase_link_id} Example: `properties/1234/firebaseLinks/5678` (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -148,7 +148,7 @@ 

Method Details

Lists FirebaseLinks on a property. Properties can have at most one FirebaseLink.
 
 Args:
-  parent: string, Required. Format: properties/{property_id} Example: properties/1234 (required)
+  parent: string, Required. Format: properties/{property_id} Example: `properties/1234` (required)
   pageSize: integer, The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)
   pageToken: string, A page token, received from a previous `ListFirebaseLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListFirebaseLinks` must match the call that provided the page token.
   x__xgafv: string, V1 error format.
diff --git a/docs/dyn/androidmanagement_v1.enterprises.enrollmentTokens.html b/docs/dyn/androidmanagement_v1.enterprises.enrollmentTokens.html
index 11d52e788a4..9fb2dd67e3e 100644
--- a/docs/dyn/androidmanagement_v1.enterprises.enrollmentTokens.html
+++ b/docs/dyn/androidmanagement_v1.enterprises.enrollmentTokens.html
@@ -79,7 +79,7 @@ 

Instance Methods

Close httplib2 connections.

create(parent, body=None, x__xgafv=None)

-

Creates an enrollment token for a given enterprise. It's up to the caller's responsibility to manage the lifecycle of newly created tokens and deleting them when they're not intended to be used anymore. Once an enrollment token has been created, it's not possible to retrieve the token's content anymore using AM API. It is recommended for EMMs to securely store the token if it's intended to be reused.

+

Creates an enrollment token for a given enterprise. It's up to the caller's responsibility to manage the lifecycle of newly created tokens and deleting them when they're not intended to be used anymore.

delete(name, x__xgafv=None)

Deletes an enrollment token. This operation invalidates the token, preventing its future use.

@@ -100,7 +100,7 @@

Method Details

create(parent, body=None, x__xgafv=None) -
Creates an enrollment token for a given enterprise. It's up to the caller's responsibility to manage the lifecycle of newly created tokens and deleting them when they're not intended to be used anymore. Once an enrollment token has been created, it's not possible to retrieve the token's content anymore using AM API. It is recommended for EMMs to securely store the token if it's intended to be reused.
+  
Creates an enrollment token for a given enterprise. It's up to the caller's responsibility to manage the lifecycle of newly created tokens and deleting them when they're not intended to be used anymore.
 
 Args:
   parent: string, The name of the enterprise in the form enterprises/{enterpriseId}. (required)
diff --git a/docs/dyn/apim_v1alpha.projects.locations.html b/docs/dyn/apim_v1alpha.projects.locations.html
index 804b5f88be2..7c0dbb7de19 100644
--- a/docs/dyn/apim_v1alpha.projects.locations.html
+++ b/docs/dyn/apim_v1alpha.projects.locations.html
@@ -98,6 +98,12 @@ 

Instance Methods

list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

Lists information about the supported locations for this service.

+

+ listApiObservationTags(parent, pageSize=None, pageToken=None, x__xgafv=None)

+

ListApiObservationTags lists all extant tags on any observation in the given project.

+

+ listApiObservationTags_next()

+

Retrieves the next page of results.

list_next()

Retrieves the next page of results.

@@ -169,6 +175,44 @@

Method Details

}
+
+ listApiObservationTags(parent, pageSize=None, pageToken=None, x__xgafv=None) +
ListApiObservationTags lists all extant tags on any observation in the given project.
+
+Args:
+  parent: string, Required. The parent, which owns this collection of tags. Format: projects/{project}/locations/{location} (required)
+  pageSize: integer, Optional. The maximum number of tags to return. The service may return fewer than this value. If unspecified, at most 10 tags will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
+  pageToken: string, Optional. A page token, received from a previous `ListApiObservationTags` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListApiObservationTags` must 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:
+
+    { # Message for response to listing tags
+  "apiObservationTags": [ # The tags from the specified project
+    "A String",
+  ],
+  "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.
+}
+
+ +
+ listApiObservationTags_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.
+        
+
+
list_next()
Retrieves the next page of results.
diff --git a/docs/dyn/apim_v1alpha.projects.locations.observationJobs.apiObservations.apiOperations.html b/docs/dyn/apim_v1alpha.projects.locations.observationJobs.apiObservations.apiOperations.html
index 358500ee4a6..e4eec036770 100644
--- a/docs/dyn/apim_v1alpha.projects.locations.observationJobs.apiObservations.apiOperations.html
+++ b/docs/dyn/apim_v1alpha.projects.locations.observationJobs.apiObservations.apiOperations.html
@@ -82,7 +82,7 @@ 

Instance Methods

GetApiOperation retrieves a single ApiOperation by name.

list(parent, pageSize=None, pageToken=None, x__xgafv=None)

-

ListApiOperations gets all ApiOperations for a given project and location and ObservationJob and ApiObservation

+

ListApiOperations gets all ApiOperations for a given project and location and ObservationJob and ApiObservation.

list_next()

Retrieves the next page of results.

@@ -154,7 +154,7 @@

Method Details

list(parent, pageSize=None, pageToken=None, x__xgafv=None) -
ListApiOperations gets all ApiOperations for a given project and location and ObservationJob and ApiObservation
+  
ListApiOperations gets all ApiOperations for a given project and location and ObservationJob and ApiObservation.
 
 Args:
   parent: string, Required. The parent, which owns this collection of ApiOperations. Format: projects/{project}/locations/{location}/observationJobs/{observation_job}/apiObservations/{api_observation} (required)
diff --git a/docs/dyn/apim_v1alpha.projects.locations.observationJobs.apiObservations.html b/docs/dyn/apim_v1alpha.projects.locations.observationJobs.apiObservations.html
index 95b3e84f734..3712e36d21a 100644
--- a/docs/dyn/apim_v1alpha.projects.locations.observationJobs.apiObservations.html
+++ b/docs/dyn/apim_v1alpha.projects.locations.observationJobs.apiObservations.html
@@ -79,6 +79,9 @@ 

Instance Methods

Returns the apiOperations Resource.

+

+ batchEditTags(parent, body=None, x__xgafv=None)

+

BatchEditTagsApiObservations adds or removes Tags for ApiObservations.

close()

Close httplib2 connections.

@@ -87,11 +90,66 @@

Instance Methods

GetApiObservation retrieves a single ApiObservation by name.

list(parent, pageSize=None, pageToken=None, x__xgafv=None)

-

ListApiObservations gets all ApiObservations for a given project and location and ObservationJob

+

ListApiObservations gets all ApiObservations for a given project and location and ObservationJob.

list_next()

Retrieves the next page of results.

Method Details

+
+ batchEditTags(parent, body=None, x__xgafv=None) +
BatchEditTagsApiObservations adds or removes Tags for ApiObservations.
+
+Args:
+  parent: string, Required. The parent resource shared by all ApiObservations being edited. Format: projects/{project}/locations/{location}/observationJobs/{observation_job} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Message for requesting batch edit tags for ApiObservations
+  "requests": [ # Required. The request message specifying the resources to update. A maximum of 1000 apiObservations can be modified in a batch.
+    { # Message for requesting edit tags for ApiObservation
+      "apiObservationId": "A String", # Required. Identifier of ApiObservation need to be edit tags Format example: "apigee.googleapis.com|us-west1|443"
+      "tagActions": [ # Required. Tag actions to be applied
+        { # Message for edit tag action
+          "action": "A String", # Required. Action to be applied
+          "tag": "A String", # Required. Tag to be added or removed
+        },
+      ],
+    },
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message for response to edit Tags for ApiObservations
+  "apiObservations": [ # ApiObservations that were changed
+    { # Message describing ApiObservation object
+      "apiOperationCount": "A String", # The number of observed API Operations.
+      "createTime": "A String", # Create time stamp
+      "hostname": "A String", # The hostname of requests processed for this Observation.
+      "lastEventDetectedTime": "A String", # Last event detected time stamp
+      "name": "A String", # Identifier. Name of resource
+      "serverIps": [ # The IP address (IPv4 or IPv6) of the origin server that the request was sent to. This field can include port information. Examples: `"192.168.1.1"`, `"10.0.0.1:80"`, `"FE80::0202:B3FF:FE1E:8329"`.
+        "A String",
+      ],
+      "sourceLocations": [ # Location of the Observation Source, for example "us-central1" or "europe-west1."
+        "A String",
+      ],
+      "style": "A String", # Style of ApiObservation
+      "tags": [ # User-defined tags to organize and sort
+        "A String",
+      ],
+      "updateTime": "A String", # Update time stamp
+    },
+  ],
+}
+
+
close()
Close httplib2 connections.
@@ -133,7 +191,7 @@

Method Details

list(parent, pageSize=None, pageToken=None, x__xgafv=None) -
ListApiObservations gets all ApiObservations for a given project and location and ObservationJob
+  
ListApiObservations gets all ApiObservations for a given project and location and ObservationJob.
 
 Args:
   parent: string, Required. The parent, which owns this collection of ApiObservations. Format: projects/{project}/locations/{location}/observationJobs/{observation_job} (required)
diff --git a/docs/dyn/apim_v1alpha.projects.locations.observationJobs.html b/docs/dyn/apim_v1alpha.projects.locations.observationJobs.html
index 13878a4ac0e..b8008fb41a7 100644
--- a/docs/dyn/apim_v1alpha.projects.locations.observationJobs.html
+++ b/docs/dyn/apim_v1alpha.projects.locations.observationJobs.html
@@ -99,7 +99,7 @@ 

Instance Methods

GetObservationJob retrieves a single ObservationJob by name.

list(parent, pageSize=None, pageToken=None, x__xgafv=None)

-

ListObservationJobs gets all ObservationJobs for a given project and location

+

ListObservationJobs gets all ObservationJobs for a given project and location.

list_next()

Retrieves the next page of results.

@@ -303,7 +303,7 @@

Method Details

list(parent, pageSize=None, pageToken=None, x__xgafv=None) -
ListObservationJobs gets all ObservationJobs for a given project and location
+  
ListObservationJobs gets all ObservationJobs for a given project and location.
 
 Args:
   parent: string, Required. The parent, which owns this collection of ObservationJobs. Format: projects/{project}/locations/{location} (required)
diff --git a/docs/dyn/apim_v1alpha.projects.locations.observationSources.html b/docs/dyn/apim_v1alpha.projects.locations.observationSources.html
index 2bc60f346a2..da4f26b7893 100644
--- a/docs/dyn/apim_v1alpha.projects.locations.observationSources.html
+++ b/docs/dyn/apim_v1alpha.projects.locations.observationSources.html
@@ -88,7 +88,7 @@ 

Instance Methods

GetObservationSource retrieves a single ObservationSource by name.

list(parent, pageSize=None, pageToken=None, x__xgafv=None)

-

ListObservationSources gets all ObservationSources for a given project and location

+

ListObservationSources gets all ObservationSources for a given project and location.

list_next()

Retrieves the next page of results.

@@ -220,7 +220,7 @@

Method Details

list(parent, pageSize=None, pageToken=None, x__xgafv=None) -
ListObservationSources gets all ObservationSources for a given project and location
+  
ListObservationSources gets all ObservationSources for a given project and location.
 
 Args:
   parent: string, Required. The parent, which owns this collection of ObservationSources. Format: projects/{project}/locations/{location} (required)
diff --git a/docs/dyn/artifactregistry_v1.projects.html b/docs/dyn/artifactregistry_v1.projects.html
index 2640ccae90e..492035a1368 100644
--- a/docs/dyn/artifactregistry_v1.projects.html
+++ b/docs/dyn/artifactregistry_v1.projects.html
@@ -111,6 +111,7 @@ 

Method Details

{ # The Artifact Registry settings that apply to a Project. "legacyRedirectionState": "A String", # The redirection state of the legacy repositories in this project. "name": "A String", # The name of the project's settings. Always of the form: projects/{project-id}/projectSettings In update request: never set In response: always set + "pullPercent": 42, # The percentage of pull traffic to redirect from GCR to AR when using partial redirection. }
@@ -126,6 +127,7 @@

Method Details

{ # The Artifact Registry settings that apply to a Project. "legacyRedirectionState": "A String", # The redirection state of the legacy repositories in this project. "name": "A String", # The name of the project's settings. Always of the form: projects/{project-id}/projectSettings In update request: never set In response: always set + "pullPercent": 42, # The percentage of pull traffic to redirect from GCR to AR when using partial redirection. } updateMask: string, Field mask to support partial updates. @@ -140,6 +142,7 @@

Method Details

{ # The Artifact Registry settings that apply to a Project. "legacyRedirectionState": "A String", # The redirection state of the legacy repositories in this project. "name": "A String", # The name of the project's settings. Always of the form: projects/{project-id}/projectSettings In update request: never set In response: always set + "pullPercent": 42, # The percentage of pull traffic to redirect from GCR to AR when using partial redirection. }
diff --git a/docs/dyn/artifactregistry_v1beta2.projects.html b/docs/dyn/artifactregistry_v1beta2.projects.html index dca13789dfb..e077a698a58 100644 --- a/docs/dyn/artifactregistry_v1beta2.projects.html +++ b/docs/dyn/artifactregistry_v1beta2.projects.html @@ -111,6 +111,7 @@

Method Details

{ # The Artifact Registry settings that apply to a Project. "legacyRedirectionState": "A String", # The redirection state of the legacy repositories in this project. "name": "A String", # The name of the project's settings. Always of the form: projects/{project-id}/projectSettings In update request: never set In response: always set + "pullPercent": 42, # The percentage of pull traffic to redirect from GCR to AR when using partial redirection. }
@@ -126,6 +127,7 @@

Method Details

{ # The Artifact Registry settings that apply to a Project. "legacyRedirectionState": "A String", # The redirection state of the legacy repositories in this project. "name": "A String", # The name of the project's settings. Always of the form: projects/{project-id}/projectSettings In update request: never set In response: always set + "pullPercent": 42, # The percentage of pull traffic to redirect from GCR to AR when using partial redirection. } updateMask: string, Field mask to support partial updates. @@ -140,6 +142,7 @@

Method Details

{ # The Artifact Registry settings that apply to a Project. "legacyRedirectionState": "A String", # The redirection state of the legacy repositories in this project. "name": "A String", # The name of the project's settings. Always of the form: projects/{project-id}/projectSettings In update request: never set In response: always set + "pullPercent": 42, # The percentage of pull traffic to redirect from GCR to AR when using partial redirection. }
diff --git a/docs/dyn/authorizedbuyersmarketplace_v1alpha.bidders.auctionPackages.html b/docs/dyn/authorizedbuyersmarketplace_v1alpha.bidders.auctionPackages.html new file mode 100644 index 00000000000..ce09eeb54af --- /dev/null +++ b/docs/dyn/authorizedbuyersmarketplace_v1alpha.bidders.auctionPackages.html @@ -0,0 +1,153 @@ + + + +

Authorized Buyers Marketplace API . bidders . auctionPackages

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

+

List the auction packages. Buyers can use the URL path "/v1alpha/buyers/{accountId}/auctionPackages" to list auction packages for the current buyer and its clients. Bidders can use the URL path "/v1alpha/bidders/{accountId}/auctionPackages" to list auction packages for the bidder, its media planners, its buyers, and all their clients.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
List the auction packages. Buyers can use the URL path "/v1alpha/buyers/{accountId}/auctionPackages" to list auction packages for the current buyer and its clients. Bidders can use the URL path "/v1alpha/bidders/{accountId}/auctionPackages" to list auction packages for the bidder, its media planners, its buyers, and all their clients.
+
+Args:
+  parent: string, Required. Name of the parent buyer that can access the auction package. Format: `buyers/{accountId}`. When used with a bidder account, the auction packages that the bidder, its media planners, its buyers and clients are subscribed to will be listed, in the format `bidders/{accountId}`. (required)
+  filter: string, Optional. Optional query string using the [Cloud API list filtering syntax](/authorized-buyers/apis/guides/list-filters). Only supported when parent is bidder. Supported columns for filtering are: * displayName * createTime * updateTime * eligibleSeatIds
+  orderBy: string, Optional. An optional query string to sort auction packages using the [Cloud API sorting syntax](https://cloud.google.com/apis/design/design_patterns#sorting_order). If no sort order is specified, results will be returned in an arbitrary order. Only supported when parent is bidder. Supported columns for sorting are: * displayName * createTime * updateTime
+  pageSize: integer, Requested page size. The server may return fewer results than requested. Max allowed page size is 500.
+  pageToken: string, The page token as returned. ListAuctionPackagesResponse.nextPageToken
+  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 listing auction packages.
+  "auctionPackages": [ # The list of auction packages.
+    { # Defines a segment of inventory that buyer wants to buy. It's created by buyer and could be shared with multiple buyers.
+      "createTime": "A String", # Output only. Time the auction package was created.
+      "creator": "A String", # Output only. The buyer that created this auction package. Format: `buyers/{buyerAccountId}`
+      "description": "A String", # Output only. A description of the auction package.
+      "displayName": "A String", # The display_name assigned to the auction package.
+      "eligibleSeatIds": [ # Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.
+        "A String",
+      ],
+      "name": "A String", # Immutable. The unique identifier for the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}` The auction_package_id part of name is sent in the BidRequest to all RTB bidders and is returned as deal_id by the bidder in the BidResponse.
+      "subscribedBuyers": [ # Output only. The list of buyers that are subscribed to the AuctionPackage. This field is only populated when calling as a bidder. Format: `buyers/{buyerAccountId}`
+        "A String",
+      ],
+      "subscribedClients": [ # Output only. When calling as a buyer, the list of clients of the current buyer that are subscribed to the AuctionPackage. When calling as a bidder, the list of clients that are subscribed to the AuctionPackage owned by the bidder or its buyers. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}`
+        "A String",
+      ],
+      "subscribedMediaPlanners": [ # Output only. The list of media planners that are subscribed to the AuctionPackage. This field is only populated when calling as a bidder.
+        { # Describes a single Media Planner account.
+          "accountId": "A String", # Output only. Account ID of the media planner.
+        },
+      ],
+      "updateTime": "A String", # Output only. Time the auction package was last updated. This value is only increased when this auction package is updated but never when a buyer subscribed.
+    },
+  ],
+  "nextPageToken": "A String", # Continuation token for fetching the next page of results. Pass this value in the ListAuctionPackagesRequest.pageToken field in the subsequent call to the `ListAuctionPackages` method to retrieve the next page of results.
+}
+
+ +
+ 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/authorizedbuyersmarketplace_v1alpha.bidders.finalizedDeals.html b/docs/dyn/authorizedbuyersmarketplace_v1alpha.bidders.finalizedDeals.html new file mode 100644 index 00000000000..4cb42775a21 --- /dev/null +++ b/docs/dyn/authorizedbuyersmarketplace_v1alpha.bidders.finalizedDeals.html @@ -0,0 +1,370 @@ + + + +

Authorized Buyers Marketplace API . bidders . finalizedDeals

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists finalized deals. Use the URL path "/v1alpha/buyers/{accountId}/finalizedDeals" to list finalized deals for the current buyer and its clients. Bidders can use the URL path "/v1alpha/bidders/{accountId}/finalizedDeals" to list finalized deals for the bidder, its buyers and all their clients.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists finalized deals. Use the URL path "/v1alpha/buyers/{accountId}/finalizedDeals" to list finalized deals for the current buyer and its clients. Bidders can use the URL path "/v1alpha/bidders/{accountId}/finalizedDeals" to list finalized deals for the bidder, its buyers and all their clients.
+
+Args:
+  parent: string, Required. The buyer to list the finalized deals for, in the format: `buyers/{accountId}`. When used to list finalized deals for a bidder, its buyers and clients, in the format `bidders/{accountId}`. (required)
+  filter: string, Optional query string using the [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) Supported columns for filtering are: * deal.displayName * deal.dealType * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * deal.eligibleSeatIds * dealServingStatus
+  orderBy: string, An optional query string to sort finalized deals using the [Cloud API sorting syntax](https://cloud.google.com/apis/design/design_patterns#sorting_order). If no sort order is specified, results will be returned in an arbitrary order. Supported columns for sorting are: * deal.displayName * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * rtbMetrics.bidRequests7Days * rtbMetrics.bids7Days * rtbMetrics.adImpressions7Days * rtbMetrics.bidRate7Days * rtbMetrics.filteredBidRate7Days * rtbMetrics.mustBidRateCurrentMonth
+  pageSize: integer, Requested page size. The server may return fewer results than requested. If requested more than 500, the server will return 500 results per page. If unspecified, the server will pick a default page size of 100.
+  pageToken: string, The page token as returned from ListFinalizedDealsResponse.
+  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 listing finalized deals.
+  "finalizedDeals": [ # The list of finalized deals.
+    { # A finalized deal is a snapshot of the deal when both buyer and seller accept the deal. The buyer or seller can update the deal after it's been finalized and renegotiate on the deal targeting, terms and other fields, while at the same time the finalized snapshot of the deal can still be retrieved using this API. The finalized deal contains a copy of the deal as it existed when most recently finalized, as well as fields related to deal serving such as pause/resume status, RTB metrics, and more.
+      "deal": { # A deal represents a segment of inventory for displaying ads that contains the terms and targeting information that is used for serving as well as the deal stats and status. Note: A proposal may contain multiple deals. # A copy of the Deal made upon finalization. During renegotiation, this will reflect the last finalized deal before renegotiation was initiated.
+        "billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer; when the deal belongs to a media planner account, this field will be empty. Format : `buyers/{buyerAccountId}`
+        "buyer": "A String", # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. Format: `buyers/{buyerAccountId}`
+        "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+        "createTime": "A String", # Output only. The time of the deal creation.
+        "creativeRequirements": { # Message captures data about the creatives in the deal. # Output only. Metadata about the creatives of this deal.
+          "creativeFormat": "A String", # Output only. The format of the creative, only applicable for programmatic guaranteed and preferred deals.
+          "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.
+          "creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.
+          "maxAdDurationMs": "A String", # Output only. The max duration of the video creative in milliseconds. only applicable for deals with video creatives.
+          "programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by the buyer.
+          "skippableAdType": "A String", # Output only. Skippable video ads allow viewers to skip ads after 5 seconds. Only applicable for deals with video creatives.
+        },
+        "dealType": "A String", # Output only. Type of deal.
+        "deliveryControl": { # Message contains details about how the deal will be paced. # Output only. Specifies the pacing set by the publisher.
+          "companionDeliveryType": "A String", # Output only. Specifies roadblocking in a main companion lineitem.
+          "creativeRotationType": "A String", # Output only. Specifies strategy to use for selecting a creative when multiple creatives of the same size are available.
+          "deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.
+          "frequencyCap": [ # Output only. Specifies any frequency caps. Cannot be filtered within ListDealsRequest.
+            { # Message contains details about publisher-set frequency caps of the delivery.
+              "maxImpressions": 42, # The maximum number of impressions that can be served to a user within the specified time period.
+              "timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped.
+              "timeUnitsCount": 42, # The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped.
+            },
+          ],
+          "roadblockingType": "A String", # Output only. Specifies the roadblocking type in display creatives.
+        },
+        "description": "A String", # Output only. Free text description for the deal terms.
+        "displayName": "A String", # Output only. The name of the deal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the deal.
+        "eligibleSeatIds": [ # Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.
+          "A String",
+        ],
+        "estimatedGrossSpend": { # Represents an amount of money with its currency type. # Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly.
+          "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.
+        },
+        "flightEndTime": "A String", # Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not necessary for Private Auction deals.
+        "flightStartTime": "A String", # Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (for example, in milliseconds) will be truncated towards the start of time in seconds.
+        "mediaPlanner": { # Describes a single Media Planner account. # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. This field represents a media planner (For example, agency or big advertiser).
+          "accountId": "A String", # Output only. Account ID of the media planner.
+        },
+        "name": "A String", # Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}
+        "preferredDealTerms": { # Pricing terms for Preferred Deals. # The terms for preferred deals.
+          "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+            "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+              "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.
+            },
+            "type": "A String", # The pricing type for the deal.
+          },
+        },
+        "privateAuctionTerms": { # Pricing terms for Private Auctions. # The terms for private auction deals.
+          "floorPrice": { # Represents a price and a pricing type for a deal. # The minimum price buyer has to bid to compete in the private auction.
+            "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+              "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.
+            },
+            "type": "A String", # The pricing type for the deal.
+          },
+          "openAuctionAllowed": True or False, # Output only. True if open auction buyers are allowed to compete with invited buyers in this private auction.
+        },
+        "programmaticGuaranteedTerms": { # Pricing terms for Programmatic Guaranteed Deals. # The terms for programmatic guaranteed deals.
+          "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+            "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+              "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.
+            },
+            "type": "A String", # The pricing type for the deal.
+          },
+          "guaranteedLooks": "A String", # Count of guaranteed looks. For CPD deals, buyer changes to guaranteed_looks will be ignored.
+          "impressionCap": "A String", # The lifetime impression cap for CPM Sponsorship deals. Deal will stop serving when cap is reached.
+          "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.
+          "percentShareOfVoice": "A String", # For sponsorship deals, this is the percentage of the seller's eligible impressions that the deal will serve until the cap is reached. Valid value is within range 0~100.
+          "reservationType": "A String", # The reservation type for a Programmatic Guaranteed deal. This indicates whether the number of impressions is fixed, or a percent of available impressions. If not specified, the default reservation type is STANDARD.
+        },
+        "proposalRevision": "A String", # Output only. The revision number for the proposal and is the same value as proposal.proposal_revision. Each update to deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.
+        "publisherProfile": "A String", # Immutable. Reference to the seller on the deal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}`
+        "sellerTimeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Output only. Time zone of the seller used to mark the boundaries of a day for daypart targeting and CPD billing.
+          "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
+          "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+        },
+        "targeting": { # Targeting represents different criteria that can be used to target deals or auction packages. For example, they can choose to target inventory only if the user is in the US. Multiple types of targeting are always applied as a logical AND, unless noted otherwise. # Specifies the subset of inventory targeted by the deal. Can be updated by the buyer before the deal is finalized.
+          "daypartTargeting": { # Represents Daypart targeting. # Daypart targeting information.
+            "dayParts": [ # The targeted weekdays and times
+              { # Defines targeting for a period of time on a specific week day.
+                "dayOfWeek": "A String", # Day of week for the period.
+                "endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+                  "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+                  "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+                  "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+                  "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+                },
+                "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+                  "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+                  "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+                  "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+                  "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+                },
+              },
+            ],
+            "timeZoneType": "A String", # The time zone type of the day parts
+          },
+          "excludedSensitiveCategoryIds": [ # Output only. The sensitive content category label IDs excluded. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs.
+            "A String",
+          ],
+          "geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. Geo criteria IDs to be included/excluded.
+            "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+              "A String",
+            ],
+            "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+              "A String",
+            ],
+          },
+          "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on a bid request. # Output only. Inventory sizes to be included/excluded.
+            "excludedInventorySizes": [ # A list of inventory sizes to be excluded.
+              { # Represents size of a single ad slot, or a creative.
+                "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+                "type": "A String", # The type of the ad slot size.
+                "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+              },
+            ],
+            "targetedInventorySizes": [ # A list of inventory sizes to be included.
+              { # Represents size of a single ad slot, or a creative.
+                "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+                "type": "A String", # The type of the ad slot size.
+                "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+              },
+            ],
+          },
+          "inventoryTypeTargeting": { # Targeting of the inventory types a bid request can originate from. # Output only. Inventory type targeting information.
+            "inventoryTypes": [ # The list of targeted inventory types for the bid request.
+              "A String",
+            ],
+          },
+          "placementTargeting": { # Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Output only. Placement targeting information, for example, URL, mobile applications.
+            "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages.
+              "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in.
+                "excludedAppIds": [ # A list of application IDs to be excluded.
+                  "A String",
+                ],
+                "targetedAppIds": [ # A list of application IDs to be included.
+                  "A String",
+                ],
+              },
+            },
+            "uriTargeting": { # Represents a list of targeted and excluded URLs (for example, google.com). For Private Auction Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded.
+              "excludedUris": [ # A list of URLs to be excluded.
+                "A String",
+              ],
+              "targetedUris": [ # A list of URLs to be included.
+                "A String",
+              ],
+            },
+          },
+          "technologyTargeting": { # Represents targeting about various types of technology. # Output only. Technology targeting information, for example, operating system, device category.
+            "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device capabilities to be included/excluded.
+              "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+                "A String",
+              ],
+              "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+                "A String",
+              ],
+            },
+            "deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device categories to be included/excluded.
+              "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+                "A String",
+              ],
+              "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+                "A String",
+              ],
+            },
+            "operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.
+              "operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating systems to be included/excluded.
+                "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+                  "A String",
+                ],
+                "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+                  "A String",
+                ],
+              },
+              "operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating system versions to be included/excluded.
+                "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+                  "A String",
+                ],
+                "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+                  "A String",
+                ],
+              },
+            },
+          },
+          "userListTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Buyer user list targeting information. User lists can be uploaded using https://developers.google.com/authorized-buyers/rtb/bulk-uploader.
+            "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+              "A String",
+            ],
+            "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+              "A String",
+            ],
+          },
+          "verticalTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. The verticals included or excluded as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals
+            "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+              "A String",
+            ],
+            "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+              "A String",
+            ],
+          },
+          "videoTargeting": { # Represents targeting information about video. # Output only. Video targeting information.
+            "excludedPositionTypes": [ # A list of video positions to be excluded. When this field is populated, the targeted_position_types field must be empty.
+              "A String",
+            ],
+            "targetedPositionTypes": [ # A list of video positions to be included. When this field is populated, the excluded_position_types field must be empty.
+              "A String",
+            ],
+          },
+        },
+        "updateTime": "A String", # Output only. The time when the deal was last updated.
+      },
+      "dealPausingInfo": { # Information related to deal pausing. # Information related to deal pausing for the deal.
+        "pauseReason": "A String", # The reason for the pausing of the deal; empty for active deals.
+        "pauseRole": "A String", # The party that first paused the deal; unspecified for active deals.
+        "pausingConsented": True or False, # Whether pausing is consented between buyer and seller for the deal.
+      },
+      "dealServingStatus": "A String", # Serving status of the deal.
+      "name": "A String", # The resource name of the finalized deal. Format: `buyers/{accountId}/finalizedDeals/{finalizedDealId}`
+      "readyToServe": True or False, # Whether the Programmatic Guaranteed deal is ready for serving.
+      "rtbMetrics": { # Real-time bidding metrics. For what each metric means refer to [Report metrics](https://support.google.com/adxbuyer/answer/6115195#report-metrics) # Real-time bidding metrics for this deal.
+        "adImpressions7Days": "A String", # Ad impressions in last 7 days.
+        "bidRate7Days": 3.14, # Bid rate in last 7 days, calculated by (bids / bid requests).
+        "bidRequests7Days": "A String", # Bid requests in last 7 days.
+        "bids7Days": "A String", # Bids in last 7 days.
+        "filteredBidRate7Days": 3.14, # Filtered bid rate in last 7 days, calculated by (filtered bids / bids).
+        "mustBidRateCurrentMonth": 3.14, # Must bid rate for current month.
+      },
+    },
+  ],
+  "nextPageToken": "A String", # Token to fetch the next page of results.
+}
+
+ +
+ 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/authorizedbuyersmarketplace_v1alpha.bidders.html b/docs/dyn/authorizedbuyersmarketplace_v1alpha.bidders.html new file mode 100644 index 00000000000..48973331492 --- /dev/null +++ b/docs/dyn/authorizedbuyersmarketplace_v1alpha.bidders.html @@ -0,0 +1,96 @@ + + + +

Authorized Buyers Marketplace API . bidders

+

Instance Methods

+

+ auctionPackages() +

+

Returns the auctionPackages Resource.

+ +

+ finalizedDeals() +

+

Returns the finalizedDeals Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.auctionPackages.html b/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.auctionPackages.html new file mode 100644 index 00000000000..6e169cf72c4 --- /dev/null +++ b/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.auctionPackages.html @@ -0,0 +1,388 @@ + + + +

Authorized Buyers Marketplace API . buyers . auctionPackages

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Gets an auction package given its name.

+

+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

+

List the auction packages. Buyers can use the URL path "/v1alpha/buyers/{accountId}/auctionPackages" to list auction packages for the current buyer and its clients. Bidders can use the URL path "/v1alpha/bidders/{accountId}/auctionPackages" to list auction packages for the bidder, its media planners, its buyers, and all their clients.

+

+ list_next()

+

Retrieves the next page of results.

+

+ subscribe(name, body=None, x__xgafv=None)

+

Subscribe to the auction package for the specified buyer. Once subscribed, the bidder will receive a call out for inventory matching the auction package targeting criteria with the auction package deal ID and the specified buyer.

+

+ subscribeClients(auctionPackage, body=None, x__xgafv=None)

+

Subscribe the specified clients of the buyer to the auction package. If a client in the list does not belong to the buyer, an error response will be returned, and all of the following clients in the list will not be subscribed. Subscribing an already subscribed client will have no effect.

+

+ unsubscribe(name, body=None, x__xgafv=None)

+

Unsubscribe from the auction package for the specified buyer. Once unsubscribed, the bidder will no longer receive a call out for the auction package deal ID and the specified buyer.

+

+ unsubscribeClients(auctionPackage, body=None, x__xgafv=None)

+

Unsubscribe from the auction package for the specified clients of the buyer. Unsubscribing a client that is not subscribed will have no effect.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Gets an auction package given its name.
+
+Args:
+  name: string, Required. Name of auction package to get. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Defines a segment of inventory that buyer wants to buy. It's created by buyer and could be shared with multiple buyers.
+  "createTime": "A String", # Output only. Time the auction package was created.
+  "creator": "A String", # Output only. The buyer that created this auction package. Format: `buyers/{buyerAccountId}`
+  "description": "A String", # Output only. A description of the auction package.
+  "displayName": "A String", # The display_name assigned to the auction package.
+  "eligibleSeatIds": [ # Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.
+    "A String",
+  ],
+  "name": "A String", # Immutable. The unique identifier for the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}` The auction_package_id part of name is sent in the BidRequest to all RTB bidders and is returned as deal_id by the bidder in the BidResponse.
+  "subscribedBuyers": [ # Output only. The list of buyers that are subscribed to the AuctionPackage. This field is only populated when calling as a bidder. Format: `buyers/{buyerAccountId}`
+    "A String",
+  ],
+  "subscribedClients": [ # Output only. When calling as a buyer, the list of clients of the current buyer that are subscribed to the AuctionPackage. When calling as a bidder, the list of clients that are subscribed to the AuctionPackage owned by the bidder or its buyers. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}`
+    "A String",
+  ],
+  "subscribedMediaPlanners": [ # Output only. The list of media planners that are subscribed to the AuctionPackage. This field is only populated when calling as a bidder.
+    { # Describes a single Media Planner account.
+      "accountId": "A String", # Output only. Account ID of the media planner.
+    },
+  ],
+  "updateTime": "A String", # Output only. Time the auction package was last updated. This value is only increased when this auction package is updated but never when a buyer subscribed.
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
List the auction packages. Buyers can use the URL path "/v1alpha/buyers/{accountId}/auctionPackages" to list auction packages for the current buyer and its clients. Bidders can use the URL path "/v1alpha/bidders/{accountId}/auctionPackages" to list auction packages for the bidder, its media planners, its buyers, and all their clients.
+
+Args:
+  parent: string, Required. Name of the parent buyer that can access the auction package. Format: `buyers/{accountId}`. When used with a bidder account, the auction packages that the bidder, its media planners, its buyers and clients are subscribed to will be listed, in the format `bidders/{accountId}`. (required)
+  filter: string, Optional. Optional query string using the [Cloud API list filtering syntax](/authorized-buyers/apis/guides/list-filters). Only supported when parent is bidder. Supported columns for filtering are: * displayName * createTime * updateTime * eligibleSeatIds
+  orderBy: string, Optional. An optional query string to sort auction packages using the [Cloud API sorting syntax](https://cloud.google.com/apis/design/design_patterns#sorting_order). If no sort order is specified, results will be returned in an arbitrary order. Only supported when parent is bidder. Supported columns for sorting are: * displayName * createTime * updateTime
+  pageSize: integer, Requested page size. The server may return fewer results than requested. Max allowed page size is 500.
+  pageToken: string, The page token as returned. ListAuctionPackagesResponse.nextPageToken
+  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 listing auction packages.
+  "auctionPackages": [ # The list of auction packages.
+    { # Defines a segment of inventory that buyer wants to buy. It's created by buyer and could be shared with multiple buyers.
+      "createTime": "A String", # Output only. Time the auction package was created.
+      "creator": "A String", # Output only. The buyer that created this auction package. Format: `buyers/{buyerAccountId}`
+      "description": "A String", # Output only. A description of the auction package.
+      "displayName": "A String", # The display_name assigned to the auction package.
+      "eligibleSeatIds": [ # Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.
+        "A String",
+      ],
+      "name": "A String", # Immutable. The unique identifier for the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}` The auction_package_id part of name is sent in the BidRequest to all RTB bidders and is returned as deal_id by the bidder in the BidResponse.
+      "subscribedBuyers": [ # Output only. The list of buyers that are subscribed to the AuctionPackage. This field is only populated when calling as a bidder. Format: `buyers/{buyerAccountId}`
+        "A String",
+      ],
+      "subscribedClients": [ # Output only. When calling as a buyer, the list of clients of the current buyer that are subscribed to the AuctionPackage. When calling as a bidder, the list of clients that are subscribed to the AuctionPackage owned by the bidder or its buyers. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}`
+        "A String",
+      ],
+      "subscribedMediaPlanners": [ # Output only. The list of media planners that are subscribed to the AuctionPackage. This field is only populated when calling as a bidder.
+        { # Describes a single Media Planner account.
+          "accountId": "A String", # Output only. Account ID of the media planner.
+        },
+      ],
+      "updateTime": "A String", # Output only. Time the auction package was last updated. This value is only increased when this auction package is updated but never when a buyer subscribed.
+    },
+  ],
+  "nextPageToken": "A String", # Continuation token for fetching the next page of results. Pass this value in the ListAuctionPackagesRequest.pageToken field in the subsequent call to the `ListAuctionPackages` method to retrieve the next page of results.
+}
+
+ +
+ 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.
+        
+
+ +
+ subscribe(name, body=None, x__xgafv=None) +
Subscribe to the auction package for the specified buyer. Once subscribed, the bidder will receive a call out for inventory matching the auction package targeting criteria with the auction package deal ID and the specified buyer.
+
+Args:
+  name: string, Required. Name of the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for SubscribeAuctionPackage.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Defines a segment of inventory that buyer wants to buy. It's created by buyer and could be shared with multiple buyers.
+  "createTime": "A String", # Output only. Time the auction package was created.
+  "creator": "A String", # Output only. The buyer that created this auction package. Format: `buyers/{buyerAccountId}`
+  "description": "A String", # Output only. A description of the auction package.
+  "displayName": "A String", # The display_name assigned to the auction package.
+  "eligibleSeatIds": [ # Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.
+    "A String",
+  ],
+  "name": "A String", # Immutable. The unique identifier for the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}` The auction_package_id part of name is sent in the BidRequest to all RTB bidders and is returned as deal_id by the bidder in the BidResponse.
+  "subscribedBuyers": [ # Output only. The list of buyers that are subscribed to the AuctionPackage. This field is only populated when calling as a bidder. Format: `buyers/{buyerAccountId}`
+    "A String",
+  ],
+  "subscribedClients": [ # Output only. When calling as a buyer, the list of clients of the current buyer that are subscribed to the AuctionPackage. When calling as a bidder, the list of clients that are subscribed to the AuctionPackage owned by the bidder or its buyers. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}`
+    "A String",
+  ],
+  "subscribedMediaPlanners": [ # Output only. The list of media planners that are subscribed to the AuctionPackage. This field is only populated when calling as a bidder.
+    { # Describes a single Media Planner account.
+      "accountId": "A String", # Output only. Account ID of the media planner.
+    },
+  ],
+  "updateTime": "A String", # Output only. Time the auction package was last updated. This value is only increased when this auction package is updated but never when a buyer subscribed.
+}
+
+ +
+ subscribeClients(auctionPackage, body=None, x__xgafv=None) +
Subscribe the specified clients of the buyer to the auction package. If a client in the list does not belong to the buyer, an error response will be returned, and all of the following clients in the list will not be subscribed. Subscribing an already subscribed client will have no effect.
+
+Args:
+  auctionPackage: string, Required. Name of the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for SubscribeAuctionPackageClients.
+  "clients": [ # Optional. A list of client buyers to subscribe to the auction package, with client buyer in the format `buyers/{accountId}/clients/{clientAccountId}`. The current buyer will be subscribed to the auction package regardless of the list contents if not already.
+    "A String",
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Defines a segment of inventory that buyer wants to buy. It's created by buyer and could be shared with multiple buyers.
+  "createTime": "A String", # Output only. Time the auction package was created.
+  "creator": "A String", # Output only. The buyer that created this auction package. Format: `buyers/{buyerAccountId}`
+  "description": "A String", # Output only. A description of the auction package.
+  "displayName": "A String", # The display_name assigned to the auction package.
+  "eligibleSeatIds": [ # Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.
+    "A String",
+  ],
+  "name": "A String", # Immutable. The unique identifier for the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}` The auction_package_id part of name is sent in the BidRequest to all RTB bidders and is returned as deal_id by the bidder in the BidResponse.
+  "subscribedBuyers": [ # Output only. The list of buyers that are subscribed to the AuctionPackage. This field is only populated when calling as a bidder. Format: `buyers/{buyerAccountId}`
+    "A String",
+  ],
+  "subscribedClients": [ # Output only. When calling as a buyer, the list of clients of the current buyer that are subscribed to the AuctionPackage. When calling as a bidder, the list of clients that are subscribed to the AuctionPackage owned by the bidder or its buyers. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}`
+    "A String",
+  ],
+  "subscribedMediaPlanners": [ # Output only. The list of media planners that are subscribed to the AuctionPackage. This field is only populated when calling as a bidder.
+    { # Describes a single Media Planner account.
+      "accountId": "A String", # Output only. Account ID of the media planner.
+    },
+  ],
+  "updateTime": "A String", # Output only. Time the auction package was last updated. This value is only increased when this auction package is updated but never when a buyer subscribed.
+}
+
+ +
+ unsubscribe(name, body=None, x__xgafv=None) +
Unsubscribe from the auction package for the specified buyer. Once unsubscribed, the bidder will no longer receive a call out for the auction package deal ID and the specified buyer.
+
+Args:
+  name: string, Required. Name of the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for UnsubscribeAuctionPackage.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Defines a segment of inventory that buyer wants to buy. It's created by buyer and could be shared with multiple buyers.
+  "createTime": "A String", # Output only. Time the auction package was created.
+  "creator": "A String", # Output only. The buyer that created this auction package. Format: `buyers/{buyerAccountId}`
+  "description": "A String", # Output only. A description of the auction package.
+  "displayName": "A String", # The display_name assigned to the auction package.
+  "eligibleSeatIds": [ # Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.
+    "A String",
+  ],
+  "name": "A String", # Immutable. The unique identifier for the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}` The auction_package_id part of name is sent in the BidRequest to all RTB bidders and is returned as deal_id by the bidder in the BidResponse.
+  "subscribedBuyers": [ # Output only. The list of buyers that are subscribed to the AuctionPackage. This field is only populated when calling as a bidder. Format: `buyers/{buyerAccountId}`
+    "A String",
+  ],
+  "subscribedClients": [ # Output only. When calling as a buyer, the list of clients of the current buyer that are subscribed to the AuctionPackage. When calling as a bidder, the list of clients that are subscribed to the AuctionPackage owned by the bidder or its buyers. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}`
+    "A String",
+  ],
+  "subscribedMediaPlanners": [ # Output only. The list of media planners that are subscribed to the AuctionPackage. This field is only populated when calling as a bidder.
+    { # Describes a single Media Planner account.
+      "accountId": "A String", # Output only. Account ID of the media planner.
+    },
+  ],
+  "updateTime": "A String", # Output only. Time the auction package was last updated. This value is only increased when this auction package is updated but never when a buyer subscribed.
+}
+
+ +
+ unsubscribeClients(auctionPackage, body=None, x__xgafv=None) +
Unsubscribe from the auction package for the specified clients of the buyer. Unsubscribing a client that is not subscribed will have no effect.
+
+Args:
+  auctionPackage: string, Required. Name of the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for UnsubscribeAuctionPackage.
+  "clients": [ # Optional. A list of client buyers to unsubscribe from the auction package, with client buyer in the format `buyers/{accountId}/clients/{clientAccountId}`.
+    "A String",
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Defines a segment of inventory that buyer wants to buy. It's created by buyer and could be shared with multiple buyers.
+  "createTime": "A String", # Output only. Time the auction package was created.
+  "creator": "A String", # Output only. The buyer that created this auction package. Format: `buyers/{buyerAccountId}`
+  "description": "A String", # Output only. A description of the auction package.
+  "displayName": "A String", # The display_name assigned to the auction package.
+  "eligibleSeatIds": [ # Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.
+    "A String",
+  ],
+  "name": "A String", # Immutable. The unique identifier for the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}` The auction_package_id part of name is sent in the BidRequest to all RTB bidders and is returned as deal_id by the bidder in the BidResponse.
+  "subscribedBuyers": [ # Output only. The list of buyers that are subscribed to the AuctionPackage. This field is only populated when calling as a bidder. Format: `buyers/{buyerAccountId}`
+    "A String",
+  ],
+  "subscribedClients": [ # Output only. When calling as a buyer, the list of clients of the current buyer that are subscribed to the AuctionPackage. When calling as a bidder, the list of clients that are subscribed to the AuctionPackage owned by the bidder or its buyers. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}`
+    "A String",
+  ],
+  "subscribedMediaPlanners": [ # Output only. The list of media planners that are subscribed to the AuctionPackage. This field is only populated when calling as a bidder.
+    { # Describes a single Media Planner account.
+      "accountId": "A String", # Output only. Account ID of the media planner.
+    },
+  ],
+  "updateTime": "A String", # Output only. Time the auction package was last updated. This value is only increased when this auction package is updated but never when a buyer subscribed.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.clients.html b/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.clients.html new file mode 100644 index 00000000000..76696aa4535 --- /dev/null +++ b/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.clients.html @@ -0,0 +1,315 @@ + + + +

Authorized Buyers Marketplace API . buyers . clients

+

Instance Methods

+

+ users() +

+

Returns the users Resource.

+ +

+ activate(name, body=None, x__xgafv=None)

+

Activates an existing client. The state of the client will be updated to "ACTIVE". This method has no effect if the client is already in "ACTIVE" state.

+

+ close()

+

Close httplib2 connections.

+

+ create(parent, body=None, x__xgafv=None)

+

Creates a new client.

+

+ deactivate(name, body=None, x__xgafv=None)

+

Deactivates an existing client. The state of the client will be updated to "INACTIVE". This method has no effect if the client is already in "INACTIVE" state.

+

+ get(name, x__xgafv=None)

+

Gets a client with a given resource name.

+

+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists all the clients for the current buyer.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(name, body=None, updateMask=None, x__xgafv=None)

+

Updates an existing client.

+

Method Details

+
+ activate(name, body=None, x__xgafv=None) +
Activates an existing client. The state of the client will be updated to "ACTIVE". This method has no effect if the client is already in "ACTIVE" state.
+
+Args:
+  name: string, Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for activating a client.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A client represents an agency, a brand, or an advertiser customer of the buyer. Based on the client's role, its client users will have varying levels of restricted access to the Marketplace and certain other sections of the Authorized Buyers UI.
+  "displayName": "A String", # Required. Display name shown to publishers. Must be unique for clients without partnerClientId specified. Maximum length of 255 characters is allowed.
+  "name": "A String", # Output only. The resource name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}`
+  "partnerClientId": "A String", # Arbitrary unique identifier provided by the buyer. This field can be used to associate a client with an identifier in the namespace of the buyer, lookup clients by that identifier and verify whether an Authorized Buyers account of the client already exists. If present, must be unique across all the clients.
+  "role": "A String", # Required. The role assigned to the client. Each role implies a set of permissions granted to the client.
+  "sellerVisible": True or False, # Whether the client will be visible to sellers.
+  "state": "A String", # Output only. The state of the client.
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) +
Creates a new client.
+
+Args:
+  parent: string, Required. The name of the buyer. Format: `buyers/{accountId}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A client represents an agency, a brand, or an advertiser customer of the buyer. Based on the client's role, its client users will have varying levels of restricted access to the Marketplace and certain other sections of the Authorized Buyers UI.
+  "displayName": "A String", # Required. Display name shown to publishers. Must be unique for clients without partnerClientId specified. Maximum length of 255 characters is allowed.
+  "name": "A String", # Output only. The resource name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}`
+  "partnerClientId": "A String", # Arbitrary unique identifier provided by the buyer. This field can be used to associate a client with an identifier in the namespace of the buyer, lookup clients by that identifier and verify whether an Authorized Buyers account of the client already exists. If present, must be unique across all the clients.
+  "role": "A String", # Required. The role assigned to the client. Each role implies a set of permissions granted to the client.
+  "sellerVisible": True or False, # Whether the client will be visible to sellers.
+  "state": "A String", # Output only. The state of the client.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A client represents an agency, a brand, or an advertiser customer of the buyer. Based on the client's role, its client users will have varying levels of restricted access to the Marketplace and certain other sections of the Authorized Buyers UI.
+  "displayName": "A String", # Required. Display name shown to publishers. Must be unique for clients without partnerClientId specified. Maximum length of 255 characters is allowed.
+  "name": "A String", # Output only. The resource name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}`
+  "partnerClientId": "A String", # Arbitrary unique identifier provided by the buyer. This field can be used to associate a client with an identifier in the namespace of the buyer, lookup clients by that identifier and verify whether an Authorized Buyers account of the client already exists. If present, must be unique across all the clients.
+  "role": "A String", # Required. The role assigned to the client. Each role implies a set of permissions granted to the client.
+  "sellerVisible": True or False, # Whether the client will be visible to sellers.
+  "state": "A String", # Output only. The state of the client.
+}
+
+ +
+ deactivate(name, body=None, x__xgafv=None) +
Deactivates an existing client. The state of the client will be updated to "INACTIVE". This method has no effect if the client is already in "INACTIVE" state.
+
+Args:
+  name: string, Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for disabling a client.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A client represents an agency, a brand, or an advertiser customer of the buyer. Based on the client's role, its client users will have varying levels of restricted access to the Marketplace and certain other sections of the Authorized Buyers UI.
+  "displayName": "A String", # Required. Display name shown to publishers. Must be unique for clients without partnerClientId specified. Maximum length of 255 characters is allowed.
+  "name": "A String", # Output only. The resource name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}`
+  "partnerClientId": "A String", # Arbitrary unique identifier provided by the buyer. This field can be used to associate a client with an identifier in the namespace of the buyer, lookup clients by that identifier and verify whether an Authorized Buyers account of the client already exists. If present, must be unique across all the clients.
+  "role": "A String", # Required. The role assigned to the client. Each role implies a set of permissions granted to the client.
+  "sellerVisible": True or False, # Whether the client will be visible to sellers.
+  "state": "A String", # Output only. The state of the client.
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets a client with a given resource name.
+
+Args:
+  name: string, Required. Format: `buyers/{accountId}/clients/{clientAccountId}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A client represents an agency, a brand, or an advertiser customer of the buyer. Based on the client's role, its client users will have varying levels of restricted access to the Marketplace and certain other sections of the Authorized Buyers UI.
+  "displayName": "A String", # Required. Display name shown to publishers. Must be unique for clients without partnerClientId specified. Maximum length of 255 characters is allowed.
+  "name": "A String", # Output only. The resource name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}`
+  "partnerClientId": "A String", # Arbitrary unique identifier provided by the buyer. This field can be used to associate a client with an identifier in the namespace of the buyer, lookup clients by that identifier and verify whether an Authorized Buyers account of the client already exists. If present, must be unique across all the clients.
+  "role": "A String", # Required. The role assigned to the client. Each role implies a set of permissions granted to the client.
+  "sellerVisible": True or False, # Whether the client will be visible to sellers.
+  "state": "A String", # Output only. The state of the client.
+}
+
+ +
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists all the clients for the current buyer.
+
+Args:
+  parent: string, Required. The name of the buyer. Format: `buyers/{accountId}` (required)
+  filter: string, Query string using the [Filtering Syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) Supported fields for filtering are: * partnerClientId Use this field to filter the clients by the partnerClientId. For example, if the partnerClientId of the client is "1234", the value of this field should be `partnerClientId = "1234"`, in order to get only the client whose partnerClientId is "1234" in the response.
+  pageSize: integer, Requested page size. If left blank, a default page size of 500 will be applied.
+  pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of ListClientsResponse.nextPageToken returned from the previous call to the list method.
+  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 the list method.
+  "clients": [ # The returned list of clients.
+    { # A client represents an agency, a brand, or an advertiser customer of the buyer. Based on the client's role, its client users will have varying levels of restricted access to the Marketplace and certain other sections of the Authorized Buyers UI.
+      "displayName": "A String", # Required. Display name shown to publishers. Must be unique for clients without partnerClientId specified. Maximum length of 255 characters is allowed.
+      "name": "A String", # Output only. The resource name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}`
+      "partnerClientId": "A String", # Arbitrary unique identifier provided by the buyer. This field can be used to associate a client with an identifier in the namespace of the buyer, lookup clients by that identifier and verify whether an Authorized Buyers account of the client already exists. If present, must be unique across all the clients.
+      "role": "A String", # Required. The role assigned to the client. Each role implies a set of permissions granted to the client.
+      "sellerVisible": True or False, # Whether the client will be visible to sellers.
+      "state": "A String", # Output only. The state of the client.
+    },
+  ],
+  "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the ListClientsRequest.pageToken field in the subsequent call to the list method to retrieve the next page of results.
+}
+
+ +
+ 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, body=None, updateMask=None, x__xgafv=None) +
Updates an existing client.
+
+Args:
+  name: string, Output only. The resource name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A client represents an agency, a brand, or an advertiser customer of the buyer. Based on the client's role, its client users will have varying levels of restricted access to the Marketplace and certain other sections of the Authorized Buyers UI.
+  "displayName": "A String", # Required. Display name shown to publishers. Must be unique for clients without partnerClientId specified. Maximum length of 255 characters is allowed.
+  "name": "A String", # Output only. The resource name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}`
+  "partnerClientId": "A String", # Arbitrary unique identifier provided by the buyer. This field can be used to associate a client with an identifier in the namespace of the buyer, lookup clients by that identifier and verify whether an Authorized Buyers account of the client already exists. If present, must be unique across all the clients.
+  "role": "A String", # Required. The role assigned to the client. Each role implies a set of permissions granted to the client.
+  "sellerVisible": True or False, # Whether the client will be visible to sellers.
+  "state": "A String", # Output only. The state of the client.
+}
+
+  updateMask: string, List of fields to be updated. If empty or unspecified, the service will update all fields populated in the update request excluding the output only fields and primitive fields with default value. Note that explicit field mask is required in order to reset a primitive field back to its default value, for example, false for boolean fields, 0 for integer fields. A special field mask consisting of a single path "*" can be used to indicate full replacement(the equivalent of PUT method), updatable fields unset or unspecified in the input will be cleared or set to default value. Output only fields will be ignored regardless of the value of updateMask.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A client represents an agency, a brand, or an advertiser customer of the buyer. Based on the client's role, its client users will have varying levels of restricted access to the Marketplace and certain other sections of the Authorized Buyers UI.
+  "displayName": "A String", # Required. Display name shown to publishers. Must be unique for clients without partnerClientId specified. Maximum length of 255 characters is allowed.
+  "name": "A String", # Output only. The resource name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}`
+  "partnerClientId": "A String", # Arbitrary unique identifier provided by the buyer. This field can be used to associate a client with an identifier in the namespace of the buyer, lookup clients by that identifier and verify whether an Authorized Buyers account of the client already exists. If present, must be unique across all the clients.
+  "role": "A String", # Required. The role assigned to the client. Each role implies a set of permissions granted to the client.
+  "sellerVisible": True or False, # Whether the client will be visible to sellers.
+  "state": "A String", # Output only. The state of the client.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.clients.users.html b/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.clients.users.html new file mode 100644 index 00000000000..6d95bba3457 --- /dev/null +++ b/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.clients.users.html @@ -0,0 +1,272 @@ + + + +

Authorized Buyers Marketplace API . buyers . clients . users

+

Instance Methods

+

+ activate(name, body=None, x__xgafv=None)

+

Activates an existing client user. The state of the client user will be updated from "INACTIVE" to "ACTIVE". This method has no effect if the client user is already in "ACTIVE" state. An error will be returned if the client user to activate is still in "INVITED" state.

+

+ close()

+

Close httplib2 connections.

+

+ create(parent, body=None, x__xgafv=None)

+

Creates a new client user in "INVITED" state. An email invitation will be sent to the new user, once accepted the user will become active.

+

+ deactivate(name, body=None, x__xgafv=None)

+

Deactivates an existing client user. The state of the client user will be updated from "ACTIVE" to "INACTIVE". This method has no effect if the client user is already in "INACTIVE" state. An error will be returned if the client user to deactivate is still in "INVITED" state.

+

+ delete(name, x__xgafv=None)

+

Deletes an existing client user. The client user will lose access to the Authorized Buyers UI. Note that if a client user is deleted, the user's access to the UI can't be restored unless a new client user is created and activated.

+

+ get(name, x__xgafv=None)

+

Retrieves an existing client user.

+

+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists all client users for a specified client.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ activate(name, body=None, x__xgafv=None) +
Activates an existing client user. The state of the client user will be updated from "INACTIVE" to "ACTIVE". This method has no effect if the client user is already in "ACTIVE" state. An error will be returned if the client user to activate is still in "INVITED" state.
+
+Args:
+  name: string, Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}/clientUsers/{userId}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for activating a client user.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A user of a client who has restricted access to the Marketplace and certain other sections of the Authorized Buyers UI based on the role granted to the associated client.
+  "email": "A String", # Required. The client user's email address that has to be unique across all users for the same client.
+  "name": "A String", # Output only. The resource name of the client user. Format: `buyers/{accountId}/clients/{clientAccountId}/users/{userId}`
+  "state": "A String", # Output only. The state of the client user.
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) +
Creates a new client user in "INVITED" state. An email invitation will be sent to the new user, once accepted the user will become active.
+
+Args:
+  parent: string, Required. The name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A user of a client who has restricted access to the Marketplace and certain other sections of the Authorized Buyers UI based on the role granted to the associated client.
+  "email": "A String", # Required. The client user's email address that has to be unique across all users for the same client.
+  "name": "A String", # Output only. The resource name of the client user. Format: `buyers/{accountId}/clients/{clientAccountId}/users/{userId}`
+  "state": "A String", # Output only. The state of the client user.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A user of a client who has restricted access to the Marketplace and certain other sections of the Authorized Buyers UI based on the role granted to the associated client.
+  "email": "A String", # Required. The client user's email address that has to be unique across all users for the same client.
+  "name": "A String", # Output only. The resource name of the client user. Format: `buyers/{accountId}/clients/{clientAccountId}/users/{userId}`
+  "state": "A String", # Output only. The state of the client user.
+}
+
+ +
+ deactivate(name, body=None, x__xgafv=None) +
Deactivates an existing client user. The state of the client user will be updated from "ACTIVE" to "INACTIVE". This method has no effect if the client user is already in "INACTIVE" state. An error will be returned if the client user to deactivate is still in "INVITED" state.
+
+Args:
+  name: string, Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}/clientUsers/{userId}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for deactivating a client user.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A user of a client who has restricted access to the Marketplace and certain other sections of the Authorized Buyers UI based on the role granted to the associated client.
+  "email": "A String", # Required. The client user's email address that has to be unique across all users for the same client.
+  "name": "A String", # Output only. The resource name of the client user. Format: `buyers/{accountId}/clients/{clientAccountId}/users/{userId}`
+  "state": "A String", # Output only. The state of the client user.
+}
+
+ +
+ delete(name, x__xgafv=None) +
Deletes an existing client user. The client user will lose access to the Authorized Buyers UI. Note that if a client user is deleted, the user's access to the UI can't be restored unless a new client user is created and activated.
+
+Args:
+  name: string, Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}/clientUsers/{userId}` (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) +
Retrieves an existing client user.
+
+Args:
+  name: string, Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}/clientUsers/{userId}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A user of a client who has restricted access to the Marketplace and certain other sections of the Authorized Buyers UI based on the role granted to the associated client.
+  "email": "A String", # Required. The client user's email address that has to be unique across all users for the same client.
+  "name": "A String", # Output only. The resource name of the client user. Format: `buyers/{accountId}/clients/{clientAccountId}/users/{userId}`
+  "state": "A String", # Output only. The state of the client user.
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Lists all client users for a specified client.
+
+Args:
+  parent: string, Required. The name of the client. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}` (required)
+  pageSize: integer, Requested page size. If left blank, a default page size of 500 will be applied.
+  pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of ListClientUsersResponse.nextPageToken returned from the previous call to the list method.
+  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 the list method.
+  "clientUsers": [ # The returned list of client users.
+    { # A user of a client who has restricted access to the Marketplace and certain other sections of the Authorized Buyers UI based on the role granted to the associated client.
+      "email": "A String", # Required. The client user's email address that has to be unique across all users for the same client.
+      "name": "A String", # Output only. The resource name of the client user. Format: `buyers/{accountId}/clients/{clientAccountId}/users/{userId}`
+      "state": "A String", # Output only. The state of the client user.
+    },
+  ],
+  "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the ListClientUsersRequest.pageToken field in the subsequent call to the list method to retrieve the next page of results.
+}
+
+ +
+ 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/authorizedbuyersmarketplace_v1alpha.buyers.dataSegments.html b/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.dataSegments.html new file mode 100644 index 00000000000..20c834f345c --- /dev/null +++ b/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.dataSegments.html @@ -0,0 +1,333 @@ + + + +

Authorized Buyers Marketplace API . buyers . dataSegments

+

Instance Methods

+

+ activate(name, body=None, x__xgafv=None)

+

Activates a data segment.

+

+ close()

+

Close httplib2 connections.

+

+ create(parent, body=None, x__xgafv=None)

+

Creates a data segment owned by the listed curator. The data segment will be created in the `ACTIVE` state, meaning it will be immediately available for buyers to use in preferred deals, private auction deals, and auction packages.

+

+ deactivate(name, body=None, x__xgafv=None)

+

Deactivates a data segment.

+

+ get(name, x__xgafv=None)

+

Gets a data segment given its name.

+

+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)

+

List the data segments owned by a curator.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(name, body=None, updateMask=None, x__xgafv=None)

+

Updates a data segment.

+

Method Details

+
+ activate(name, body=None, x__xgafv=None) +
Activates a data segment.
+
+Args:
+  name: string, Required. Name of data segment to activate. Format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for activating a data segment
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms.
+  "cpmFee": { # Represents an amount of money with its currency type. # Optional. This will be charged when other accounts use this data segment. For example, when other accounts add this data segment to a deal or auction package.
+    "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.
+  },
+  "createTime": "A String", # Output only. Time the data segment was created.
+  "name": "A String", # Immutable. Identifier. The unique identifier for the data segment. Account ID corresponds to the account ID that created the segment. Format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}`
+  "state": "A String", # Output only. The state of the data segment.
+  "updateTime": "A String", # Output only. Time the data segment was last updated.
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) +
Creates a data segment owned by the listed curator. The data segment will be created in the `ACTIVE` state, meaning it will be immediately available for buyers to use in preferred deals, private auction deals, and auction packages.
+
+Args:
+  parent: string, Required. The parent resource where this data segment will be created. Format: `buyers/{accountId}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms.
+  "cpmFee": { # Represents an amount of money with its currency type. # Optional. This will be charged when other accounts use this data segment. For example, when other accounts add this data segment to a deal or auction package.
+    "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.
+  },
+  "createTime": "A String", # Output only. Time the data segment was created.
+  "name": "A String", # Immutable. Identifier. The unique identifier for the data segment. Account ID corresponds to the account ID that created the segment. Format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}`
+  "state": "A String", # Output only. The state of the data segment.
+  "updateTime": "A String", # Output only. Time the data segment was last updated.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms.
+  "cpmFee": { # Represents an amount of money with its currency type. # Optional. This will be charged when other accounts use this data segment. For example, when other accounts add this data segment to a deal or auction package.
+    "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.
+  },
+  "createTime": "A String", # Output only. Time the data segment was created.
+  "name": "A String", # Immutable. Identifier. The unique identifier for the data segment. Account ID corresponds to the account ID that created the segment. Format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}`
+  "state": "A String", # Output only. The state of the data segment.
+  "updateTime": "A String", # Output only. Time the data segment was last updated.
+}
+
+ +
+ deactivate(name, body=None, x__xgafv=None) +
Deactivates a data segment.
+
+Args:
+  name: string, Required. Name of data segment to deactivate. Format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for deactivating a data segment
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms.
+  "cpmFee": { # Represents an amount of money with its currency type. # Optional. This will be charged when other accounts use this data segment. For example, when other accounts add this data segment to a deal or auction package.
+    "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.
+  },
+  "createTime": "A String", # Output only. Time the data segment was created.
+  "name": "A String", # Immutable. Identifier. The unique identifier for the data segment. Account ID corresponds to the account ID that created the segment. Format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}`
+  "state": "A String", # Output only. The state of the data segment.
+  "updateTime": "A String", # Output only. Time the data segment was last updated.
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets a data segment given its name.
+
+Args:
+  name: string, Required. Name of data segment to get. Format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms.
+  "cpmFee": { # Represents an amount of money with its currency type. # Optional. This will be charged when other accounts use this data segment. For example, when other accounts add this data segment to a deal or auction package.
+    "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.
+  },
+  "createTime": "A String", # Output only. Time the data segment was created.
+  "name": "A String", # Immutable. Identifier. The unique identifier for the data segment. Account ID corresponds to the account ID that created the segment. Format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}`
+  "state": "A String", # Output only. The state of the data segment.
+  "updateTime": "A String", # Output only. Time the data segment was last updated.
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
List the data segments owned by a curator.
+
+Args:
+  parent: string, Required. Name of the parent buyer that can access the data segment. Format: `buyers/{accountId}` (required)
+  pageSize: integer, Optional. Requested page size. The server may return fewer results than requested. Max allowed page size is 500. If unspecified, the server will default to 500.
+  pageToken: string, Optional. The page token as returned. ListDataSegmentsResponse.nextPageToken
+  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 listing data segments.
+  "dataSegments": [ # The list of data segments.
+    { # Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms.
+      "cpmFee": { # Represents an amount of money with its currency type. # Optional. This will be charged when other accounts use this data segment. For example, when other accounts add this data segment to a deal or auction package.
+        "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.
+      },
+      "createTime": "A String", # Output only. Time the data segment was created.
+      "name": "A String", # Immutable. Identifier. The unique identifier for the data segment. Account ID corresponds to the account ID that created the segment. Format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}`
+      "state": "A String", # Output only. The state of the data segment.
+      "updateTime": "A String", # Output only. Time the data segment was last updated.
+    },
+  ],
+  "nextPageToken": "A String", # Continuation token for fetching the next page of results. Pass this value in the ListDataSegmentsRequest.pageToken field in the subsequent call to the `ListDataSegments` method to retrieve the next page of results.
+}
+
+ +
+ 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, body=None, updateMask=None, x__xgafv=None) +
Updates a data segment.
+
+Args:
+  name: string, Immutable. Identifier. The unique identifier for the data segment. Account ID corresponds to the account ID that created the segment. Format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms.
+  "cpmFee": { # Represents an amount of money with its currency type. # Optional. This will be charged when other accounts use this data segment. For example, when other accounts add this data segment to a deal or auction package.
+    "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.
+  },
+  "createTime": "A String", # Output only. Time the data segment was created.
+  "name": "A String", # Immutable. Identifier. The unique identifier for the data segment. Account ID corresponds to the account ID that created the segment. Format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}`
+  "state": "A String", # Output only. The state of the data segment.
+  "updateTime": "A String", # Output only. Time the data segment was last updated.
+}
+
+  updateMask: string, Optional. List of fields to be updated. If empty or unspecified, the service will update all fields populated in the update request excluding the output only fields and primitive fields with default value. Note that explicit field mask is required in order to reset a primitive field back to its default value, for example, false for boolean fields, 0 for integer fields. A special field mask consisting of a single path "*" can be used to indicate full replacement(the equivalent of PUT method), updatable fields unset or unspecified in the input will be cleared or set to default value. Output only fields will be ignored regardless of the value of updateMask.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms.
+  "cpmFee": { # Represents an amount of money with its currency type. # Optional. This will be charged when other accounts use this data segment. For example, when other accounts add this data segment to a deal or auction package.
+    "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.
+  },
+  "createTime": "A String", # Output only. Time the data segment was created.
+  "name": "A String", # Immutable. Identifier. The unique identifier for the data segment. Account ID corresponds to the account ID that created the segment. Format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}`
+  "state": "A String", # Output only. The state of the data segment.
+  "updateTime": "A String", # Output only. Time the data segment was last updated.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.finalizedDeals.html b/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.finalizedDeals.html new file mode 100644 index 00000000000..e491e3c0a1e --- /dev/null +++ b/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.finalizedDeals.html @@ -0,0 +1,1686 @@ + + + +

Authorized Buyers Marketplace API . buyers . finalizedDeals

+

Instance Methods

+

+ addCreative(deal, body=None, x__xgafv=None)

+

Add creative to be used in the bidding process for a finalized deal. For programmatic guaranteed deals, it's recommended that you associate at least one approved creative with the deal before calling SetReadyToServe, to help reduce the number of bid responses filtered because they don't contain approved creatives. Creatives successfully added to a deal can be found in the Realtime-bidding Creatives API creative.deal_ids. This method only applies to programmatic guaranteed deals. Maximum number of 1000 creatives can be added to a finalized deal.

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Gets a finalized deal given its name.

+

+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists finalized deals. Use the URL path "/v1alpha/buyers/{accountId}/finalizedDeals" to list finalized deals for the current buyer and its clients. Bidders can use the URL path "/v1alpha/bidders/{accountId}/finalizedDeals" to list finalized deals for the bidder, its buyers and all their clients.

+

+ list_next()

+

Retrieves the next page of results.

+

+ pause(name, body=None, x__xgafv=None)

+

Pauses serving of the given finalized deal. This call only pauses the serving status, and does not affect other fields of the finalized deal. Calling this method for an already paused deal has no effect. This method only applies to programmatic guaranteed deals and preferred deals.

+

+ resume(name, body=None, x__xgafv=None)

+

Resumes serving of the given finalized deal. Calling this method for an running deal has no effect. If a deal is initially paused by the seller, calling this method will not resume serving of the deal until the seller also resumes the deal. This method only applies to programmatic guaranteed deals and preferred deals.

+

+ setReadyToServe(deal, body=None, x__xgafv=None)

+

Sets the given finalized deal as ready to serve. By default, deals are set as ready to serve as soon as they're finalized. If you want to opt out of the default behavior, and manually indicate that deals are ready to serve, ask your Technical Account Manager to add you to the allowlist. If you choose to use this method, finalized deals belonging to the bidder and its child seats don't start serving until after you call `setReadyToServe`, and after the deals become active. For example, you can use this method to delay receiving bid requests until your creative is ready. This method only applies to programmatic guaranteed deals.

+

Method Details

+
+ addCreative(deal, body=None, x__xgafv=None) +
Add creative to be used in the bidding process for a finalized deal. For programmatic guaranteed deals, it's recommended that you associate at least one approved creative with the deal before calling SetReadyToServe, to help reduce the number of bid responses filtered because they don't contain approved creatives. Creatives successfully added to a deal can be found in the Realtime-bidding Creatives API creative.deal_ids. This method only applies to programmatic guaranteed deals. Maximum number of 1000 creatives can be added to a finalized deal.
+
+Args:
+  deal: string, Required. Name of the finalized deal in the format of: `buyers/{accountId}/finalizedDeals/{dealId}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for adding creative to be used in the bidding process for the finalized deal.
+  "creative": "A String", # Name of the creative to add to the finalized deal, in the format `buyers/{buyerAccountId}/creatives/{creativeId}`. See creative.name.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A finalized deal is a snapshot of the deal when both buyer and seller accept the deal. The buyer or seller can update the deal after it's been finalized and renegotiate on the deal targeting, terms and other fields, while at the same time the finalized snapshot of the deal can still be retrieved using this API. The finalized deal contains a copy of the deal as it existed when most recently finalized, as well as fields related to deal serving such as pause/resume status, RTB metrics, and more.
+  "deal": { # A deal represents a segment of inventory for displaying ads that contains the terms and targeting information that is used for serving as well as the deal stats and status. Note: A proposal may contain multiple deals. # A copy of the Deal made upon finalization. During renegotiation, this will reflect the last finalized deal before renegotiation was initiated.
+    "billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer; when the deal belongs to a media planner account, this field will be empty. Format : `buyers/{buyerAccountId}`
+    "buyer": "A String", # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. Format: `buyers/{buyerAccountId}`
+    "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+    "createTime": "A String", # Output only. The time of the deal creation.
+    "creativeRequirements": { # Message captures data about the creatives in the deal. # Output only. Metadata about the creatives of this deal.
+      "creativeFormat": "A String", # Output only. The format of the creative, only applicable for programmatic guaranteed and preferred deals.
+      "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.
+      "creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.
+      "maxAdDurationMs": "A String", # Output only. The max duration of the video creative in milliseconds. only applicable for deals with video creatives.
+      "programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by the buyer.
+      "skippableAdType": "A String", # Output only. Skippable video ads allow viewers to skip ads after 5 seconds. Only applicable for deals with video creatives.
+    },
+    "dealType": "A String", # Output only. Type of deal.
+    "deliveryControl": { # Message contains details about how the deal will be paced. # Output only. Specifies the pacing set by the publisher.
+      "companionDeliveryType": "A String", # Output only. Specifies roadblocking in a main companion lineitem.
+      "creativeRotationType": "A String", # Output only. Specifies strategy to use for selecting a creative when multiple creatives of the same size are available.
+      "deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.
+      "frequencyCap": [ # Output only. Specifies any frequency caps. Cannot be filtered within ListDealsRequest.
+        { # Message contains details about publisher-set frequency caps of the delivery.
+          "maxImpressions": 42, # The maximum number of impressions that can be served to a user within the specified time period.
+          "timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped.
+          "timeUnitsCount": 42, # The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped.
+        },
+      ],
+      "roadblockingType": "A String", # Output only. Specifies the roadblocking type in display creatives.
+    },
+    "description": "A String", # Output only. Free text description for the deal terms.
+    "displayName": "A String", # Output only. The name of the deal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the deal.
+    "eligibleSeatIds": [ # Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.
+      "A String",
+    ],
+    "estimatedGrossSpend": { # Represents an amount of money with its currency type. # Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly.
+      "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.
+    },
+    "flightEndTime": "A String", # Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not necessary for Private Auction deals.
+    "flightStartTime": "A String", # Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (for example, in milliseconds) will be truncated towards the start of time in seconds.
+    "mediaPlanner": { # Describes a single Media Planner account. # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. This field represents a media planner (For example, agency or big advertiser).
+      "accountId": "A String", # Output only. Account ID of the media planner.
+    },
+    "name": "A String", # Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}
+    "preferredDealTerms": { # Pricing terms for Preferred Deals. # The terms for preferred deals.
+      "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+        "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+          "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.
+        },
+        "type": "A String", # The pricing type for the deal.
+      },
+    },
+    "privateAuctionTerms": { # Pricing terms for Private Auctions. # The terms for private auction deals.
+      "floorPrice": { # Represents a price and a pricing type for a deal. # The minimum price buyer has to bid to compete in the private auction.
+        "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+          "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.
+        },
+        "type": "A String", # The pricing type for the deal.
+      },
+      "openAuctionAllowed": True or False, # Output only. True if open auction buyers are allowed to compete with invited buyers in this private auction.
+    },
+    "programmaticGuaranteedTerms": { # Pricing terms for Programmatic Guaranteed Deals. # The terms for programmatic guaranteed deals.
+      "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+        "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+          "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.
+        },
+        "type": "A String", # The pricing type for the deal.
+      },
+      "guaranteedLooks": "A String", # Count of guaranteed looks. For CPD deals, buyer changes to guaranteed_looks will be ignored.
+      "impressionCap": "A String", # The lifetime impression cap for CPM Sponsorship deals. Deal will stop serving when cap is reached.
+      "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.
+      "percentShareOfVoice": "A String", # For sponsorship deals, this is the percentage of the seller's eligible impressions that the deal will serve until the cap is reached. Valid value is within range 0~100.
+      "reservationType": "A String", # The reservation type for a Programmatic Guaranteed deal. This indicates whether the number of impressions is fixed, or a percent of available impressions. If not specified, the default reservation type is STANDARD.
+    },
+    "proposalRevision": "A String", # Output only. The revision number for the proposal and is the same value as proposal.proposal_revision. Each update to deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.
+    "publisherProfile": "A String", # Immutable. Reference to the seller on the deal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}`
+    "sellerTimeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Output only. Time zone of the seller used to mark the boundaries of a day for daypart targeting and CPD billing.
+      "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
+      "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+    },
+    "targeting": { # Targeting represents different criteria that can be used to target deals or auction packages. For example, they can choose to target inventory only if the user is in the US. Multiple types of targeting are always applied as a logical AND, unless noted otherwise. # Specifies the subset of inventory targeted by the deal. Can be updated by the buyer before the deal is finalized.
+      "daypartTargeting": { # Represents Daypart targeting. # Daypart targeting information.
+        "dayParts": [ # The targeted weekdays and times
+          { # Defines targeting for a period of time on a specific week day.
+            "dayOfWeek": "A String", # Day of week for the period.
+            "endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+              "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+              "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+              "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+            "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+              "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+              "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+              "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+        ],
+        "timeZoneType": "A String", # The time zone type of the day parts
+      },
+      "excludedSensitiveCategoryIds": [ # Output only. The sensitive content category label IDs excluded. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs.
+        "A String",
+      ],
+      "geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. Geo criteria IDs to be included/excluded.
+        "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+          "A String",
+        ],
+        "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+          "A String",
+        ],
+      },
+      "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on a bid request. # Output only. Inventory sizes to be included/excluded.
+        "excludedInventorySizes": [ # A list of inventory sizes to be excluded.
+          { # Represents size of a single ad slot, or a creative.
+            "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+            "type": "A String", # The type of the ad slot size.
+            "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+          },
+        ],
+        "targetedInventorySizes": [ # A list of inventory sizes to be included.
+          { # Represents size of a single ad slot, or a creative.
+            "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+            "type": "A String", # The type of the ad slot size.
+            "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+          },
+        ],
+      },
+      "inventoryTypeTargeting": { # Targeting of the inventory types a bid request can originate from. # Output only. Inventory type targeting information.
+        "inventoryTypes": [ # The list of targeted inventory types for the bid request.
+          "A String",
+        ],
+      },
+      "placementTargeting": { # Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Output only. Placement targeting information, for example, URL, mobile applications.
+        "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages.
+          "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in.
+            "excludedAppIds": [ # A list of application IDs to be excluded.
+              "A String",
+            ],
+            "targetedAppIds": [ # A list of application IDs to be included.
+              "A String",
+            ],
+          },
+        },
+        "uriTargeting": { # Represents a list of targeted and excluded URLs (for example, google.com). For Private Auction Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded.
+          "excludedUris": [ # A list of URLs to be excluded.
+            "A String",
+          ],
+          "targetedUris": [ # A list of URLs to be included.
+            "A String",
+          ],
+        },
+      },
+      "technologyTargeting": { # Represents targeting about various types of technology. # Output only. Technology targeting information, for example, operating system, device category.
+        "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device capabilities to be included/excluded.
+          "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+            "A String",
+          ],
+          "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+            "A String",
+          ],
+        },
+        "deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device categories to be included/excluded.
+          "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+            "A String",
+          ],
+          "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+            "A String",
+          ],
+        },
+        "operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.
+          "operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating systems to be included/excluded.
+            "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+              "A String",
+            ],
+            "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+              "A String",
+            ],
+          },
+          "operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating system versions to be included/excluded.
+            "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+              "A String",
+            ],
+            "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+              "A String",
+            ],
+          },
+        },
+      },
+      "userListTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Buyer user list targeting information. User lists can be uploaded using https://developers.google.com/authorized-buyers/rtb/bulk-uploader.
+        "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+          "A String",
+        ],
+        "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+          "A String",
+        ],
+      },
+      "verticalTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. The verticals included or excluded as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals
+        "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+          "A String",
+        ],
+        "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+          "A String",
+        ],
+      },
+      "videoTargeting": { # Represents targeting information about video. # Output only. Video targeting information.
+        "excludedPositionTypes": [ # A list of video positions to be excluded. When this field is populated, the targeted_position_types field must be empty.
+          "A String",
+        ],
+        "targetedPositionTypes": [ # A list of video positions to be included. When this field is populated, the excluded_position_types field must be empty.
+          "A String",
+        ],
+      },
+    },
+    "updateTime": "A String", # Output only. The time when the deal was last updated.
+  },
+  "dealPausingInfo": { # Information related to deal pausing. # Information related to deal pausing for the deal.
+    "pauseReason": "A String", # The reason for the pausing of the deal; empty for active deals.
+    "pauseRole": "A String", # The party that first paused the deal; unspecified for active deals.
+    "pausingConsented": True or False, # Whether pausing is consented between buyer and seller for the deal.
+  },
+  "dealServingStatus": "A String", # Serving status of the deal.
+  "name": "A String", # The resource name of the finalized deal. Format: `buyers/{accountId}/finalizedDeals/{finalizedDealId}`
+  "readyToServe": True or False, # Whether the Programmatic Guaranteed deal is ready for serving.
+  "rtbMetrics": { # Real-time bidding metrics. For what each metric means refer to [Report metrics](https://support.google.com/adxbuyer/answer/6115195#report-metrics) # Real-time bidding metrics for this deal.
+    "adImpressions7Days": "A String", # Ad impressions in last 7 days.
+    "bidRate7Days": 3.14, # Bid rate in last 7 days, calculated by (bids / bid requests).
+    "bidRequests7Days": "A String", # Bid requests in last 7 days.
+    "bids7Days": "A String", # Bids in last 7 days.
+    "filteredBidRate7Days": 3.14, # Filtered bid rate in last 7 days, calculated by (filtered bids / bids).
+    "mustBidRateCurrentMonth": 3.14, # Must bid rate for current month.
+  },
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Gets a finalized deal given its name.
+
+Args:
+  name: string, Required. Format: `buyers/{accountId}/finalizedDeals/{dealId}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A finalized deal is a snapshot of the deal when both buyer and seller accept the deal. The buyer or seller can update the deal after it's been finalized and renegotiate on the deal targeting, terms and other fields, while at the same time the finalized snapshot of the deal can still be retrieved using this API. The finalized deal contains a copy of the deal as it existed when most recently finalized, as well as fields related to deal serving such as pause/resume status, RTB metrics, and more.
+  "deal": { # A deal represents a segment of inventory for displaying ads that contains the terms and targeting information that is used for serving as well as the deal stats and status. Note: A proposal may contain multiple deals. # A copy of the Deal made upon finalization. During renegotiation, this will reflect the last finalized deal before renegotiation was initiated.
+    "billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer; when the deal belongs to a media planner account, this field will be empty. Format : `buyers/{buyerAccountId}`
+    "buyer": "A String", # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. Format: `buyers/{buyerAccountId}`
+    "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+    "createTime": "A String", # Output only. The time of the deal creation.
+    "creativeRequirements": { # Message captures data about the creatives in the deal. # Output only. Metadata about the creatives of this deal.
+      "creativeFormat": "A String", # Output only. The format of the creative, only applicable for programmatic guaranteed and preferred deals.
+      "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.
+      "creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.
+      "maxAdDurationMs": "A String", # Output only. The max duration of the video creative in milliseconds. only applicable for deals with video creatives.
+      "programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by the buyer.
+      "skippableAdType": "A String", # Output only. Skippable video ads allow viewers to skip ads after 5 seconds. Only applicable for deals with video creatives.
+    },
+    "dealType": "A String", # Output only. Type of deal.
+    "deliveryControl": { # Message contains details about how the deal will be paced. # Output only. Specifies the pacing set by the publisher.
+      "companionDeliveryType": "A String", # Output only. Specifies roadblocking in a main companion lineitem.
+      "creativeRotationType": "A String", # Output only. Specifies strategy to use for selecting a creative when multiple creatives of the same size are available.
+      "deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.
+      "frequencyCap": [ # Output only. Specifies any frequency caps. Cannot be filtered within ListDealsRequest.
+        { # Message contains details about publisher-set frequency caps of the delivery.
+          "maxImpressions": 42, # The maximum number of impressions that can be served to a user within the specified time period.
+          "timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped.
+          "timeUnitsCount": 42, # The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped.
+        },
+      ],
+      "roadblockingType": "A String", # Output only. Specifies the roadblocking type in display creatives.
+    },
+    "description": "A String", # Output only. Free text description for the deal terms.
+    "displayName": "A String", # Output only. The name of the deal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the deal.
+    "eligibleSeatIds": [ # Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.
+      "A String",
+    ],
+    "estimatedGrossSpend": { # Represents an amount of money with its currency type. # Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly.
+      "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.
+    },
+    "flightEndTime": "A String", # Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not necessary for Private Auction deals.
+    "flightStartTime": "A String", # Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (for example, in milliseconds) will be truncated towards the start of time in seconds.
+    "mediaPlanner": { # Describes a single Media Planner account. # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. This field represents a media planner (For example, agency or big advertiser).
+      "accountId": "A String", # Output only. Account ID of the media planner.
+    },
+    "name": "A String", # Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}
+    "preferredDealTerms": { # Pricing terms for Preferred Deals. # The terms for preferred deals.
+      "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+        "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+          "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.
+        },
+        "type": "A String", # The pricing type for the deal.
+      },
+    },
+    "privateAuctionTerms": { # Pricing terms for Private Auctions. # The terms for private auction deals.
+      "floorPrice": { # Represents a price and a pricing type for a deal. # The minimum price buyer has to bid to compete in the private auction.
+        "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+          "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.
+        },
+        "type": "A String", # The pricing type for the deal.
+      },
+      "openAuctionAllowed": True or False, # Output only. True if open auction buyers are allowed to compete with invited buyers in this private auction.
+    },
+    "programmaticGuaranteedTerms": { # Pricing terms for Programmatic Guaranteed Deals. # The terms for programmatic guaranteed deals.
+      "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+        "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+          "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.
+        },
+        "type": "A String", # The pricing type for the deal.
+      },
+      "guaranteedLooks": "A String", # Count of guaranteed looks. For CPD deals, buyer changes to guaranteed_looks will be ignored.
+      "impressionCap": "A String", # The lifetime impression cap for CPM Sponsorship deals. Deal will stop serving when cap is reached.
+      "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.
+      "percentShareOfVoice": "A String", # For sponsorship deals, this is the percentage of the seller's eligible impressions that the deal will serve until the cap is reached. Valid value is within range 0~100.
+      "reservationType": "A String", # The reservation type for a Programmatic Guaranteed deal. This indicates whether the number of impressions is fixed, or a percent of available impressions. If not specified, the default reservation type is STANDARD.
+    },
+    "proposalRevision": "A String", # Output only. The revision number for the proposal and is the same value as proposal.proposal_revision. Each update to deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.
+    "publisherProfile": "A String", # Immutable. Reference to the seller on the deal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}`
+    "sellerTimeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Output only. Time zone of the seller used to mark the boundaries of a day for daypart targeting and CPD billing.
+      "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
+      "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+    },
+    "targeting": { # Targeting represents different criteria that can be used to target deals or auction packages. For example, they can choose to target inventory only if the user is in the US. Multiple types of targeting are always applied as a logical AND, unless noted otherwise. # Specifies the subset of inventory targeted by the deal. Can be updated by the buyer before the deal is finalized.
+      "daypartTargeting": { # Represents Daypart targeting. # Daypart targeting information.
+        "dayParts": [ # The targeted weekdays and times
+          { # Defines targeting for a period of time on a specific week day.
+            "dayOfWeek": "A String", # Day of week for the period.
+            "endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+              "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+              "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+              "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+            "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+              "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+              "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+              "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+        ],
+        "timeZoneType": "A String", # The time zone type of the day parts
+      },
+      "excludedSensitiveCategoryIds": [ # Output only. The sensitive content category label IDs excluded. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs.
+        "A String",
+      ],
+      "geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. Geo criteria IDs to be included/excluded.
+        "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+          "A String",
+        ],
+        "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+          "A String",
+        ],
+      },
+      "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on a bid request. # Output only. Inventory sizes to be included/excluded.
+        "excludedInventorySizes": [ # A list of inventory sizes to be excluded.
+          { # Represents size of a single ad slot, or a creative.
+            "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+            "type": "A String", # The type of the ad slot size.
+            "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+          },
+        ],
+        "targetedInventorySizes": [ # A list of inventory sizes to be included.
+          { # Represents size of a single ad slot, or a creative.
+            "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+            "type": "A String", # The type of the ad slot size.
+            "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+          },
+        ],
+      },
+      "inventoryTypeTargeting": { # Targeting of the inventory types a bid request can originate from. # Output only. Inventory type targeting information.
+        "inventoryTypes": [ # The list of targeted inventory types for the bid request.
+          "A String",
+        ],
+      },
+      "placementTargeting": { # Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Output only. Placement targeting information, for example, URL, mobile applications.
+        "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages.
+          "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in.
+            "excludedAppIds": [ # A list of application IDs to be excluded.
+              "A String",
+            ],
+            "targetedAppIds": [ # A list of application IDs to be included.
+              "A String",
+            ],
+          },
+        },
+        "uriTargeting": { # Represents a list of targeted and excluded URLs (for example, google.com). For Private Auction Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded.
+          "excludedUris": [ # A list of URLs to be excluded.
+            "A String",
+          ],
+          "targetedUris": [ # A list of URLs to be included.
+            "A String",
+          ],
+        },
+      },
+      "technologyTargeting": { # Represents targeting about various types of technology. # Output only. Technology targeting information, for example, operating system, device category.
+        "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device capabilities to be included/excluded.
+          "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+            "A String",
+          ],
+          "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+            "A String",
+          ],
+        },
+        "deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device categories to be included/excluded.
+          "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+            "A String",
+          ],
+          "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+            "A String",
+          ],
+        },
+        "operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.
+          "operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating systems to be included/excluded.
+            "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+              "A String",
+            ],
+            "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+              "A String",
+            ],
+          },
+          "operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating system versions to be included/excluded.
+            "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+              "A String",
+            ],
+            "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+              "A String",
+            ],
+          },
+        },
+      },
+      "userListTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Buyer user list targeting information. User lists can be uploaded using https://developers.google.com/authorized-buyers/rtb/bulk-uploader.
+        "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+          "A String",
+        ],
+        "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+          "A String",
+        ],
+      },
+      "verticalTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. The verticals included or excluded as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals
+        "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+          "A String",
+        ],
+        "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+          "A String",
+        ],
+      },
+      "videoTargeting": { # Represents targeting information about video. # Output only. Video targeting information.
+        "excludedPositionTypes": [ # A list of video positions to be excluded. When this field is populated, the targeted_position_types field must be empty.
+          "A String",
+        ],
+        "targetedPositionTypes": [ # A list of video positions to be included. When this field is populated, the excluded_position_types field must be empty.
+          "A String",
+        ],
+      },
+    },
+    "updateTime": "A String", # Output only. The time when the deal was last updated.
+  },
+  "dealPausingInfo": { # Information related to deal pausing. # Information related to deal pausing for the deal.
+    "pauseReason": "A String", # The reason for the pausing of the deal; empty for active deals.
+    "pauseRole": "A String", # The party that first paused the deal; unspecified for active deals.
+    "pausingConsented": True or False, # Whether pausing is consented between buyer and seller for the deal.
+  },
+  "dealServingStatus": "A String", # Serving status of the deal.
+  "name": "A String", # The resource name of the finalized deal. Format: `buyers/{accountId}/finalizedDeals/{finalizedDealId}`
+  "readyToServe": True or False, # Whether the Programmatic Guaranteed deal is ready for serving.
+  "rtbMetrics": { # Real-time bidding metrics. For what each metric means refer to [Report metrics](https://support.google.com/adxbuyer/answer/6115195#report-metrics) # Real-time bidding metrics for this deal.
+    "adImpressions7Days": "A String", # Ad impressions in last 7 days.
+    "bidRate7Days": 3.14, # Bid rate in last 7 days, calculated by (bids / bid requests).
+    "bidRequests7Days": "A String", # Bid requests in last 7 days.
+    "bids7Days": "A String", # Bids in last 7 days.
+    "filteredBidRate7Days": 3.14, # Filtered bid rate in last 7 days, calculated by (filtered bids / bids).
+    "mustBidRateCurrentMonth": 3.14, # Must bid rate for current month.
+  },
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists finalized deals. Use the URL path "/v1alpha/buyers/{accountId}/finalizedDeals" to list finalized deals for the current buyer and its clients. Bidders can use the URL path "/v1alpha/bidders/{accountId}/finalizedDeals" to list finalized deals for the bidder, its buyers and all their clients.
+
+Args:
+  parent: string, Required. The buyer to list the finalized deals for, in the format: `buyers/{accountId}`. When used to list finalized deals for a bidder, its buyers and clients, in the format `bidders/{accountId}`. (required)
+  filter: string, Optional query string using the [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) Supported columns for filtering are: * deal.displayName * deal.dealType * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * deal.eligibleSeatIds * dealServingStatus
+  orderBy: string, An optional query string to sort finalized deals using the [Cloud API sorting syntax](https://cloud.google.com/apis/design/design_patterns#sorting_order). If no sort order is specified, results will be returned in an arbitrary order. Supported columns for sorting are: * deal.displayName * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * rtbMetrics.bidRequests7Days * rtbMetrics.bids7Days * rtbMetrics.adImpressions7Days * rtbMetrics.bidRate7Days * rtbMetrics.filteredBidRate7Days * rtbMetrics.mustBidRateCurrentMonth
+  pageSize: integer, Requested page size. The server may return fewer results than requested. If requested more than 500, the server will return 500 results per page. If unspecified, the server will pick a default page size of 100.
+  pageToken: string, The page token as returned from ListFinalizedDealsResponse.
+  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 listing finalized deals.
+  "finalizedDeals": [ # The list of finalized deals.
+    { # A finalized deal is a snapshot of the deal when both buyer and seller accept the deal. The buyer or seller can update the deal after it's been finalized and renegotiate on the deal targeting, terms and other fields, while at the same time the finalized snapshot of the deal can still be retrieved using this API. The finalized deal contains a copy of the deal as it existed when most recently finalized, as well as fields related to deal serving such as pause/resume status, RTB metrics, and more.
+      "deal": { # A deal represents a segment of inventory for displaying ads that contains the terms and targeting information that is used for serving as well as the deal stats and status. Note: A proposal may contain multiple deals. # A copy of the Deal made upon finalization. During renegotiation, this will reflect the last finalized deal before renegotiation was initiated.
+        "billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer; when the deal belongs to a media planner account, this field will be empty. Format : `buyers/{buyerAccountId}`
+        "buyer": "A String", # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. Format: `buyers/{buyerAccountId}`
+        "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+        "createTime": "A String", # Output only. The time of the deal creation.
+        "creativeRequirements": { # Message captures data about the creatives in the deal. # Output only. Metadata about the creatives of this deal.
+          "creativeFormat": "A String", # Output only. The format of the creative, only applicable for programmatic guaranteed and preferred deals.
+          "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.
+          "creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.
+          "maxAdDurationMs": "A String", # Output only. The max duration of the video creative in milliseconds. only applicable for deals with video creatives.
+          "programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by the buyer.
+          "skippableAdType": "A String", # Output only. Skippable video ads allow viewers to skip ads after 5 seconds. Only applicable for deals with video creatives.
+        },
+        "dealType": "A String", # Output only. Type of deal.
+        "deliveryControl": { # Message contains details about how the deal will be paced. # Output only. Specifies the pacing set by the publisher.
+          "companionDeliveryType": "A String", # Output only. Specifies roadblocking in a main companion lineitem.
+          "creativeRotationType": "A String", # Output only. Specifies strategy to use for selecting a creative when multiple creatives of the same size are available.
+          "deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.
+          "frequencyCap": [ # Output only. Specifies any frequency caps. Cannot be filtered within ListDealsRequest.
+            { # Message contains details about publisher-set frequency caps of the delivery.
+              "maxImpressions": 42, # The maximum number of impressions that can be served to a user within the specified time period.
+              "timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped.
+              "timeUnitsCount": 42, # The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped.
+            },
+          ],
+          "roadblockingType": "A String", # Output only. Specifies the roadblocking type in display creatives.
+        },
+        "description": "A String", # Output only. Free text description for the deal terms.
+        "displayName": "A String", # Output only. The name of the deal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the deal.
+        "eligibleSeatIds": [ # Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.
+          "A String",
+        ],
+        "estimatedGrossSpend": { # Represents an amount of money with its currency type. # Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly.
+          "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.
+        },
+        "flightEndTime": "A String", # Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not necessary for Private Auction deals.
+        "flightStartTime": "A String", # Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (for example, in milliseconds) will be truncated towards the start of time in seconds.
+        "mediaPlanner": { # Describes a single Media Planner account. # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. This field represents a media planner (For example, agency or big advertiser).
+          "accountId": "A String", # Output only. Account ID of the media planner.
+        },
+        "name": "A String", # Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}
+        "preferredDealTerms": { # Pricing terms for Preferred Deals. # The terms for preferred deals.
+          "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+            "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+              "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.
+            },
+            "type": "A String", # The pricing type for the deal.
+          },
+        },
+        "privateAuctionTerms": { # Pricing terms for Private Auctions. # The terms for private auction deals.
+          "floorPrice": { # Represents a price and a pricing type for a deal. # The minimum price buyer has to bid to compete in the private auction.
+            "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+              "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.
+            },
+            "type": "A String", # The pricing type for the deal.
+          },
+          "openAuctionAllowed": True or False, # Output only. True if open auction buyers are allowed to compete with invited buyers in this private auction.
+        },
+        "programmaticGuaranteedTerms": { # Pricing terms for Programmatic Guaranteed Deals. # The terms for programmatic guaranteed deals.
+          "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+            "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+              "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.
+            },
+            "type": "A String", # The pricing type for the deal.
+          },
+          "guaranteedLooks": "A String", # Count of guaranteed looks. For CPD deals, buyer changes to guaranteed_looks will be ignored.
+          "impressionCap": "A String", # The lifetime impression cap for CPM Sponsorship deals. Deal will stop serving when cap is reached.
+          "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.
+          "percentShareOfVoice": "A String", # For sponsorship deals, this is the percentage of the seller's eligible impressions that the deal will serve until the cap is reached. Valid value is within range 0~100.
+          "reservationType": "A String", # The reservation type for a Programmatic Guaranteed deal. This indicates whether the number of impressions is fixed, or a percent of available impressions. If not specified, the default reservation type is STANDARD.
+        },
+        "proposalRevision": "A String", # Output only. The revision number for the proposal and is the same value as proposal.proposal_revision. Each update to deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.
+        "publisherProfile": "A String", # Immutable. Reference to the seller on the deal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}`
+        "sellerTimeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Output only. Time zone of the seller used to mark the boundaries of a day for daypart targeting and CPD billing.
+          "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
+          "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+        },
+        "targeting": { # Targeting represents different criteria that can be used to target deals or auction packages. For example, they can choose to target inventory only if the user is in the US. Multiple types of targeting are always applied as a logical AND, unless noted otherwise. # Specifies the subset of inventory targeted by the deal. Can be updated by the buyer before the deal is finalized.
+          "daypartTargeting": { # Represents Daypart targeting. # Daypart targeting information.
+            "dayParts": [ # The targeted weekdays and times
+              { # Defines targeting for a period of time on a specific week day.
+                "dayOfWeek": "A String", # Day of week for the period.
+                "endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+                  "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+                  "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+                  "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+                  "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+                },
+                "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+                  "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+                  "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+                  "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+                  "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+                },
+              },
+            ],
+            "timeZoneType": "A String", # The time zone type of the day parts
+          },
+          "excludedSensitiveCategoryIds": [ # Output only. The sensitive content category label IDs excluded. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs.
+            "A String",
+          ],
+          "geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. Geo criteria IDs to be included/excluded.
+            "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+              "A String",
+            ],
+            "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+              "A String",
+            ],
+          },
+          "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on a bid request. # Output only. Inventory sizes to be included/excluded.
+            "excludedInventorySizes": [ # A list of inventory sizes to be excluded.
+              { # Represents size of a single ad slot, or a creative.
+                "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+                "type": "A String", # The type of the ad slot size.
+                "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+              },
+            ],
+            "targetedInventorySizes": [ # A list of inventory sizes to be included.
+              { # Represents size of a single ad slot, or a creative.
+                "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+                "type": "A String", # The type of the ad slot size.
+                "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+              },
+            ],
+          },
+          "inventoryTypeTargeting": { # Targeting of the inventory types a bid request can originate from. # Output only. Inventory type targeting information.
+            "inventoryTypes": [ # The list of targeted inventory types for the bid request.
+              "A String",
+            ],
+          },
+          "placementTargeting": { # Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Output only. Placement targeting information, for example, URL, mobile applications.
+            "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages.
+              "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in.
+                "excludedAppIds": [ # A list of application IDs to be excluded.
+                  "A String",
+                ],
+                "targetedAppIds": [ # A list of application IDs to be included.
+                  "A String",
+                ],
+              },
+            },
+            "uriTargeting": { # Represents a list of targeted and excluded URLs (for example, google.com). For Private Auction Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded.
+              "excludedUris": [ # A list of URLs to be excluded.
+                "A String",
+              ],
+              "targetedUris": [ # A list of URLs to be included.
+                "A String",
+              ],
+            },
+          },
+          "technologyTargeting": { # Represents targeting about various types of technology. # Output only. Technology targeting information, for example, operating system, device category.
+            "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device capabilities to be included/excluded.
+              "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+                "A String",
+              ],
+              "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+                "A String",
+              ],
+            },
+            "deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device categories to be included/excluded.
+              "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+                "A String",
+              ],
+              "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+                "A String",
+              ],
+            },
+            "operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.
+              "operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating systems to be included/excluded.
+                "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+                  "A String",
+                ],
+                "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+                  "A String",
+                ],
+              },
+              "operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating system versions to be included/excluded.
+                "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+                  "A String",
+                ],
+                "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+                  "A String",
+                ],
+              },
+            },
+          },
+          "userListTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Buyer user list targeting information. User lists can be uploaded using https://developers.google.com/authorized-buyers/rtb/bulk-uploader.
+            "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+              "A String",
+            ],
+            "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+              "A String",
+            ],
+          },
+          "verticalTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. The verticals included or excluded as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals
+            "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+              "A String",
+            ],
+            "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+              "A String",
+            ],
+          },
+          "videoTargeting": { # Represents targeting information about video. # Output only. Video targeting information.
+            "excludedPositionTypes": [ # A list of video positions to be excluded. When this field is populated, the targeted_position_types field must be empty.
+              "A String",
+            ],
+            "targetedPositionTypes": [ # A list of video positions to be included. When this field is populated, the excluded_position_types field must be empty.
+              "A String",
+            ],
+          },
+        },
+        "updateTime": "A String", # Output only. The time when the deal was last updated.
+      },
+      "dealPausingInfo": { # Information related to deal pausing. # Information related to deal pausing for the deal.
+        "pauseReason": "A String", # The reason for the pausing of the deal; empty for active deals.
+        "pauseRole": "A String", # The party that first paused the deal; unspecified for active deals.
+        "pausingConsented": True or False, # Whether pausing is consented between buyer and seller for the deal.
+      },
+      "dealServingStatus": "A String", # Serving status of the deal.
+      "name": "A String", # The resource name of the finalized deal. Format: `buyers/{accountId}/finalizedDeals/{finalizedDealId}`
+      "readyToServe": True or False, # Whether the Programmatic Guaranteed deal is ready for serving.
+      "rtbMetrics": { # Real-time bidding metrics. For what each metric means refer to [Report metrics](https://support.google.com/adxbuyer/answer/6115195#report-metrics) # Real-time bidding metrics for this deal.
+        "adImpressions7Days": "A String", # Ad impressions in last 7 days.
+        "bidRate7Days": 3.14, # Bid rate in last 7 days, calculated by (bids / bid requests).
+        "bidRequests7Days": "A String", # Bid requests in last 7 days.
+        "bids7Days": "A String", # Bids in last 7 days.
+        "filteredBidRate7Days": 3.14, # Filtered bid rate in last 7 days, calculated by (filtered bids / bids).
+        "mustBidRateCurrentMonth": 3.14, # Must bid rate for current month.
+      },
+    },
+  ],
+  "nextPageToken": "A String", # Token to fetch the next page of results.
+}
+
+ +
+ 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.
+        
+
+ +
+ pause(name, body=None, x__xgafv=None) +
Pauses serving of the given finalized deal. This call only pauses the serving status, and does not affect other fields of the finalized deal. Calling this method for an already paused deal has no effect. This method only applies to programmatic guaranteed deals and preferred deals.
+
+Args:
+  name: string, Required. Format: `buyers/{accountId}/finalizedDeals/{dealId}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for pausing a finalized deal.
+  "reason": "A String", # The reason to pause the finalized deal, will be displayed to the seller. Maximum length is 1000 characters.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A finalized deal is a snapshot of the deal when both buyer and seller accept the deal. The buyer or seller can update the deal after it's been finalized and renegotiate on the deal targeting, terms and other fields, while at the same time the finalized snapshot of the deal can still be retrieved using this API. The finalized deal contains a copy of the deal as it existed when most recently finalized, as well as fields related to deal serving such as pause/resume status, RTB metrics, and more.
+  "deal": { # A deal represents a segment of inventory for displaying ads that contains the terms and targeting information that is used for serving as well as the deal stats and status. Note: A proposal may contain multiple deals. # A copy of the Deal made upon finalization. During renegotiation, this will reflect the last finalized deal before renegotiation was initiated.
+    "billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer; when the deal belongs to a media planner account, this field will be empty. Format : `buyers/{buyerAccountId}`
+    "buyer": "A String", # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. Format: `buyers/{buyerAccountId}`
+    "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+    "createTime": "A String", # Output only. The time of the deal creation.
+    "creativeRequirements": { # Message captures data about the creatives in the deal. # Output only. Metadata about the creatives of this deal.
+      "creativeFormat": "A String", # Output only. The format of the creative, only applicable for programmatic guaranteed and preferred deals.
+      "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.
+      "creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.
+      "maxAdDurationMs": "A String", # Output only. The max duration of the video creative in milliseconds. only applicable for deals with video creatives.
+      "programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by the buyer.
+      "skippableAdType": "A String", # Output only. Skippable video ads allow viewers to skip ads after 5 seconds. Only applicable for deals with video creatives.
+    },
+    "dealType": "A String", # Output only. Type of deal.
+    "deliveryControl": { # Message contains details about how the deal will be paced. # Output only. Specifies the pacing set by the publisher.
+      "companionDeliveryType": "A String", # Output only. Specifies roadblocking in a main companion lineitem.
+      "creativeRotationType": "A String", # Output only. Specifies strategy to use for selecting a creative when multiple creatives of the same size are available.
+      "deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.
+      "frequencyCap": [ # Output only. Specifies any frequency caps. Cannot be filtered within ListDealsRequest.
+        { # Message contains details about publisher-set frequency caps of the delivery.
+          "maxImpressions": 42, # The maximum number of impressions that can be served to a user within the specified time period.
+          "timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped.
+          "timeUnitsCount": 42, # The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped.
+        },
+      ],
+      "roadblockingType": "A String", # Output only. Specifies the roadblocking type in display creatives.
+    },
+    "description": "A String", # Output only. Free text description for the deal terms.
+    "displayName": "A String", # Output only. The name of the deal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the deal.
+    "eligibleSeatIds": [ # Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.
+      "A String",
+    ],
+    "estimatedGrossSpend": { # Represents an amount of money with its currency type. # Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly.
+      "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.
+    },
+    "flightEndTime": "A String", # Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not necessary for Private Auction deals.
+    "flightStartTime": "A String", # Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (for example, in milliseconds) will be truncated towards the start of time in seconds.
+    "mediaPlanner": { # Describes a single Media Planner account. # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. This field represents a media planner (For example, agency or big advertiser).
+      "accountId": "A String", # Output only. Account ID of the media planner.
+    },
+    "name": "A String", # Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}
+    "preferredDealTerms": { # Pricing terms for Preferred Deals. # The terms for preferred deals.
+      "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+        "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+          "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.
+        },
+        "type": "A String", # The pricing type for the deal.
+      },
+    },
+    "privateAuctionTerms": { # Pricing terms for Private Auctions. # The terms for private auction deals.
+      "floorPrice": { # Represents a price and a pricing type for a deal. # The minimum price buyer has to bid to compete in the private auction.
+        "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+          "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.
+        },
+        "type": "A String", # The pricing type for the deal.
+      },
+      "openAuctionAllowed": True or False, # Output only. True if open auction buyers are allowed to compete with invited buyers in this private auction.
+    },
+    "programmaticGuaranteedTerms": { # Pricing terms for Programmatic Guaranteed Deals. # The terms for programmatic guaranteed deals.
+      "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+        "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+          "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.
+        },
+        "type": "A String", # The pricing type for the deal.
+      },
+      "guaranteedLooks": "A String", # Count of guaranteed looks. For CPD deals, buyer changes to guaranteed_looks will be ignored.
+      "impressionCap": "A String", # The lifetime impression cap for CPM Sponsorship deals. Deal will stop serving when cap is reached.
+      "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.
+      "percentShareOfVoice": "A String", # For sponsorship deals, this is the percentage of the seller's eligible impressions that the deal will serve until the cap is reached. Valid value is within range 0~100.
+      "reservationType": "A String", # The reservation type for a Programmatic Guaranteed deal. This indicates whether the number of impressions is fixed, or a percent of available impressions. If not specified, the default reservation type is STANDARD.
+    },
+    "proposalRevision": "A String", # Output only. The revision number for the proposal and is the same value as proposal.proposal_revision. Each update to deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.
+    "publisherProfile": "A String", # Immutable. Reference to the seller on the deal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}`
+    "sellerTimeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Output only. Time zone of the seller used to mark the boundaries of a day for daypart targeting and CPD billing.
+      "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
+      "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+    },
+    "targeting": { # Targeting represents different criteria that can be used to target deals or auction packages. For example, they can choose to target inventory only if the user is in the US. Multiple types of targeting are always applied as a logical AND, unless noted otherwise. # Specifies the subset of inventory targeted by the deal. Can be updated by the buyer before the deal is finalized.
+      "daypartTargeting": { # Represents Daypart targeting. # Daypart targeting information.
+        "dayParts": [ # The targeted weekdays and times
+          { # Defines targeting for a period of time on a specific week day.
+            "dayOfWeek": "A String", # Day of week for the period.
+            "endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+              "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+              "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+              "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+            "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+              "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+              "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+              "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+        ],
+        "timeZoneType": "A String", # The time zone type of the day parts
+      },
+      "excludedSensitiveCategoryIds": [ # Output only. The sensitive content category label IDs excluded. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs.
+        "A String",
+      ],
+      "geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. Geo criteria IDs to be included/excluded.
+        "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+          "A String",
+        ],
+        "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+          "A String",
+        ],
+      },
+      "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on a bid request. # Output only. Inventory sizes to be included/excluded.
+        "excludedInventorySizes": [ # A list of inventory sizes to be excluded.
+          { # Represents size of a single ad slot, or a creative.
+            "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+            "type": "A String", # The type of the ad slot size.
+            "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+          },
+        ],
+        "targetedInventorySizes": [ # A list of inventory sizes to be included.
+          { # Represents size of a single ad slot, or a creative.
+            "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+            "type": "A String", # The type of the ad slot size.
+            "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+          },
+        ],
+      },
+      "inventoryTypeTargeting": { # Targeting of the inventory types a bid request can originate from. # Output only. Inventory type targeting information.
+        "inventoryTypes": [ # The list of targeted inventory types for the bid request.
+          "A String",
+        ],
+      },
+      "placementTargeting": { # Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Output only. Placement targeting information, for example, URL, mobile applications.
+        "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages.
+          "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in.
+            "excludedAppIds": [ # A list of application IDs to be excluded.
+              "A String",
+            ],
+            "targetedAppIds": [ # A list of application IDs to be included.
+              "A String",
+            ],
+          },
+        },
+        "uriTargeting": { # Represents a list of targeted and excluded URLs (for example, google.com). For Private Auction Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded.
+          "excludedUris": [ # A list of URLs to be excluded.
+            "A String",
+          ],
+          "targetedUris": [ # A list of URLs to be included.
+            "A String",
+          ],
+        },
+      },
+      "technologyTargeting": { # Represents targeting about various types of technology. # Output only. Technology targeting information, for example, operating system, device category.
+        "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device capabilities to be included/excluded.
+          "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+            "A String",
+          ],
+          "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+            "A String",
+          ],
+        },
+        "deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device categories to be included/excluded.
+          "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+            "A String",
+          ],
+          "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+            "A String",
+          ],
+        },
+        "operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.
+          "operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating systems to be included/excluded.
+            "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+              "A String",
+            ],
+            "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+              "A String",
+            ],
+          },
+          "operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating system versions to be included/excluded.
+            "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+              "A String",
+            ],
+            "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+              "A String",
+            ],
+          },
+        },
+      },
+      "userListTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Buyer user list targeting information. User lists can be uploaded using https://developers.google.com/authorized-buyers/rtb/bulk-uploader.
+        "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+          "A String",
+        ],
+        "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+          "A String",
+        ],
+      },
+      "verticalTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. The verticals included or excluded as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals
+        "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+          "A String",
+        ],
+        "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+          "A String",
+        ],
+      },
+      "videoTargeting": { # Represents targeting information about video. # Output only. Video targeting information.
+        "excludedPositionTypes": [ # A list of video positions to be excluded. When this field is populated, the targeted_position_types field must be empty.
+          "A String",
+        ],
+        "targetedPositionTypes": [ # A list of video positions to be included. When this field is populated, the excluded_position_types field must be empty.
+          "A String",
+        ],
+      },
+    },
+    "updateTime": "A String", # Output only. The time when the deal was last updated.
+  },
+  "dealPausingInfo": { # Information related to deal pausing. # Information related to deal pausing for the deal.
+    "pauseReason": "A String", # The reason for the pausing of the deal; empty for active deals.
+    "pauseRole": "A String", # The party that first paused the deal; unspecified for active deals.
+    "pausingConsented": True or False, # Whether pausing is consented between buyer and seller for the deal.
+  },
+  "dealServingStatus": "A String", # Serving status of the deal.
+  "name": "A String", # The resource name of the finalized deal. Format: `buyers/{accountId}/finalizedDeals/{finalizedDealId}`
+  "readyToServe": True or False, # Whether the Programmatic Guaranteed deal is ready for serving.
+  "rtbMetrics": { # Real-time bidding metrics. For what each metric means refer to [Report metrics](https://support.google.com/adxbuyer/answer/6115195#report-metrics) # Real-time bidding metrics for this deal.
+    "adImpressions7Days": "A String", # Ad impressions in last 7 days.
+    "bidRate7Days": 3.14, # Bid rate in last 7 days, calculated by (bids / bid requests).
+    "bidRequests7Days": "A String", # Bid requests in last 7 days.
+    "bids7Days": "A String", # Bids in last 7 days.
+    "filteredBidRate7Days": 3.14, # Filtered bid rate in last 7 days, calculated by (filtered bids / bids).
+    "mustBidRateCurrentMonth": 3.14, # Must bid rate for current month.
+  },
+}
+
+ +
+ resume(name, body=None, x__xgafv=None) +
Resumes serving of the given finalized deal. Calling this method for an running deal has no effect. If a deal is initially paused by the seller, calling this method will not resume serving of the deal until the seller also resumes the deal. This method only applies to programmatic guaranteed deals and preferred deals.
+
+Args:
+  name: string, Required. Format: `buyers/{accountId}/finalizedDeals/{dealId}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for resuming a finalized deal.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A finalized deal is a snapshot of the deal when both buyer and seller accept the deal. The buyer or seller can update the deal after it's been finalized and renegotiate on the deal targeting, terms and other fields, while at the same time the finalized snapshot of the deal can still be retrieved using this API. The finalized deal contains a copy of the deal as it existed when most recently finalized, as well as fields related to deal serving such as pause/resume status, RTB metrics, and more.
+  "deal": { # A deal represents a segment of inventory for displaying ads that contains the terms and targeting information that is used for serving as well as the deal stats and status. Note: A proposal may contain multiple deals. # A copy of the Deal made upon finalization. During renegotiation, this will reflect the last finalized deal before renegotiation was initiated.
+    "billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer; when the deal belongs to a media planner account, this field will be empty. Format : `buyers/{buyerAccountId}`
+    "buyer": "A String", # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. Format: `buyers/{buyerAccountId}`
+    "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+    "createTime": "A String", # Output only. The time of the deal creation.
+    "creativeRequirements": { # Message captures data about the creatives in the deal. # Output only. Metadata about the creatives of this deal.
+      "creativeFormat": "A String", # Output only. The format of the creative, only applicable for programmatic guaranteed and preferred deals.
+      "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.
+      "creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.
+      "maxAdDurationMs": "A String", # Output only. The max duration of the video creative in milliseconds. only applicable for deals with video creatives.
+      "programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by the buyer.
+      "skippableAdType": "A String", # Output only. Skippable video ads allow viewers to skip ads after 5 seconds. Only applicable for deals with video creatives.
+    },
+    "dealType": "A String", # Output only. Type of deal.
+    "deliveryControl": { # Message contains details about how the deal will be paced. # Output only. Specifies the pacing set by the publisher.
+      "companionDeliveryType": "A String", # Output only. Specifies roadblocking in a main companion lineitem.
+      "creativeRotationType": "A String", # Output only. Specifies strategy to use for selecting a creative when multiple creatives of the same size are available.
+      "deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.
+      "frequencyCap": [ # Output only. Specifies any frequency caps. Cannot be filtered within ListDealsRequest.
+        { # Message contains details about publisher-set frequency caps of the delivery.
+          "maxImpressions": 42, # The maximum number of impressions that can be served to a user within the specified time period.
+          "timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped.
+          "timeUnitsCount": 42, # The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped.
+        },
+      ],
+      "roadblockingType": "A String", # Output only. Specifies the roadblocking type in display creatives.
+    },
+    "description": "A String", # Output only. Free text description for the deal terms.
+    "displayName": "A String", # Output only. The name of the deal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the deal.
+    "eligibleSeatIds": [ # Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.
+      "A String",
+    ],
+    "estimatedGrossSpend": { # Represents an amount of money with its currency type. # Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly.
+      "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.
+    },
+    "flightEndTime": "A String", # Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not necessary for Private Auction deals.
+    "flightStartTime": "A String", # Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (for example, in milliseconds) will be truncated towards the start of time in seconds.
+    "mediaPlanner": { # Describes a single Media Planner account. # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. This field represents a media planner (For example, agency or big advertiser).
+      "accountId": "A String", # Output only. Account ID of the media planner.
+    },
+    "name": "A String", # Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}
+    "preferredDealTerms": { # Pricing terms for Preferred Deals. # The terms for preferred deals.
+      "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+        "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+          "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.
+        },
+        "type": "A String", # The pricing type for the deal.
+      },
+    },
+    "privateAuctionTerms": { # Pricing terms for Private Auctions. # The terms for private auction deals.
+      "floorPrice": { # Represents a price and a pricing type for a deal. # The minimum price buyer has to bid to compete in the private auction.
+        "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+          "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.
+        },
+        "type": "A String", # The pricing type for the deal.
+      },
+      "openAuctionAllowed": True or False, # Output only. True if open auction buyers are allowed to compete with invited buyers in this private auction.
+    },
+    "programmaticGuaranteedTerms": { # Pricing terms for Programmatic Guaranteed Deals. # The terms for programmatic guaranteed deals.
+      "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+        "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+          "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.
+        },
+        "type": "A String", # The pricing type for the deal.
+      },
+      "guaranteedLooks": "A String", # Count of guaranteed looks. For CPD deals, buyer changes to guaranteed_looks will be ignored.
+      "impressionCap": "A String", # The lifetime impression cap for CPM Sponsorship deals. Deal will stop serving when cap is reached.
+      "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.
+      "percentShareOfVoice": "A String", # For sponsorship deals, this is the percentage of the seller's eligible impressions that the deal will serve until the cap is reached. Valid value is within range 0~100.
+      "reservationType": "A String", # The reservation type for a Programmatic Guaranteed deal. This indicates whether the number of impressions is fixed, or a percent of available impressions. If not specified, the default reservation type is STANDARD.
+    },
+    "proposalRevision": "A String", # Output only. The revision number for the proposal and is the same value as proposal.proposal_revision. Each update to deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.
+    "publisherProfile": "A String", # Immutable. Reference to the seller on the deal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}`
+    "sellerTimeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Output only. Time zone of the seller used to mark the boundaries of a day for daypart targeting and CPD billing.
+      "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
+      "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+    },
+    "targeting": { # Targeting represents different criteria that can be used to target deals or auction packages. For example, they can choose to target inventory only if the user is in the US. Multiple types of targeting are always applied as a logical AND, unless noted otherwise. # Specifies the subset of inventory targeted by the deal. Can be updated by the buyer before the deal is finalized.
+      "daypartTargeting": { # Represents Daypart targeting. # Daypart targeting information.
+        "dayParts": [ # The targeted weekdays and times
+          { # Defines targeting for a period of time on a specific week day.
+            "dayOfWeek": "A String", # Day of week for the period.
+            "endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+              "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+              "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+              "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+            "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+              "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+              "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+              "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+        ],
+        "timeZoneType": "A String", # The time zone type of the day parts
+      },
+      "excludedSensitiveCategoryIds": [ # Output only. The sensitive content category label IDs excluded. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs.
+        "A String",
+      ],
+      "geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. Geo criteria IDs to be included/excluded.
+        "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+          "A String",
+        ],
+        "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+          "A String",
+        ],
+      },
+      "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on a bid request. # Output only. Inventory sizes to be included/excluded.
+        "excludedInventorySizes": [ # A list of inventory sizes to be excluded.
+          { # Represents size of a single ad slot, or a creative.
+            "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+            "type": "A String", # The type of the ad slot size.
+            "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+          },
+        ],
+        "targetedInventorySizes": [ # A list of inventory sizes to be included.
+          { # Represents size of a single ad slot, or a creative.
+            "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+            "type": "A String", # The type of the ad slot size.
+            "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+          },
+        ],
+      },
+      "inventoryTypeTargeting": { # Targeting of the inventory types a bid request can originate from. # Output only. Inventory type targeting information.
+        "inventoryTypes": [ # The list of targeted inventory types for the bid request.
+          "A String",
+        ],
+      },
+      "placementTargeting": { # Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Output only. Placement targeting information, for example, URL, mobile applications.
+        "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages.
+          "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in.
+            "excludedAppIds": [ # A list of application IDs to be excluded.
+              "A String",
+            ],
+            "targetedAppIds": [ # A list of application IDs to be included.
+              "A String",
+            ],
+          },
+        },
+        "uriTargeting": { # Represents a list of targeted and excluded URLs (for example, google.com). For Private Auction Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded.
+          "excludedUris": [ # A list of URLs to be excluded.
+            "A String",
+          ],
+          "targetedUris": [ # A list of URLs to be included.
+            "A String",
+          ],
+        },
+      },
+      "technologyTargeting": { # Represents targeting about various types of technology. # Output only. Technology targeting information, for example, operating system, device category.
+        "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device capabilities to be included/excluded.
+          "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+            "A String",
+          ],
+          "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+            "A String",
+          ],
+        },
+        "deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device categories to be included/excluded.
+          "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+            "A String",
+          ],
+          "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+            "A String",
+          ],
+        },
+        "operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.
+          "operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating systems to be included/excluded.
+            "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+              "A String",
+            ],
+            "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+              "A String",
+            ],
+          },
+          "operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating system versions to be included/excluded.
+            "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+              "A String",
+            ],
+            "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+              "A String",
+            ],
+          },
+        },
+      },
+      "userListTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Buyer user list targeting information. User lists can be uploaded using https://developers.google.com/authorized-buyers/rtb/bulk-uploader.
+        "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+          "A String",
+        ],
+        "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+          "A String",
+        ],
+      },
+      "verticalTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. The verticals included or excluded as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals
+        "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+          "A String",
+        ],
+        "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+          "A String",
+        ],
+      },
+      "videoTargeting": { # Represents targeting information about video. # Output only. Video targeting information.
+        "excludedPositionTypes": [ # A list of video positions to be excluded. When this field is populated, the targeted_position_types field must be empty.
+          "A String",
+        ],
+        "targetedPositionTypes": [ # A list of video positions to be included. When this field is populated, the excluded_position_types field must be empty.
+          "A String",
+        ],
+      },
+    },
+    "updateTime": "A String", # Output only. The time when the deal was last updated.
+  },
+  "dealPausingInfo": { # Information related to deal pausing. # Information related to deal pausing for the deal.
+    "pauseReason": "A String", # The reason for the pausing of the deal; empty for active deals.
+    "pauseRole": "A String", # The party that first paused the deal; unspecified for active deals.
+    "pausingConsented": True or False, # Whether pausing is consented between buyer and seller for the deal.
+  },
+  "dealServingStatus": "A String", # Serving status of the deal.
+  "name": "A String", # The resource name of the finalized deal. Format: `buyers/{accountId}/finalizedDeals/{finalizedDealId}`
+  "readyToServe": True or False, # Whether the Programmatic Guaranteed deal is ready for serving.
+  "rtbMetrics": { # Real-time bidding metrics. For what each metric means refer to [Report metrics](https://support.google.com/adxbuyer/answer/6115195#report-metrics) # Real-time bidding metrics for this deal.
+    "adImpressions7Days": "A String", # Ad impressions in last 7 days.
+    "bidRate7Days": 3.14, # Bid rate in last 7 days, calculated by (bids / bid requests).
+    "bidRequests7Days": "A String", # Bid requests in last 7 days.
+    "bids7Days": "A String", # Bids in last 7 days.
+    "filteredBidRate7Days": 3.14, # Filtered bid rate in last 7 days, calculated by (filtered bids / bids).
+    "mustBidRateCurrentMonth": 3.14, # Must bid rate for current month.
+  },
+}
+
+ +
+ setReadyToServe(deal, body=None, x__xgafv=None) +
Sets the given finalized deal as ready to serve. By default, deals are set as ready to serve as soon as they're finalized. If you want to opt out of the default behavior, and manually indicate that deals are ready to serve, ask your Technical Account Manager to add you to the allowlist. If you choose to use this method, finalized deals belonging to the bidder and its child seats don't start serving until after you call `setReadyToServe`, and after the deals become active. For example, you can use this method to delay receiving bid requests until your creative is ready. This method only applies to programmatic guaranteed deals.
+
+Args:
+  deal: string, Required. Format: `buyers/{accountId}/finalizedDeals/{dealId}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for setting ready to serve for a finalized deal.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A finalized deal is a snapshot of the deal when both buyer and seller accept the deal. The buyer or seller can update the deal after it's been finalized and renegotiate on the deal targeting, terms and other fields, while at the same time the finalized snapshot of the deal can still be retrieved using this API. The finalized deal contains a copy of the deal as it existed when most recently finalized, as well as fields related to deal serving such as pause/resume status, RTB metrics, and more.
+  "deal": { # A deal represents a segment of inventory for displaying ads that contains the terms and targeting information that is used for serving as well as the deal stats and status. Note: A proposal may contain multiple deals. # A copy of the Deal made upon finalization. During renegotiation, this will reflect the last finalized deal before renegotiation was initiated.
+    "billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer; when the deal belongs to a media planner account, this field will be empty. Format : `buyers/{buyerAccountId}`
+    "buyer": "A String", # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. Format: `buyers/{buyerAccountId}`
+    "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+    "createTime": "A String", # Output only. The time of the deal creation.
+    "creativeRequirements": { # Message captures data about the creatives in the deal. # Output only. Metadata about the creatives of this deal.
+      "creativeFormat": "A String", # Output only. The format of the creative, only applicable for programmatic guaranteed and preferred deals.
+      "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.
+      "creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.
+      "maxAdDurationMs": "A String", # Output only. The max duration of the video creative in milliseconds. only applicable for deals with video creatives.
+      "programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by the buyer.
+      "skippableAdType": "A String", # Output only. Skippable video ads allow viewers to skip ads after 5 seconds. Only applicable for deals with video creatives.
+    },
+    "dealType": "A String", # Output only. Type of deal.
+    "deliveryControl": { # Message contains details about how the deal will be paced. # Output only. Specifies the pacing set by the publisher.
+      "companionDeliveryType": "A String", # Output only. Specifies roadblocking in a main companion lineitem.
+      "creativeRotationType": "A String", # Output only. Specifies strategy to use for selecting a creative when multiple creatives of the same size are available.
+      "deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.
+      "frequencyCap": [ # Output only. Specifies any frequency caps. Cannot be filtered within ListDealsRequest.
+        { # Message contains details about publisher-set frequency caps of the delivery.
+          "maxImpressions": 42, # The maximum number of impressions that can be served to a user within the specified time period.
+          "timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped.
+          "timeUnitsCount": 42, # The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped.
+        },
+      ],
+      "roadblockingType": "A String", # Output only. Specifies the roadblocking type in display creatives.
+    },
+    "description": "A String", # Output only. Free text description for the deal terms.
+    "displayName": "A String", # Output only. The name of the deal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the deal.
+    "eligibleSeatIds": [ # Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.
+      "A String",
+    ],
+    "estimatedGrossSpend": { # Represents an amount of money with its currency type. # Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly.
+      "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.
+    },
+    "flightEndTime": "A String", # Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not necessary for Private Auction deals.
+    "flightStartTime": "A String", # Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (for example, in milliseconds) will be truncated towards the start of time in seconds.
+    "mediaPlanner": { # Describes a single Media Planner account. # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. This field represents a media planner (For example, agency or big advertiser).
+      "accountId": "A String", # Output only. Account ID of the media planner.
+    },
+    "name": "A String", # Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}
+    "preferredDealTerms": { # Pricing terms for Preferred Deals. # The terms for preferred deals.
+      "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+        "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+          "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.
+        },
+        "type": "A String", # The pricing type for the deal.
+      },
+    },
+    "privateAuctionTerms": { # Pricing terms for Private Auctions. # The terms for private auction deals.
+      "floorPrice": { # Represents a price and a pricing type for a deal. # The minimum price buyer has to bid to compete in the private auction.
+        "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+          "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.
+        },
+        "type": "A String", # The pricing type for the deal.
+      },
+      "openAuctionAllowed": True or False, # Output only. True if open auction buyers are allowed to compete with invited buyers in this private auction.
+    },
+    "programmaticGuaranteedTerms": { # Pricing terms for Programmatic Guaranteed Deals. # The terms for programmatic guaranteed deals.
+      "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+        "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+          "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.
+        },
+        "type": "A String", # The pricing type for the deal.
+      },
+      "guaranteedLooks": "A String", # Count of guaranteed looks. For CPD deals, buyer changes to guaranteed_looks will be ignored.
+      "impressionCap": "A String", # The lifetime impression cap for CPM Sponsorship deals. Deal will stop serving when cap is reached.
+      "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.
+      "percentShareOfVoice": "A String", # For sponsorship deals, this is the percentage of the seller's eligible impressions that the deal will serve until the cap is reached. Valid value is within range 0~100.
+      "reservationType": "A String", # The reservation type for a Programmatic Guaranteed deal. This indicates whether the number of impressions is fixed, or a percent of available impressions. If not specified, the default reservation type is STANDARD.
+    },
+    "proposalRevision": "A String", # Output only. The revision number for the proposal and is the same value as proposal.proposal_revision. Each update to deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.
+    "publisherProfile": "A String", # Immutable. Reference to the seller on the deal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}`
+    "sellerTimeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Output only. Time zone of the seller used to mark the boundaries of a day for daypart targeting and CPD billing.
+      "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
+      "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+    },
+    "targeting": { # Targeting represents different criteria that can be used to target deals or auction packages. For example, they can choose to target inventory only if the user is in the US. Multiple types of targeting are always applied as a logical AND, unless noted otherwise. # Specifies the subset of inventory targeted by the deal. Can be updated by the buyer before the deal is finalized.
+      "daypartTargeting": { # Represents Daypart targeting. # Daypart targeting information.
+        "dayParts": [ # The targeted weekdays and times
+          { # Defines targeting for a period of time on a specific week day.
+            "dayOfWeek": "A String", # Day of week for the period.
+            "endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+              "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+              "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+              "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+            "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+              "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+              "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+              "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+        ],
+        "timeZoneType": "A String", # The time zone type of the day parts
+      },
+      "excludedSensitiveCategoryIds": [ # Output only. The sensitive content category label IDs excluded. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs.
+        "A String",
+      ],
+      "geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. Geo criteria IDs to be included/excluded.
+        "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+          "A String",
+        ],
+        "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+          "A String",
+        ],
+      },
+      "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on a bid request. # Output only. Inventory sizes to be included/excluded.
+        "excludedInventorySizes": [ # A list of inventory sizes to be excluded.
+          { # Represents size of a single ad slot, or a creative.
+            "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+            "type": "A String", # The type of the ad slot size.
+            "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+          },
+        ],
+        "targetedInventorySizes": [ # A list of inventory sizes to be included.
+          { # Represents size of a single ad slot, or a creative.
+            "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+            "type": "A String", # The type of the ad slot size.
+            "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+          },
+        ],
+      },
+      "inventoryTypeTargeting": { # Targeting of the inventory types a bid request can originate from. # Output only. Inventory type targeting information.
+        "inventoryTypes": [ # The list of targeted inventory types for the bid request.
+          "A String",
+        ],
+      },
+      "placementTargeting": { # Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Output only. Placement targeting information, for example, URL, mobile applications.
+        "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages.
+          "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in.
+            "excludedAppIds": [ # A list of application IDs to be excluded.
+              "A String",
+            ],
+            "targetedAppIds": [ # A list of application IDs to be included.
+              "A String",
+            ],
+          },
+        },
+        "uriTargeting": { # Represents a list of targeted and excluded URLs (for example, google.com). For Private Auction Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded.
+          "excludedUris": [ # A list of URLs to be excluded.
+            "A String",
+          ],
+          "targetedUris": [ # A list of URLs to be included.
+            "A String",
+          ],
+        },
+      },
+      "technologyTargeting": { # Represents targeting about various types of technology. # Output only. Technology targeting information, for example, operating system, device category.
+        "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device capabilities to be included/excluded.
+          "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+            "A String",
+          ],
+          "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+            "A String",
+          ],
+        },
+        "deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device categories to be included/excluded.
+          "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+            "A String",
+          ],
+          "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+            "A String",
+          ],
+        },
+        "operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.
+          "operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating systems to be included/excluded.
+            "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+              "A String",
+            ],
+            "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+              "A String",
+            ],
+          },
+          "operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating system versions to be included/excluded.
+            "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+              "A String",
+            ],
+            "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+              "A String",
+            ],
+          },
+        },
+      },
+      "userListTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Buyer user list targeting information. User lists can be uploaded using https://developers.google.com/authorized-buyers/rtb/bulk-uploader.
+        "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+          "A String",
+        ],
+        "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+          "A String",
+        ],
+      },
+      "verticalTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. The verticals included or excluded as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals
+        "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+          "A String",
+        ],
+        "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+          "A String",
+        ],
+      },
+      "videoTargeting": { # Represents targeting information about video. # Output only. Video targeting information.
+        "excludedPositionTypes": [ # A list of video positions to be excluded. When this field is populated, the targeted_position_types field must be empty.
+          "A String",
+        ],
+        "targetedPositionTypes": [ # A list of video positions to be included. When this field is populated, the excluded_position_types field must be empty.
+          "A String",
+        ],
+      },
+    },
+    "updateTime": "A String", # Output only. The time when the deal was last updated.
+  },
+  "dealPausingInfo": { # Information related to deal pausing. # Information related to deal pausing for the deal.
+    "pauseReason": "A String", # The reason for the pausing of the deal; empty for active deals.
+    "pauseRole": "A String", # The party that first paused the deal; unspecified for active deals.
+    "pausingConsented": True or False, # Whether pausing is consented between buyer and seller for the deal.
+  },
+  "dealServingStatus": "A String", # Serving status of the deal.
+  "name": "A String", # The resource name of the finalized deal. Format: `buyers/{accountId}/finalizedDeals/{finalizedDealId}`
+  "readyToServe": True or False, # Whether the Programmatic Guaranteed deal is ready for serving.
+  "rtbMetrics": { # Real-time bidding metrics. For what each metric means refer to [Report metrics](https://support.google.com/adxbuyer/answer/6115195#report-metrics) # Real-time bidding metrics for this deal.
+    "adImpressions7Days": "A String", # Ad impressions in last 7 days.
+    "bidRate7Days": 3.14, # Bid rate in last 7 days, calculated by (bids / bid requests).
+    "bidRequests7Days": "A String", # Bid requests in last 7 days.
+    "bids7Days": "A String", # Bids in last 7 days.
+    "filteredBidRate7Days": 3.14, # Filtered bid rate in last 7 days, calculated by (filtered bids / bids).
+    "mustBidRateCurrentMonth": 3.14, # Must bid rate for current month.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.html b/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.html new file mode 100644 index 00000000000..0780b4d9f13 --- /dev/null +++ b/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.html @@ -0,0 +1,116 @@ + + + +

Authorized Buyers Marketplace API . buyers

+

Instance Methods

+

+ auctionPackages() +

+

Returns the auctionPackages Resource.

+ +

+ clients() +

+

Returns the clients Resource.

+ +

+ dataSegments() +

+

Returns the dataSegments Resource.

+ +

+ finalizedDeals() +

+

Returns the finalizedDeals Resource.

+ +

+ proposals() +

+

Returns the proposals Resource.

+ +

+ publisherProfiles() +

+

Returns the publisherProfiles Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.proposals.deals.html b/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.proposals.deals.html new file mode 100644 index 00000000000..1268be967fd --- /dev/null +++ b/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.proposals.deals.html @@ -0,0 +1,1532 @@ + + + +

Authorized Buyers Marketplace API . buyers . proposals . deals

+

Instance Methods

+

+ batchUpdate(parent, body=None, x__xgafv=None)

+

Batch updates multiple deals in the same proposal.

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Gets a deal given its name. The deal is returned at its head revision.

+

+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists all deals in a proposal. To retrieve only the finalized revision deals regardless if a deal is being renegotiated, see the FinalizedDeals resource.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(name, body=None, updateMask=None, x__xgafv=None)

+

Updates the given deal at the buyer known revision number. If the server revision has advanced since the passed-in proposal.proposal_revision an ABORTED error message will be returned. The revision number is incremented by the server whenever the proposal or its constituent deals are updated. Note: The revision number is kept at a proposal level. The buyer of the API is expected to keep track of the revision number after the last update operation and send it in as part of the next update request. This way, if there are further changes on the server (for example, seller making new updates), then the server can detect conflicts and reject the proposed changes.

+

Method Details

+
+ batchUpdate(parent, body=None, x__xgafv=None) +
Batch updates multiple deals in the same proposal.
+
+Args:
+  parent: string, Required. The name of the proposal containing the deals to batch update. Format: buyers/{accountId}/proposals/{proposalId} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for batch updating deals.
+  "requests": [ # Required. List of request messages to update deals.
+    { # Request message for updating the deal at the given revision number.
+      "deal": { # A deal represents a segment of inventory for displaying ads that contains the terms and targeting information that is used for serving as well as the deal stats and status. Note: A proposal may contain multiple deals. # Required. The deal to update. The deal's `name` field is used to identify the deal to be updated. Note: proposal_revision will have to be provided within the resource or else an error will be thrown. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}
+        "billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer; when the deal belongs to a media planner account, this field will be empty. Format : `buyers/{buyerAccountId}`
+        "buyer": "A String", # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. Format: `buyers/{buyerAccountId}`
+        "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+        "createTime": "A String", # Output only. The time of the deal creation.
+        "creativeRequirements": { # Message captures data about the creatives in the deal. # Output only. Metadata about the creatives of this deal.
+          "creativeFormat": "A String", # Output only. The format of the creative, only applicable for programmatic guaranteed and preferred deals.
+          "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.
+          "creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.
+          "maxAdDurationMs": "A String", # Output only. The max duration of the video creative in milliseconds. only applicable for deals with video creatives.
+          "programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by the buyer.
+          "skippableAdType": "A String", # Output only. Skippable video ads allow viewers to skip ads after 5 seconds. Only applicable for deals with video creatives.
+        },
+        "dealType": "A String", # Output only. Type of deal.
+        "deliveryControl": { # Message contains details about how the deal will be paced. # Output only. Specifies the pacing set by the publisher.
+          "companionDeliveryType": "A String", # Output only. Specifies roadblocking in a main companion lineitem.
+          "creativeRotationType": "A String", # Output only. Specifies strategy to use for selecting a creative when multiple creatives of the same size are available.
+          "deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.
+          "frequencyCap": [ # Output only. Specifies any frequency caps. Cannot be filtered within ListDealsRequest.
+            { # Message contains details about publisher-set frequency caps of the delivery.
+              "maxImpressions": 42, # The maximum number of impressions that can be served to a user within the specified time period.
+              "timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped.
+              "timeUnitsCount": 42, # The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped.
+            },
+          ],
+          "roadblockingType": "A String", # Output only. Specifies the roadblocking type in display creatives.
+        },
+        "description": "A String", # Output only. Free text description for the deal terms.
+        "displayName": "A String", # Output only. The name of the deal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the deal.
+        "eligibleSeatIds": [ # Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.
+          "A String",
+        ],
+        "estimatedGrossSpend": { # Represents an amount of money with its currency type. # Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly.
+          "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.
+        },
+        "flightEndTime": "A String", # Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not necessary for Private Auction deals.
+        "flightStartTime": "A String", # Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (for example, in milliseconds) will be truncated towards the start of time in seconds.
+        "mediaPlanner": { # Describes a single Media Planner account. # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. This field represents a media planner (For example, agency or big advertiser).
+          "accountId": "A String", # Output only. Account ID of the media planner.
+        },
+        "name": "A String", # Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}
+        "preferredDealTerms": { # Pricing terms for Preferred Deals. # The terms for preferred deals.
+          "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+            "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+              "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.
+            },
+            "type": "A String", # The pricing type for the deal.
+          },
+        },
+        "privateAuctionTerms": { # Pricing terms for Private Auctions. # The terms for private auction deals.
+          "floorPrice": { # Represents a price and a pricing type for a deal. # The minimum price buyer has to bid to compete in the private auction.
+            "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+              "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.
+            },
+            "type": "A String", # The pricing type for the deal.
+          },
+          "openAuctionAllowed": True or False, # Output only. True if open auction buyers are allowed to compete with invited buyers in this private auction.
+        },
+        "programmaticGuaranteedTerms": { # Pricing terms for Programmatic Guaranteed Deals. # The terms for programmatic guaranteed deals.
+          "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+            "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+              "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.
+            },
+            "type": "A String", # The pricing type for the deal.
+          },
+          "guaranteedLooks": "A String", # Count of guaranteed looks. For CPD deals, buyer changes to guaranteed_looks will be ignored.
+          "impressionCap": "A String", # The lifetime impression cap for CPM Sponsorship deals. Deal will stop serving when cap is reached.
+          "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.
+          "percentShareOfVoice": "A String", # For sponsorship deals, this is the percentage of the seller's eligible impressions that the deal will serve until the cap is reached. Valid value is within range 0~100.
+          "reservationType": "A String", # The reservation type for a Programmatic Guaranteed deal. This indicates whether the number of impressions is fixed, or a percent of available impressions. If not specified, the default reservation type is STANDARD.
+        },
+        "proposalRevision": "A String", # Output only. The revision number for the proposal and is the same value as proposal.proposal_revision. Each update to deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.
+        "publisherProfile": "A String", # Immutable. Reference to the seller on the deal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}`
+        "sellerTimeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Output only. Time zone of the seller used to mark the boundaries of a day for daypart targeting and CPD billing.
+          "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
+          "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+        },
+        "targeting": { # Targeting represents different criteria that can be used to target deals or auction packages. For example, they can choose to target inventory only if the user is in the US. Multiple types of targeting are always applied as a logical AND, unless noted otherwise. # Specifies the subset of inventory targeted by the deal. Can be updated by the buyer before the deal is finalized.
+          "daypartTargeting": { # Represents Daypart targeting. # Daypart targeting information.
+            "dayParts": [ # The targeted weekdays and times
+              { # Defines targeting for a period of time on a specific week day.
+                "dayOfWeek": "A String", # Day of week for the period.
+                "endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+                  "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+                  "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+                  "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+                  "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+                },
+                "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+                  "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+                  "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+                  "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+                  "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+                },
+              },
+            ],
+            "timeZoneType": "A String", # The time zone type of the day parts
+          },
+          "excludedSensitiveCategoryIds": [ # Output only. The sensitive content category label IDs excluded. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs.
+            "A String",
+          ],
+          "geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. Geo criteria IDs to be included/excluded.
+            "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+              "A String",
+            ],
+            "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+              "A String",
+            ],
+          },
+          "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on a bid request. # Output only. Inventory sizes to be included/excluded.
+            "excludedInventorySizes": [ # A list of inventory sizes to be excluded.
+              { # Represents size of a single ad slot, or a creative.
+                "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+                "type": "A String", # The type of the ad slot size.
+                "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+              },
+            ],
+            "targetedInventorySizes": [ # A list of inventory sizes to be included.
+              { # Represents size of a single ad slot, or a creative.
+                "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+                "type": "A String", # The type of the ad slot size.
+                "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+              },
+            ],
+          },
+          "inventoryTypeTargeting": { # Targeting of the inventory types a bid request can originate from. # Output only. Inventory type targeting information.
+            "inventoryTypes": [ # The list of targeted inventory types for the bid request.
+              "A String",
+            ],
+          },
+          "placementTargeting": { # Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Output only. Placement targeting information, for example, URL, mobile applications.
+            "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages.
+              "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in.
+                "excludedAppIds": [ # A list of application IDs to be excluded.
+                  "A String",
+                ],
+                "targetedAppIds": [ # A list of application IDs to be included.
+                  "A String",
+                ],
+              },
+            },
+            "uriTargeting": { # Represents a list of targeted and excluded URLs (for example, google.com). For Private Auction Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded.
+              "excludedUris": [ # A list of URLs to be excluded.
+                "A String",
+              ],
+              "targetedUris": [ # A list of URLs to be included.
+                "A String",
+              ],
+            },
+          },
+          "technologyTargeting": { # Represents targeting about various types of technology. # Output only. Technology targeting information, for example, operating system, device category.
+            "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device capabilities to be included/excluded.
+              "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+                "A String",
+              ],
+              "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+                "A String",
+              ],
+            },
+            "deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device categories to be included/excluded.
+              "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+                "A String",
+              ],
+              "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+                "A String",
+              ],
+            },
+            "operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.
+              "operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating systems to be included/excluded.
+                "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+                  "A String",
+                ],
+                "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+                  "A String",
+                ],
+              },
+              "operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating system versions to be included/excluded.
+                "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+                  "A String",
+                ],
+                "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+                  "A String",
+                ],
+              },
+            },
+          },
+          "userListTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Buyer user list targeting information. User lists can be uploaded using https://developers.google.com/authorized-buyers/rtb/bulk-uploader.
+            "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+              "A String",
+            ],
+            "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+              "A String",
+            ],
+          },
+          "verticalTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. The verticals included or excluded as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals
+            "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+              "A String",
+            ],
+            "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+              "A String",
+            ],
+          },
+          "videoTargeting": { # Represents targeting information about video. # Output only. Video targeting information.
+            "excludedPositionTypes": [ # A list of video positions to be excluded. When this field is populated, the targeted_position_types field must be empty.
+              "A String",
+            ],
+            "targetedPositionTypes": [ # A list of video positions to be included. When this field is populated, the excluded_position_types field must be empty.
+              "A String",
+            ],
+          },
+        },
+        "updateTime": "A String", # Output only. The time when the deal was last updated.
+      },
+      "updateMask": "A String", # List of fields to be updated. If empty or unspecified, the service will update all fields populated in the update request excluding the output only fields and primitive fields with default value. Note that explicit field mask is required in order to reset a primitive field back to its default value, for example, false for boolean fields, 0 for integer fields. A special field mask consisting of a single path "*" can be used to indicate full replacement(the equivalent of PUT method), updatable fields unset or unspecified in the input will be cleared or set to default value. Output only fields will be ignored regardless of the value of updateMask.
+    },
+  ],
+}
+
+  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 batch updating deals.
+  "deals": [ # Deals updated.
+    { # A deal represents a segment of inventory for displaying ads that contains the terms and targeting information that is used for serving as well as the deal stats and status. Note: A proposal may contain multiple deals.
+      "billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer; when the deal belongs to a media planner account, this field will be empty. Format : `buyers/{buyerAccountId}`
+      "buyer": "A String", # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. Format: `buyers/{buyerAccountId}`
+      "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+      "createTime": "A String", # Output only. The time of the deal creation.
+      "creativeRequirements": { # Message captures data about the creatives in the deal. # Output only. Metadata about the creatives of this deal.
+        "creativeFormat": "A String", # Output only. The format of the creative, only applicable for programmatic guaranteed and preferred deals.
+        "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.
+        "creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.
+        "maxAdDurationMs": "A String", # Output only. The max duration of the video creative in milliseconds. only applicable for deals with video creatives.
+        "programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by the buyer.
+        "skippableAdType": "A String", # Output only. Skippable video ads allow viewers to skip ads after 5 seconds. Only applicable for deals with video creatives.
+      },
+      "dealType": "A String", # Output only. Type of deal.
+      "deliveryControl": { # Message contains details about how the deal will be paced. # Output only. Specifies the pacing set by the publisher.
+        "companionDeliveryType": "A String", # Output only. Specifies roadblocking in a main companion lineitem.
+        "creativeRotationType": "A String", # Output only. Specifies strategy to use for selecting a creative when multiple creatives of the same size are available.
+        "deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.
+        "frequencyCap": [ # Output only. Specifies any frequency caps. Cannot be filtered within ListDealsRequest.
+          { # Message contains details about publisher-set frequency caps of the delivery.
+            "maxImpressions": 42, # The maximum number of impressions that can be served to a user within the specified time period.
+            "timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped.
+            "timeUnitsCount": 42, # The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped.
+          },
+        ],
+        "roadblockingType": "A String", # Output only. Specifies the roadblocking type in display creatives.
+      },
+      "description": "A String", # Output only. Free text description for the deal terms.
+      "displayName": "A String", # Output only. The name of the deal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the deal.
+      "eligibleSeatIds": [ # Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.
+        "A String",
+      ],
+      "estimatedGrossSpend": { # Represents an amount of money with its currency type. # Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly.
+        "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.
+      },
+      "flightEndTime": "A String", # Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not necessary for Private Auction deals.
+      "flightStartTime": "A String", # Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (for example, in milliseconds) will be truncated towards the start of time in seconds.
+      "mediaPlanner": { # Describes a single Media Planner account. # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. This field represents a media planner (For example, agency or big advertiser).
+        "accountId": "A String", # Output only. Account ID of the media planner.
+      },
+      "name": "A String", # Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}
+      "preferredDealTerms": { # Pricing terms for Preferred Deals. # The terms for preferred deals.
+        "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+          "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+            "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.
+          },
+          "type": "A String", # The pricing type for the deal.
+        },
+      },
+      "privateAuctionTerms": { # Pricing terms for Private Auctions. # The terms for private auction deals.
+        "floorPrice": { # Represents a price and a pricing type for a deal. # The minimum price buyer has to bid to compete in the private auction.
+          "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+            "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.
+          },
+          "type": "A String", # The pricing type for the deal.
+        },
+        "openAuctionAllowed": True or False, # Output only. True if open auction buyers are allowed to compete with invited buyers in this private auction.
+      },
+      "programmaticGuaranteedTerms": { # Pricing terms for Programmatic Guaranteed Deals. # The terms for programmatic guaranteed deals.
+        "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+          "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+            "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.
+          },
+          "type": "A String", # The pricing type for the deal.
+        },
+        "guaranteedLooks": "A String", # Count of guaranteed looks. For CPD deals, buyer changes to guaranteed_looks will be ignored.
+        "impressionCap": "A String", # The lifetime impression cap for CPM Sponsorship deals. Deal will stop serving when cap is reached.
+        "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.
+        "percentShareOfVoice": "A String", # For sponsorship deals, this is the percentage of the seller's eligible impressions that the deal will serve until the cap is reached. Valid value is within range 0~100.
+        "reservationType": "A String", # The reservation type for a Programmatic Guaranteed deal. This indicates whether the number of impressions is fixed, or a percent of available impressions. If not specified, the default reservation type is STANDARD.
+      },
+      "proposalRevision": "A String", # Output only. The revision number for the proposal and is the same value as proposal.proposal_revision. Each update to deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.
+      "publisherProfile": "A String", # Immutable. Reference to the seller on the deal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}`
+      "sellerTimeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Output only. Time zone of the seller used to mark the boundaries of a day for daypart targeting and CPD billing.
+        "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
+        "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+      },
+      "targeting": { # Targeting represents different criteria that can be used to target deals or auction packages. For example, they can choose to target inventory only if the user is in the US. Multiple types of targeting are always applied as a logical AND, unless noted otherwise. # Specifies the subset of inventory targeted by the deal. Can be updated by the buyer before the deal is finalized.
+        "daypartTargeting": { # Represents Daypart targeting. # Daypart targeting information.
+          "dayParts": [ # The targeted weekdays and times
+            { # Defines targeting for a period of time on a specific week day.
+              "dayOfWeek": "A String", # Day of week for the period.
+              "endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+                "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+                "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+                "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+                "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+              },
+              "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+                "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+                "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+                "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+                "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+              },
+            },
+          ],
+          "timeZoneType": "A String", # The time zone type of the day parts
+        },
+        "excludedSensitiveCategoryIds": [ # Output only. The sensitive content category label IDs excluded. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs.
+          "A String",
+        ],
+        "geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. Geo criteria IDs to be included/excluded.
+          "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+            "A String",
+          ],
+          "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+            "A String",
+          ],
+        },
+        "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on a bid request. # Output only. Inventory sizes to be included/excluded.
+          "excludedInventorySizes": [ # A list of inventory sizes to be excluded.
+            { # Represents size of a single ad slot, or a creative.
+              "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+              "type": "A String", # The type of the ad slot size.
+              "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+            },
+          ],
+          "targetedInventorySizes": [ # A list of inventory sizes to be included.
+            { # Represents size of a single ad slot, or a creative.
+              "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+              "type": "A String", # The type of the ad slot size.
+              "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+            },
+          ],
+        },
+        "inventoryTypeTargeting": { # Targeting of the inventory types a bid request can originate from. # Output only. Inventory type targeting information.
+          "inventoryTypes": [ # The list of targeted inventory types for the bid request.
+            "A String",
+          ],
+        },
+        "placementTargeting": { # Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Output only. Placement targeting information, for example, URL, mobile applications.
+          "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages.
+            "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in.
+              "excludedAppIds": [ # A list of application IDs to be excluded.
+                "A String",
+              ],
+              "targetedAppIds": [ # A list of application IDs to be included.
+                "A String",
+              ],
+            },
+          },
+          "uriTargeting": { # Represents a list of targeted and excluded URLs (for example, google.com). For Private Auction Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded.
+            "excludedUris": [ # A list of URLs to be excluded.
+              "A String",
+            ],
+            "targetedUris": [ # A list of URLs to be included.
+              "A String",
+            ],
+          },
+        },
+        "technologyTargeting": { # Represents targeting about various types of technology. # Output only. Technology targeting information, for example, operating system, device category.
+          "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device capabilities to be included/excluded.
+            "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+              "A String",
+            ],
+            "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+              "A String",
+            ],
+          },
+          "deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device categories to be included/excluded.
+            "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+              "A String",
+            ],
+            "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+              "A String",
+            ],
+          },
+          "operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.
+            "operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating systems to be included/excluded.
+              "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+                "A String",
+              ],
+              "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+                "A String",
+              ],
+            },
+            "operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating system versions to be included/excluded.
+              "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+                "A String",
+              ],
+              "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+                "A String",
+              ],
+            },
+          },
+        },
+        "userListTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Buyer user list targeting information. User lists can be uploaded using https://developers.google.com/authorized-buyers/rtb/bulk-uploader.
+          "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+            "A String",
+          ],
+          "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+            "A String",
+          ],
+        },
+        "verticalTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. The verticals included or excluded as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals
+          "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+            "A String",
+          ],
+          "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+            "A String",
+          ],
+        },
+        "videoTargeting": { # Represents targeting information about video. # Output only. Video targeting information.
+          "excludedPositionTypes": [ # A list of video positions to be excluded. When this field is populated, the targeted_position_types field must be empty.
+            "A String",
+          ],
+          "targetedPositionTypes": [ # A list of video positions to be included. When this field is populated, the excluded_position_types field must be empty.
+            "A String",
+          ],
+        },
+      },
+      "updateTime": "A String", # Output only. The time when the deal was last updated.
+    },
+  ],
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Gets a deal given its name. The deal is returned at its head revision.
+
+Args:
+  name: string, Required. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId} (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A deal represents a segment of inventory for displaying ads that contains the terms and targeting information that is used for serving as well as the deal stats and status. Note: A proposal may contain multiple deals.
+  "billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer; when the deal belongs to a media planner account, this field will be empty. Format : `buyers/{buyerAccountId}`
+  "buyer": "A String", # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. Format: `buyers/{buyerAccountId}`
+  "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+  "createTime": "A String", # Output only. The time of the deal creation.
+  "creativeRequirements": { # Message captures data about the creatives in the deal. # Output only. Metadata about the creatives of this deal.
+    "creativeFormat": "A String", # Output only. The format of the creative, only applicable for programmatic guaranteed and preferred deals.
+    "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.
+    "creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.
+    "maxAdDurationMs": "A String", # Output only. The max duration of the video creative in milliseconds. only applicable for deals with video creatives.
+    "programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by the buyer.
+    "skippableAdType": "A String", # Output only. Skippable video ads allow viewers to skip ads after 5 seconds. Only applicable for deals with video creatives.
+  },
+  "dealType": "A String", # Output only. Type of deal.
+  "deliveryControl": { # Message contains details about how the deal will be paced. # Output only. Specifies the pacing set by the publisher.
+    "companionDeliveryType": "A String", # Output only. Specifies roadblocking in a main companion lineitem.
+    "creativeRotationType": "A String", # Output only. Specifies strategy to use for selecting a creative when multiple creatives of the same size are available.
+    "deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.
+    "frequencyCap": [ # Output only. Specifies any frequency caps. Cannot be filtered within ListDealsRequest.
+      { # Message contains details about publisher-set frequency caps of the delivery.
+        "maxImpressions": 42, # The maximum number of impressions that can be served to a user within the specified time period.
+        "timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped.
+        "timeUnitsCount": 42, # The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped.
+      },
+    ],
+    "roadblockingType": "A String", # Output only. Specifies the roadblocking type in display creatives.
+  },
+  "description": "A String", # Output only. Free text description for the deal terms.
+  "displayName": "A String", # Output only. The name of the deal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the deal.
+  "eligibleSeatIds": [ # Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.
+    "A String",
+  ],
+  "estimatedGrossSpend": { # Represents an amount of money with its currency type. # Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly.
+    "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.
+  },
+  "flightEndTime": "A String", # Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not necessary for Private Auction deals.
+  "flightStartTime": "A String", # Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (for example, in milliseconds) will be truncated towards the start of time in seconds.
+  "mediaPlanner": { # Describes a single Media Planner account. # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. This field represents a media planner (For example, agency or big advertiser).
+    "accountId": "A String", # Output only. Account ID of the media planner.
+  },
+  "name": "A String", # Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}
+  "preferredDealTerms": { # Pricing terms for Preferred Deals. # The terms for preferred deals.
+    "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+      "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+        "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.
+      },
+      "type": "A String", # The pricing type for the deal.
+    },
+  },
+  "privateAuctionTerms": { # Pricing terms for Private Auctions. # The terms for private auction deals.
+    "floorPrice": { # Represents a price and a pricing type for a deal. # The minimum price buyer has to bid to compete in the private auction.
+      "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+        "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.
+      },
+      "type": "A String", # The pricing type for the deal.
+    },
+    "openAuctionAllowed": True or False, # Output only. True if open auction buyers are allowed to compete with invited buyers in this private auction.
+  },
+  "programmaticGuaranteedTerms": { # Pricing terms for Programmatic Guaranteed Deals. # The terms for programmatic guaranteed deals.
+    "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+      "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+        "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.
+      },
+      "type": "A String", # The pricing type for the deal.
+    },
+    "guaranteedLooks": "A String", # Count of guaranteed looks. For CPD deals, buyer changes to guaranteed_looks will be ignored.
+    "impressionCap": "A String", # The lifetime impression cap for CPM Sponsorship deals. Deal will stop serving when cap is reached.
+    "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.
+    "percentShareOfVoice": "A String", # For sponsorship deals, this is the percentage of the seller's eligible impressions that the deal will serve until the cap is reached. Valid value is within range 0~100.
+    "reservationType": "A String", # The reservation type for a Programmatic Guaranteed deal. This indicates whether the number of impressions is fixed, or a percent of available impressions. If not specified, the default reservation type is STANDARD.
+  },
+  "proposalRevision": "A String", # Output only. The revision number for the proposal and is the same value as proposal.proposal_revision. Each update to deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.
+  "publisherProfile": "A String", # Immutable. Reference to the seller on the deal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}`
+  "sellerTimeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Output only. Time zone of the seller used to mark the boundaries of a day for daypart targeting and CPD billing.
+    "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
+    "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+  },
+  "targeting": { # Targeting represents different criteria that can be used to target deals or auction packages. For example, they can choose to target inventory only if the user is in the US. Multiple types of targeting are always applied as a logical AND, unless noted otherwise. # Specifies the subset of inventory targeted by the deal. Can be updated by the buyer before the deal is finalized.
+    "daypartTargeting": { # Represents Daypart targeting. # Daypart targeting information.
+      "dayParts": [ # The targeted weekdays and times
+        { # Defines targeting for a period of time on a specific week day.
+          "dayOfWeek": "A String", # Day of week for the period.
+          "endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+            "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+            "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+            "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+            "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+          },
+          "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+            "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+            "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+            "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+            "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+          },
+        },
+      ],
+      "timeZoneType": "A String", # The time zone type of the day parts
+    },
+    "excludedSensitiveCategoryIds": [ # Output only. The sensitive content category label IDs excluded. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs.
+      "A String",
+    ],
+    "geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. Geo criteria IDs to be included/excluded.
+      "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+        "A String",
+      ],
+      "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+        "A String",
+      ],
+    },
+    "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on a bid request. # Output only. Inventory sizes to be included/excluded.
+      "excludedInventorySizes": [ # A list of inventory sizes to be excluded.
+        { # Represents size of a single ad slot, or a creative.
+          "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+          "type": "A String", # The type of the ad slot size.
+          "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+        },
+      ],
+      "targetedInventorySizes": [ # A list of inventory sizes to be included.
+        { # Represents size of a single ad slot, or a creative.
+          "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+          "type": "A String", # The type of the ad slot size.
+          "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+        },
+      ],
+    },
+    "inventoryTypeTargeting": { # Targeting of the inventory types a bid request can originate from. # Output only. Inventory type targeting information.
+      "inventoryTypes": [ # The list of targeted inventory types for the bid request.
+        "A String",
+      ],
+    },
+    "placementTargeting": { # Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Output only. Placement targeting information, for example, URL, mobile applications.
+      "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages.
+        "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in.
+          "excludedAppIds": [ # A list of application IDs to be excluded.
+            "A String",
+          ],
+          "targetedAppIds": [ # A list of application IDs to be included.
+            "A String",
+          ],
+        },
+      },
+      "uriTargeting": { # Represents a list of targeted and excluded URLs (for example, google.com). For Private Auction Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded.
+        "excludedUris": [ # A list of URLs to be excluded.
+          "A String",
+        ],
+        "targetedUris": [ # A list of URLs to be included.
+          "A String",
+        ],
+      },
+    },
+    "technologyTargeting": { # Represents targeting about various types of technology. # Output only. Technology targeting information, for example, operating system, device category.
+      "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device capabilities to be included/excluded.
+        "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+          "A String",
+        ],
+        "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+          "A String",
+        ],
+      },
+      "deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device categories to be included/excluded.
+        "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+          "A String",
+        ],
+        "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+          "A String",
+        ],
+      },
+      "operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.
+        "operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating systems to be included/excluded.
+          "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+            "A String",
+          ],
+          "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+            "A String",
+          ],
+        },
+        "operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating system versions to be included/excluded.
+          "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+            "A String",
+          ],
+          "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+            "A String",
+          ],
+        },
+      },
+    },
+    "userListTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Buyer user list targeting information. User lists can be uploaded using https://developers.google.com/authorized-buyers/rtb/bulk-uploader.
+      "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+        "A String",
+      ],
+      "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+        "A String",
+      ],
+    },
+    "verticalTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. The verticals included or excluded as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals
+      "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+        "A String",
+      ],
+      "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+        "A String",
+      ],
+    },
+    "videoTargeting": { # Represents targeting information about video. # Output only. Video targeting information.
+      "excludedPositionTypes": [ # A list of video positions to be excluded. When this field is populated, the targeted_position_types field must be empty.
+        "A String",
+      ],
+      "targetedPositionTypes": [ # A list of video positions to be included. When this field is populated, the excluded_position_types field must be empty.
+        "A String",
+      ],
+    },
+  },
+  "updateTime": "A String", # Output only. The time when the deal was last updated.
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Lists all deals in a proposal. To retrieve only the finalized revision deals regardless if a deal is being renegotiated, see the FinalizedDeals resource.
+
+Args:
+  parent: string, Required. The name of the proposal containing the deals to retrieve. Format: buyers/{accountId}/proposals/{proposalId} (required)
+  pageSize: integer, Requested page size. The server may return fewer results than requested. If requested more than 500, the server will return 500 results per page. If unspecified, the server will pick a default page size of 100.
+  pageToken: string, The page token as returned from ListDealsResponse.
+  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 listing deals in a proposal.
+  "deals": [ # The list of deals.
+    { # A deal represents a segment of inventory for displaying ads that contains the terms and targeting information that is used for serving as well as the deal stats and status. Note: A proposal may contain multiple deals.
+      "billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer; when the deal belongs to a media planner account, this field will be empty. Format : `buyers/{buyerAccountId}`
+      "buyer": "A String", # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. Format: `buyers/{buyerAccountId}`
+      "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+      "createTime": "A String", # Output only. The time of the deal creation.
+      "creativeRequirements": { # Message captures data about the creatives in the deal. # Output only. Metadata about the creatives of this deal.
+        "creativeFormat": "A String", # Output only. The format of the creative, only applicable for programmatic guaranteed and preferred deals.
+        "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.
+        "creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.
+        "maxAdDurationMs": "A String", # Output only. The max duration of the video creative in milliseconds. only applicable for deals with video creatives.
+        "programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by the buyer.
+        "skippableAdType": "A String", # Output only. Skippable video ads allow viewers to skip ads after 5 seconds. Only applicable for deals with video creatives.
+      },
+      "dealType": "A String", # Output only. Type of deal.
+      "deliveryControl": { # Message contains details about how the deal will be paced. # Output only. Specifies the pacing set by the publisher.
+        "companionDeliveryType": "A String", # Output only. Specifies roadblocking in a main companion lineitem.
+        "creativeRotationType": "A String", # Output only. Specifies strategy to use for selecting a creative when multiple creatives of the same size are available.
+        "deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.
+        "frequencyCap": [ # Output only. Specifies any frequency caps. Cannot be filtered within ListDealsRequest.
+          { # Message contains details about publisher-set frequency caps of the delivery.
+            "maxImpressions": 42, # The maximum number of impressions that can be served to a user within the specified time period.
+            "timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped.
+            "timeUnitsCount": 42, # The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped.
+          },
+        ],
+        "roadblockingType": "A String", # Output only. Specifies the roadblocking type in display creatives.
+      },
+      "description": "A String", # Output only. Free text description for the deal terms.
+      "displayName": "A String", # Output only. The name of the deal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the deal.
+      "eligibleSeatIds": [ # Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.
+        "A String",
+      ],
+      "estimatedGrossSpend": { # Represents an amount of money with its currency type. # Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly.
+        "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.
+      },
+      "flightEndTime": "A String", # Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not necessary for Private Auction deals.
+      "flightStartTime": "A String", # Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (for example, in milliseconds) will be truncated towards the start of time in seconds.
+      "mediaPlanner": { # Describes a single Media Planner account. # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. This field represents a media planner (For example, agency or big advertiser).
+        "accountId": "A String", # Output only. Account ID of the media planner.
+      },
+      "name": "A String", # Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}
+      "preferredDealTerms": { # Pricing terms for Preferred Deals. # The terms for preferred deals.
+        "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+          "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+            "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.
+          },
+          "type": "A String", # The pricing type for the deal.
+        },
+      },
+      "privateAuctionTerms": { # Pricing terms for Private Auctions. # The terms for private auction deals.
+        "floorPrice": { # Represents a price and a pricing type for a deal. # The minimum price buyer has to bid to compete in the private auction.
+          "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+            "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.
+          },
+          "type": "A String", # The pricing type for the deal.
+        },
+        "openAuctionAllowed": True or False, # Output only. True if open auction buyers are allowed to compete with invited buyers in this private auction.
+      },
+      "programmaticGuaranteedTerms": { # Pricing terms for Programmatic Guaranteed Deals. # The terms for programmatic guaranteed deals.
+        "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+          "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+            "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.
+          },
+          "type": "A String", # The pricing type for the deal.
+        },
+        "guaranteedLooks": "A String", # Count of guaranteed looks. For CPD deals, buyer changes to guaranteed_looks will be ignored.
+        "impressionCap": "A String", # The lifetime impression cap for CPM Sponsorship deals. Deal will stop serving when cap is reached.
+        "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.
+        "percentShareOfVoice": "A String", # For sponsorship deals, this is the percentage of the seller's eligible impressions that the deal will serve until the cap is reached. Valid value is within range 0~100.
+        "reservationType": "A String", # The reservation type for a Programmatic Guaranteed deal. This indicates whether the number of impressions is fixed, or a percent of available impressions. If not specified, the default reservation type is STANDARD.
+      },
+      "proposalRevision": "A String", # Output only. The revision number for the proposal and is the same value as proposal.proposal_revision. Each update to deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.
+      "publisherProfile": "A String", # Immutable. Reference to the seller on the deal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}`
+      "sellerTimeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Output only. Time zone of the seller used to mark the boundaries of a day for daypart targeting and CPD billing.
+        "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
+        "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+      },
+      "targeting": { # Targeting represents different criteria that can be used to target deals or auction packages. For example, they can choose to target inventory only if the user is in the US. Multiple types of targeting are always applied as a logical AND, unless noted otherwise. # Specifies the subset of inventory targeted by the deal. Can be updated by the buyer before the deal is finalized.
+        "daypartTargeting": { # Represents Daypart targeting. # Daypart targeting information.
+          "dayParts": [ # The targeted weekdays and times
+            { # Defines targeting for a period of time on a specific week day.
+              "dayOfWeek": "A String", # Day of week for the period.
+              "endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+                "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+                "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+                "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+                "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+              },
+              "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+                "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+                "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+                "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+                "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+              },
+            },
+          ],
+          "timeZoneType": "A String", # The time zone type of the day parts
+        },
+        "excludedSensitiveCategoryIds": [ # Output only. The sensitive content category label IDs excluded. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs.
+          "A String",
+        ],
+        "geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. Geo criteria IDs to be included/excluded.
+          "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+            "A String",
+          ],
+          "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+            "A String",
+          ],
+        },
+        "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on a bid request. # Output only. Inventory sizes to be included/excluded.
+          "excludedInventorySizes": [ # A list of inventory sizes to be excluded.
+            { # Represents size of a single ad slot, or a creative.
+              "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+              "type": "A String", # The type of the ad slot size.
+              "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+            },
+          ],
+          "targetedInventorySizes": [ # A list of inventory sizes to be included.
+            { # Represents size of a single ad slot, or a creative.
+              "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+              "type": "A String", # The type of the ad slot size.
+              "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+            },
+          ],
+        },
+        "inventoryTypeTargeting": { # Targeting of the inventory types a bid request can originate from. # Output only. Inventory type targeting information.
+          "inventoryTypes": [ # The list of targeted inventory types for the bid request.
+            "A String",
+          ],
+        },
+        "placementTargeting": { # Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Output only. Placement targeting information, for example, URL, mobile applications.
+          "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages.
+            "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in.
+              "excludedAppIds": [ # A list of application IDs to be excluded.
+                "A String",
+              ],
+              "targetedAppIds": [ # A list of application IDs to be included.
+                "A String",
+              ],
+            },
+          },
+          "uriTargeting": { # Represents a list of targeted and excluded URLs (for example, google.com). For Private Auction Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded.
+            "excludedUris": [ # A list of URLs to be excluded.
+              "A String",
+            ],
+            "targetedUris": [ # A list of URLs to be included.
+              "A String",
+            ],
+          },
+        },
+        "technologyTargeting": { # Represents targeting about various types of technology. # Output only. Technology targeting information, for example, operating system, device category.
+          "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device capabilities to be included/excluded.
+            "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+              "A String",
+            ],
+            "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+              "A String",
+            ],
+          },
+          "deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device categories to be included/excluded.
+            "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+              "A String",
+            ],
+            "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+              "A String",
+            ],
+          },
+          "operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.
+            "operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating systems to be included/excluded.
+              "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+                "A String",
+              ],
+              "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+                "A String",
+              ],
+            },
+            "operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating system versions to be included/excluded.
+              "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+                "A String",
+              ],
+              "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+                "A String",
+              ],
+            },
+          },
+        },
+        "userListTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Buyer user list targeting information. User lists can be uploaded using https://developers.google.com/authorized-buyers/rtb/bulk-uploader.
+          "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+            "A String",
+          ],
+          "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+            "A String",
+          ],
+        },
+        "verticalTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. The verticals included or excluded as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals
+          "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+            "A String",
+          ],
+          "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+            "A String",
+          ],
+        },
+        "videoTargeting": { # Represents targeting information about video. # Output only. Video targeting information.
+          "excludedPositionTypes": [ # A list of video positions to be excluded. When this field is populated, the targeted_position_types field must be empty.
+            "A String",
+          ],
+          "targetedPositionTypes": [ # A list of video positions to be included. When this field is populated, the excluded_position_types field must be empty.
+            "A String",
+          ],
+        },
+      },
+      "updateTime": "A String", # Output only. The time when the deal was last updated.
+    },
+  ],
+  "nextPageToken": "A String", # Token to fetch the next page of results.
+}
+
+ +
+ 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, body=None, updateMask=None, x__xgafv=None) +
Updates the given deal at the buyer known revision number. If the server revision has advanced since the passed-in proposal.proposal_revision an ABORTED error message will be returned. The revision number is incremented by the server whenever the proposal or its constituent deals are updated. Note: The revision number is kept at a proposal level. The buyer of the API is expected to keep track of the revision number after the last update operation and send it in as part of the next update request. This way, if there are further changes on the server (for example, seller making new updates), then the server can detect conflicts and reject the proposed changes.
+
+Args:
+  name: string, Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A deal represents a segment of inventory for displaying ads that contains the terms and targeting information that is used for serving as well as the deal stats and status. Note: A proposal may contain multiple deals.
+  "billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer; when the deal belongs to a media planner account, this field will be empty. Format : `buyers/{buyerAccountId}`
+  "buyer": "A String", # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. Format: `buyers/{buyerAccountId}`
+  "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+  "createTime": "A String", # Output only. The time of the deal creation.
+  "creativeRequirements": { # Message captures data about the creatives in the deal. # Output only. Metadata about the creatives of this deal.
+    "creativeFormat": "A String", # Output only. The format of the creative, only applicable for programmatic guaranteed and preferred deals.
+    "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.
+    "creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.
+    "maxAdDurationMs": "A String", # Output only. The max duration of the video creative in milliseconds. only applicable for deals with video creatives.
+    "programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by the buyer.
+    "skippableAdType": "A String", # Output only. Skippable video ads allow viewers to skip ads after 5 seconds. Only applicable for deals with video creatives.
+  },
+  "dealType": "A String", # Output only. Type of deal.
+  "deliveryControl": { # Message contains details about how the deal will be paced. # Output only. Specifies the pacing set by the publisher.
+    "companionDeliveryType": "A String", # Output only. Specifies roadblocking in a main companion lineitem.
+    "creativeRotationType": "A String", # Output only. Specifies strategy to use for selecting a creative when multiple creatives of the same size are available.
+    "deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.
+    "frequencyCap": [ # Output only. Specifies any frequency caps. Cannot be filtered within ListDealsRequest.
+      { # Message contains details about publisher-set frequency caps of the delivery.
+        "maxImpressions": 42, # The maximum number of impressions that can be served to a user within the specified time period.
+        "timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped.
+        "timeUnitsCount": 42, # The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped.
+      },
+    ],
+    "roadblockingType": "A String", # Output only. Specifies the roadblocking type in display creatives.
+  },
+  "description": "A String", # Output only. Free text description for the deal terms.
+  "displayName": "A String", # Output only. The name of the deal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the deal.
+  "eligibleSeatIds": [ # Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.
+    "A String",
+  ],
+  "estimatedGrossSpend": { # Represents an amount of money with its currency type. # Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly.
+    "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.
+  },
+  "flightEndTime": "A String", # Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not necessary for Private Auction deals.
+  "flightStartTime": "A String", # Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (for example, in milliseconds) will be truncated towards the start of time in seconds.
+  "mediaPlanner": { # Describes a single Media Planner account. # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. This field represents a media planner (For example, agency or big advertiser).
+    "accountId": "A String", # Output only. Account ID of the media planner.
+  },
+  "name": "A String", # Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}
+  "preferredDealTerms": { # Pricing terms for Preferred Deals. # The terms for preferred deals.
+    "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+      "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+        "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.
+      },
+      "type": "A String", # The pricing type for the deal.
+    },
+  },
+  "privateAuctionTerms": { # Pricing terms for Private Auctions. # The terms for private auction deals.
+    "floorPrice": { # Represents a price and a pricing type for a deal. # The minimum price buyer has to bid to compete in the private auction.
+      "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+        "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.
+      },
+      "type": "A String", # The pricing type for the deal.
+    },
+    "openAuctionAllowed": True or False, # Output only. True if open auction buyers are allowed to compete with invited buyers in this private auction.
+  },
+  "programmaticGuaranteedTerms": { # Pricing terms for Programmatic Guaranteed Deals. # The terms for programmatic guaranteed deals.
+    "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+      "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+        "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.
+      },
+      "type": "A String", # The pricing type for the deal.
+    },
+    "guaranteedLooks": "A String", # Count of guaranteed looks. For CPD deals, buyer changes to guaranteed_looks will be ignored.
+    "impressionCap": "A String", # The lifetime impression cap for CPM Sponsorship deals. Deal will stop serving when cap is reached.
+    "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.
+    "percentShareOfVoice": "A String", # For sponsorship deals, this is the percentage of the seller's eligible impressions that the deal will serve until the cap is reached. Valid value is within range 0~100.
+    "reservationType": "A String", # The reservation type for a Programmatic Guaranteed deal. This indicates whether the number of impressions is fixed, or a percent of available impressions. If not specified, the default reservation type is STANDARD.
+  },
+  "proposalRevision": "A String", # Output only. The revision number for the proposal and is the same value as proposal.proposal_revision. Each update to deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.
+  "publisherProfile": "A String", # Immutable. Reference to the seller on the deal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}`
+  "sellerTimeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Output only. Time zone of the seller used to mark the boundaries of a day for daypart targeting and CPD billing.
+    "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
+    "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+  },
+  "targeting": { # Targeting represents different criteria that can be used to target deals or auction packages. For example, they can choose to target inventory only if the user is in the US. Multiple types of targeting are always applied as a logical AND, unless noted otherwise. # Specifies the subset of inventory targeted by the deal. Can be updated by the buyer before the deal is finalized.
+    "daypartTargeting": { # Represents Daypart targeting. # Daypart targeting information.
+      "dayParts": [ # The targeted weekdays and times
+        { # Defines targeting for a period of time on a specific week day.
+          "dayOfWeek": "A String", # Day of week for the period.
+          "endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+            "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+            "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+            "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+            "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+          },
+          "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+            "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+            "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+            "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+            "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+          },
+        },
+      ],
+      "timeZoneType": "A String", # The time zone type of the day parts
+    },
+    "excludedSensitiveCategoryIds": [ # Output only. The sensitive content category label IDs excluded. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs.
+      "A String",
+    ],
+    "geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. Geo criteria IDs to be included/excluded.
+      "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+        "A String",
+      ],
+      "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+        "A String",
+      ],
+    },
+    "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on a bid request. # Output only. Inventory sizes to be included/excluded.
+      "excludedInventorySizes": [ # A list of inventory sizes to be excluded.
+        { # Represents size of a single ad slot, or a creative.
+          "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+          "type": "A String", # The type of the ad slot size.
+          "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+        },
+      ],
+      "targetedInventorySizes": [ # A list of inventory sizes to be included.
+        { # Represents size of a single ad slot, or a creative.
+          "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+          "type": "A String", # The type of the ad slot size.
+          "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+        },
+      ],
+    },
+    "inventoryTypeTargeting": { # Targeting of the inventory types a bid request can originate from. # Output only. Inventory type targeting information.
+      "inventoryTypes": [ # The list of targeted inventory types for the bid request.
+        "A String",
+      ],
+    },
+    "placementTargeting": { # Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Output only. Placement targeting information, for example, URL, mobile applications.
+      "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages.
+        "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in.
+          "excludedAppIds": [ # A list of application IDs to be excluded.
+            "A String",
+          ],
+          "targetedAppIds": [ # A list of application IDs to be included.
+            "A String",
+          ],
+        },
+      },
+      "uriTargeting": { # Represents a list of targeted and excluded URLs (for example, google.com). For Private Auction Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded.
+        "excludedUris": [ # A list of URLs to be excluded.
+          "A String",
+        ],
+        "targetedUris": [ # A list of URLs to be included.
+          "A String",
+        ],
+      },
+    },
+    "technologyTargeting": { # Represents targeting about various types of technology. # Output only. Technology targeting information, for example, operating system, device category.
+      "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device capabilities to be included/excluded.
+        "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+          "A String",
+        ],
+        "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+          "A String",
+        ],
+      },
+      "deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device categories to be included/excluded.
+        "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+          "A String",
+        ],
+        "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+          "A String",
+        ],
+      },
+      "operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.
+        "operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating systems to be included/excluded.
+          "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+            "A String",
+          ],
+          "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+            "A String",
+          ],
+        },
+        "operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating system versions to be included/excluded.
+          "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+            "A String",
+          ],
+          "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+            "A String",
+          ],
+        },
+      },
+    },
+    "userListTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Buyer user list targeting information. User lists can be uploaded using https://developers.google.com/authorized-buyers/rtb/bulk-uploader.
+      "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+        "A String",
+      ],
+      "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+        "A String",
+      ],
+    },
+    "verticalTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. The verticals included or excluded as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals
+      "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+        "A String",
+      ],
+      "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+        "A String",
+      ],
+    },
+    "videoTargeting": { # Represents targeting information about video. # Output only. Video targeting information.
+      "excludedPositionTypes": [ # A list of video positions to be excluded. When this field is populated, the targeted_position_types field must be empty.
+        "A String",
+      ],
+      "targetedPositionTypes": [ # A list of video positions to be included. When this field is populated, the excluded_position_types field must be empty.
+        "A String",
+      ],
+    },
+  },
+  "updateTime": "A String", # Output only. The time when the deal was last updated.
+}
+
+  updateMask: string, List of fields to be updated. If empty or unspecified, the service will update all fields populated in the update request excluding the output only fields and primitive fields with default value. Note that explicit field mask is required in order to reset a primitive field back to its default value, for example, false for boolean fields, 0 for integer fields. A special field mask consisting of a single path "*" can be used to indicate full replacement(the equivalent of PUT method), updatable fields unset or unspecified in the input will be cleared or set to default value. Output only fields will be ignored regardless of the value of updateMask.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A deal represents a segment of inventory for displaying ads that contains the terms and targeting information that is used for serving as well as the deal stats and status. Note: A proposal may contain multiple deals.
+  "billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer; when the deal belongs to a media planner account, this field will be empty. Format : `buyers/{buyerAccountId}`
+  "buyer": "A String", # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. Format: `buyers/{buyerAccountId}`
+  "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+  "createTime": "A String", # Output only. The time of the deal creation.
+  "creativeRequirements": { # Message captures data about the creatives in the deal. # Output only. Metadata about the creatives of this deal.
+    "creativeFormat": "A String", # Output only. The format of the creative, only applicable for programmatic guaranteed and preferred deals.
+    "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.
+    "creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.
+    "maxAdDurationMs": "A String", # Output only. The max duration of the video creative in milliseconds. only applicable for deals with video creatives.
+    "programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by the buyer.
+    "skippableAdType": "A String", # Output only. Skippable video ads allow viewers to skip ads after 5 seconds. Only applicable for deals with video creatives.
+  },
+  "dealType": "A String", # Output only. Type of deal.
+  "deliveryControl": { # Message contains details about how the deal will be paced. # Output only. Specifies the pacing set by the publisher.
+    "companionDeliveryType": "A String", # Output only. Specifies roadblocking in a main companion lineitem.
+    "creativeRotationType": "A String", # Output only. Specifies strategy to use for selecting a creative when multiple creatives of the same size are available.
+    "deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.
+    "frequencyCap": [ # Output only. Specifies any frequency caps. Cannot be filtered within ListDealsRequest.
+      { # Message contains details about publisher-set frequency caps of the delivery.
+        "maxImpressions": 42, # The maximum number of impressions that can be served to a user within the specified time period.
+        "timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped.
+        "timeUnitsCount": 42, # The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped.
+      },
+    ],
+    "roadblockingType": "A String", # Output only. Specifies the roadblocking type in display creatives.
+  },
+  "description": "A String", # Output only. Free text description for the deal terms.
+  "displayName": "A String", # Output only. The name of the deal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the deal.
+  "eligibleSeatIds": [ # Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.
+    "A String",
+  ],
+  "estimatedGrossSpend": { # Represents an amount of money with its currency type. # Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly.
+    "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.
+  },
+  "flightEndTime": "A String", # Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not necessary for Private Auction deals.
+  "flightStartTime": "A String", # Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (for example, in milliseconds) will be truncated towards the start of time in seconds.
+  "mediaPlanner": { # Describes a single Media Planner account. # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. This field represents a media planner (For example, agency or big advertiser).
+    "accountId": "A String", # Output only. Account ID of the media planner.
+  },
+  "name": "A String", # Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}
+  "preferredDealTerms": { # Pricing terms for Preferred Deals. # The terms for preferred deals.
+    "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+      "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+        "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.
+      },
+      "type": "A String", # The pricing type for the deal.
+    },
+  },
+  "privateAuctionTerms": { # Pricing terms for Private Auctions. # The terms for private auction deals.
+    "floorPrice": { # Represents a price and a pricing type for a deal. # The minimum price buyer has to bid to compete in the private auction.
+      "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+        "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.
+      },
+      "type": "A String", # The pricing type for the deal.
+    },
+    "openAuctionAllowed": True or False, # Output only. True if open auction buyers are allowed to compete with invited buyers in this private auction.
+  },
+  "programmaticGuaranteedTerms": { # Pricing terms for Programmatic Guaranteed Deals. # The terms for programmatic guaranteed deals.
+    "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+      "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+        "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.
+      },
+      "type": "A String", # The pricing type for the deal.
+    },
+    "guaranteedLooks": "A String", # Count of guaranteed looks. For CPD deals, buyer changes to guaranteed_looks will be ignored.
+    "impressionCap": "A String", # The lifetime impression cap for CPM Sponsorship deals. Deal will stop serving when cap is reached.
+    "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.
+    "percentShareOfVoice": "A String", # For sponsorship deals, this is the percentage of the seller's eligible impressions that the deal will serve until the cap is reached. Valid value is within range 0~100.
+    "reservationType": "A String", # The reservation type for a Programmatic Guaranteed deal. This indicates whether the number of impressions is fixed, or a percent of available impressions. If not specified, the default reservation type is STANDARD.
+  },
+  "proposalRevision": "A String", # Output only. The revision number for the proposal and is the same value as proposal.proposal_revision. Each update to deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.
+  "publisherProfile": "A String", # Immutable. Reference to the seller on the deal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}`
+  "sellerTimeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Output only. Time zone of the seller used to mark the boundaries of a day for daypart targeting and CPD billing.
+    "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
+    "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+  },
+  "targeting": { # Targeting represents different criteria that can be used to target deals or auction packages. For example, they can choose to target inventory only if the user is in the US. Multiple types of targeting are always applied as a logical AND, unless noted otherwise. # Specifies the subset of inventory targeted by the deal. Can be updated by the buyer before the deal is finalized.
+    "daypartTargeting": { # Represents Daypart targeting. # Daypart targeting information.
+      "dayParts": [ # The targeted weekdays and times
+        { # Defines targeting for a period of time on a specific week day.
+          "dayOfWeek": "A String", # Day of week for the period.
+          "endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+            "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+            "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+            "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+            "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+          },
+          "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+            "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+            "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+            "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+            "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+          },
+        },
+      ],
+      "timeZoneType": "A String", # The time zone type of the day parts
+    },
+    "excludedSensitiveCategoryIds": [ # Output only. The sensitive content category label IDs excluded. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs.
+      "A String",
+    ],
+    "geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. Geo criteria IDs to be included/excluded.
+      "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+        "A String",
+      ],
+      "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+        "A String",
+      ],
+    },
+    "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on a bid request. # Output only. Inventory sizes to be included/excluded.
+      "excludedInventorySizes": [ # A list of inventory sizes to be excluded.
+        { # Represents size of a single ad slot, or a creative.
+          "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+          "type": "A String", # The type of the ad slot size.
+          "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+        },
+      ],
+      "targetedInventorySizes": [ # A list of inventory sizes to be included.
+        { # Represents size of a single ad slot, or a creative.
+          "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+          "type": "A String", # The type of the ad slot size.
+          "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+        },
+      ],
+    },
+    "inventoryTypeTargeting": { # Targeting of the inventory types a bid request can originate from. # Output only. Inventory type targeting information.
+      "inventoryTypes": [ # The list of targeted inventory types for the bid request.
+        "A String",
+      ],
+    },
+    "placementTargeting": { # Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Output only. Placement targeting information, for example, URL, mobile applications.
+      "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages.
+        "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in.
+          "excludedAppIds": [ # A list of application IDs to be excluded.
+            "A String",
+          ],
+          "targetedAppIds": [ # A list of application IDs to be included.
+            "A String",
+          ],
+        },
+      },
+      "uriTargeting": { # Represents a list of targeted and excluded URLs (for example, google.com). For Private Auction Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded.
+        "excludedUris": [ # A list of URLs to be excluded.
+          "A String",
+        ],
+        "targetedUris": [ # A list of URLs to be included.
+          "A String",
+        ],
+      },
+    },
+    "technologyTargeting": { # Represents targeting about various types of technology. # Output only. Technology targeting information, for example, operating system, device category.
+      "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device capabilities to be included/excluded.
+        "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+          "A String",
+        ],
+        "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+          "A String",
+        ],
+      },
+      "deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device categories to be included/excluded.
+        "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+          "A String",
+        ],
+        "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+          "A String",
+        ],
+      },
+      "operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.
+        "operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating systems to be included/excluded.
+          "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+            "A String",
+          ],
+          "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+            "A String",
+          ],
+        },
+        "operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating system versions to be included/excluded.
+          "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+            "A String",
+          ],
+          "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+            "A String",
+          ],
+        },
+      },
+    },
+    "userListTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Buyer user list targeting information. User lists can be uploaded using https://developers.google.com/authorized-buyers/rtb/bulk-uploader.
+      "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+        "A String",
+      ],
+      "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+        "A String",
+      ],
+    },
+    "verticalTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. The verticals included or excluded as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals
+      "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+        "A String",
+      ],
+      "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+        "A String",
+      ],
+    },
+    "videoTargeting": { # Represents targeting information about video. # Output only. Video targeting information.
+      "excludedPositionTypes": [ # A list of video positions to be excluded. When this field is populated, the targeted_position_types field must be empty.
+        "A String",
+      ],
+      "targetedPositionTypes": [ # A list of video positions to be included. When this field is populated, the excluded_position_types field must be empty.
+        "A String",
+      ],
+    },
+  },
+  "updateTime": "A String", # Output only. The time when the deal was last updated.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.proposals.html b/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.proposals.html new file mode 100644 index 00000000000..ab878fd59cf --- /dev/null +++ b/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.proposals.html @@ -0,0 +1,662 @@ + + + +

Authorized Buyers Marketplace API . buyers . proposals

+

Instance Methods

+

+ deals() +

+

Returns the deals Resource.

+ +

+ accept(name, body=None, x__xgafv=None)

+

Accepts the proposal at the given revision number. If the revision number in the request is behind the latest from the server, an error message will be returned. This call updates the Proposal.state from `BUYER_ACCEPTANCE_REQUESTED` to `FINALIZED`; it has no side effect if the Proposal.state is already `FINALIZED` and throws exception if the Proposal.state is not either `BUYER_ACCEPTANCE_REQUESTED` or `FINALIZED`. Accepting a proposal means the buyer understands and accepts the Proposal.terms_and_conditions proposed by the seller.

+

+ addNote(proposal, body=None, x__xgafv=None)

+

Creates a note for this proposal and sends to the seller. This method is not supported for proposals with DealType set to 'PRIVATE_AUCTION'.

+

+ cancelNegotiation(proposal, body=None, x__xgafv=None)

+

Cancels an ongoing negotiation on a proposal. This does not cancel or end serving for the deals if the proposal has been finalized. If the proposal has not been finalized before, calling this method will set the Proposal.state to `TERMINATED` and increment the Proposal.proposal_revision. If the proposal has been finalized before and is under renegotiation now, calling this method will reset the Proposal.state to `FINALIZED` and increment the Proposal.proposal_revision. This method does not support private auction proposals whose Proposal.deal_type is 'PRIVATE_AUCTION'.

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Gets a proposal using its resource name. The proposal is returned at the latest revision.

+

+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists proposals. A filter expression using [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) may be specified to filter the results.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(name, body=None, updateMask=None, x__xgafv=None)

+

Updates the proposal at the given revision number. If the revision number in the request is behind the latest one kept in the server, an error message will be returned. See FieldMask for how to use FieldMask. Only fields specified in the UpdateProposalRequest.update_mask will be updated; Fields noted as 'Immutable' or 'Output only' yet specified in the UpdateProposalRequest.update_mask will be ignored and left unchanged. Updating a private auction proposal is not allowed and will result in an error.

+

+ sendRfp(buyer, body=None, x__xgafv=None)

+

Sends a request for proposal (RFP) to a publisher to initiate the negotiation regarding certain inventory. In the RFP, buyers can specify the deal type, deal terms, start and end dates, targeting, and a message to the publisher. Once the RFP is sent, a proposal in `SELLER_REVIEW_REQUESTED` state will be created and returned in the response. The publisher may review your request and respond with detailed deals in the proposal.

+

Method Details

+
+ accept(name, body=None, x__xgafv=None) +
Accepts the proposal at the given revision number. If the revision number in the request is behind the latest from the server, an error message will be returned. This call updates the Proposal.state from `BUYER_ACCEPTANCE_REQUESTED` to `FINALIZED`; it has no side effect if the Proposal.state is already `FINALIZED` and throws exception if the Proposal.state is not either `BUYER_ACCEPTANCE_REQUESTED` or `FINALIZED`. Accepting a proposal means the buyer understands and accepts the Proposal.terms_and_conditions proposed by the seller.
+
+Args:
+  name: string, Name of the proposal. Format: `buyers/{accountId}/proposals/{proposalId}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request to accept a proposal. Accepting a proposal implies acceptance of the publisher terms_and_conditions, if any.
+  "proposalRevision": "A String", # The last known client revision number of the proposal.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a proposal in the Marketplace. A proposal is the unit of negotiation between a seller and a buyer.
+  "billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer. Format : `buyers/{buyerAccountId}`
+  "buyer": "A String", # Output only. Refers to a buyer in The Realtime-bidding API. Format: `buyers/{buyerAccountId}`
+  "buyerContacts": [ # Contact information for the buyer.
+    { # Contains information on how a buyer or seller can be reached.
+      "displayName": "A String", # The display_name of the contact.
+      "email": "A String", # Email address for the contact.
+    },
+  ],
+  "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal or deal. # Buyer private data (hidden from seller).
+    "referenceId": "A String", # A buyer specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units).
+  },
+  "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+  "dealType": "A String", # Output only. Type of deal the proposal contains.
+  "displayName": "A String", # Output only. The descriptive name for the proposal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the proposal.
+  "isRenegotiating": True or False, # Output only. True if the proposal was previously finalized and is now being renegotiated.
+  "lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or left a comment.
+  "name": "A String", # Immutable. The name of the proposal serving as a unique identifier. Format: buyers/{accountId}/proposals/{proposalId}
+  "notes": [ # A list of notes from the buyer and the seller attached to this proposal.
+    { # A text note attached to the proposal to facilitate the communication between buyers and sellers.
+      "createTime": "A String", # Output only. When this note was created.
+      "creatorRole": "A String", # Output only. The role who created the note.
+      "note": "A String", # The text of the note. Maximum length is 1024 characters.
+    },
+  ],
+  "originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.
+  "pausingConsented": True or False, # Whether pausing is allowed for the proposal. This is a negotiable term between buyers and publishers.
+  "proposalRevision": "A String", # Output only. The revision number for the proposal. Each update to the proposal or deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.
+  "publisherProfile": "A String", # Immutable. Reference to the seller on the proposal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}` Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error.
+  "sellerContacts": [ # Output only. Contact information for the seller.
+    { # Contains information on how a buyer or seller can be reached.
+      "displayName": "A String", # The display_name of the contact.
+      "email": "A String", # Email address for the contact.
+    },
+  ],
+  "state": "A String", # Output only. Indicates the state of the proposal.
+  "termsAndConditions": "A String", # Output only. The terms and conditions associated with this proposal. Accepting a proposal implies acceptance of this field. This is created by the seller, the buyer can only view it.
+  "updateTime": "A String", # Output only. The time when the proposal was last revised.
+}
+
+ +
+ addNote(proposal, body=None, x__xgafv=None) +
Creates a note for this proposal and sends to the seller. This method is not supported for proposals with DealType set to 'PRIVATE_AUCTION'.
+
+Args:
+  proposal: string, Name of the proposal. Format: `buyers/{accountId}/proposals/{proposalId}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request to add a note.
+  "note": { # A text note attached to the proposal to facilitate the communication between buyers and sellers. # The note to add.
+    "createTime": "A String", # Output only. When this note was created.
+    "creatorRole": "A String", # Output only. The role who created the note.
+    "note": "A String", # The text of the note. Maximum length is 1024 characters.
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a proposal in the Marketplace. A proposal is the unit of negotiation between a seller and a buyer.
+  "billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer. Format : `buyers/{buyerAccountId}`
+  "buyer": "A String", # Output only. Refers to a buyer in The Realtime-bidding API. Format: `buyers/{buyerAccountId}`
+  "buyerContacts": [ # Contact information for the buyer.
+    { # Contains information on how a buyer or seller can be reached.
+      "displayName": "A String", # The display_name of the contact.
+      "email": "A String", # Email address for the contact.
+    },
+  ],
+  "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal or deal. # Buyer private data (hidden from seller).
+    "referenceId": "A String", # A buyer specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units).
+  },
+  "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+  "dealType": "A String", # Output only. Type of deal the proposal contains.
+  "displayName": "A String", # Output only. The descriptive name for the proposal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the proposal.
+  "isRenegotiating": True or False, # Output only. True if the proposal was previously finalized and is now being renegotiated.
+  "lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or left a comment.
+  "name": "A String", # Immutable. The name of the proposal serving as a unique identifier. Format: buyers/{accountId}/proposals/{proposalId}
+  "notes": [ # A list of notes from the buyer and the seller attached to this proposal.
+    { # A text note attached to the proposal to facilitate the communication between buyers and sellers.
+      "createTime": "A String", # Output only. When this note was created.
+      "creatorRole": "A String", # Output only. The role who created the note.
+      "note": "A String", # The text of the note. Maximum length is 1024 characters.
+    },
+  ],
+  "originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.
+  "pausingConsented": True or False, # Whether pausing is allowed for the proposal. This is a negotiable term between buyers and publishers.
+  "proposalRevision": "A String", # Output only. The revision number for the proposal. Each update to the proposal or deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.
+  "publisherProfile": "A String", # Immutable. Reference to the seller on the proposal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}` Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error.
+  "sellerContacts": [ # Output only. Contact information for the seller.
+    { # Contains information on how a buyer or seller can be reached.
+      "displayName": "A String", # The display_name of the contact.
+      "email": "A String", # Email address for the contact.
+    },
+  ],
+  "state": "A String", # Output only. Indicates the state of the proposal.
+  "termsAndConditions": "A String", # Output only. The terms and conditions associated with this proposal. Accepting a proposal implies acceptance of this field. This is created by the seller, the buyer can only view it.
+  "updateTime": "A String", # Output only. The time when the proposal was last revised.
+}
+
+ +
+ cancelNegotiation(proposal, body=None, x__xgafv=None) +
Cancels an ongoing negotiation on a proposal. This does not cancel or end serving for the deals if the proposal has been finalized. If the proposal has not been finalized before, calling this method will set the Proposal.state to `TERMINATED` and increment the Proposal.proposal_revision. If the proposal has been finalized before and is under renegotiation now, calling this method will reset the Proposal.state to `FINALIZED` and increment the Proposal.proposal_revision. This method does not support private auction proposals whose Proposal.deal_type is 'PRIVATE_AUCTION'.
+
+Args:
+  proposal: string, Name of the proposal. Format: `buyers/{accountId}/proposals/{proposalId}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request to cancel an ongoing negotiation.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a proposal in the Marketplace. A proposal is the unit of negotiation between a seller and a buyer.
+  "billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer. Format : `buyers/{buyerAccountId}`
+  "buyer": "A String", # Output only. Refers to a buyer in The Realtime-bidding API. Format: `buyers/{buyerAccountId}`
+  "buyerContacts": [ # Contact information for the buyer.
+    { # Contains information on how a buyer or seller can be reached.
+      "displayName": "A String", # The display_name of the contact.
+      "email": "A String", # Email address for the contact.
+    },
+  ],
+  "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal or deal. # Buyer private data (hidden from seller).
+    "referenceId": "A String", # A buyer specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units).
+  },
+  "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+  "dealType": "A String", # Output only. Type of deal the proposal contains.
+  "displayName": "A String", # Output only. The descriptive name for the proposal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the proposal.
+  "isRenegotiating": True or False, # Output only. True if the proposal was previously finalized and is now being renegotiated.
+  "lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or left a comment.
+  "name": "A String", # Immutable. The name of the proposal serving as a unique identifier. Format: buyers/{accountId}/proposals/{proposalId}
+  "notes": [ # A list of notes from the buyer and the seller attached to this proposal.
+    { # A text note attached to the proposal to facilitate the communication between buyers and sellers.
+      "createTime": "A String", # Output only. When this note was created.
+      "creatorRole": "A String", # Output only. The role who created the note.
+      "note": "A String", # The text of the note. Maximum length is 1024 characters.
+    },
+  ],
+  "originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.
+  "pausingConsented": True or False, # Whether pausing is allowed for the proposal. This is a negotiable term between buyers and publishers.
+  "proposalRevision": "A String", # Output only. The revision number for the proposal. Each update to the proposal or deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.
+  "publisherProfile": "A String", # Immutable. Reference to the seller on the proposal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}` Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error.
+  "sellerContacts": [ # Output only. Contact information for the seller.
+    { # Contains information on how a buyer or seller can be reached.
+      "displayName": "A String", # The display_name of the contact.
+      "email": "A String", # Email address for the contact.
+    },
+  ],
+  "state": "A String", # Output only. Indicates the state of the proposal.
+  "termsAndConditions": "A String", # Output only. The terms and conditions associated with this proposal. Accepting a proposal implies acceptance of this field. This is created by the seller, the buyer can only view it.
+  "updateTime": "A String", # Output only. The time when the proposal was last revised.
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Gets a proposal using its resource name. The proposal is returned at the latest revision.
+
+Args:
+  name: string, Required. Name of the proposal. Format: `buyers/{accountId}/proposals/{proposalId}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a proposal in the Marketplace. A proposal is the unit of negotiation between a seller and a buyer.
+  "billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer. Format : `buyers/{buyerAccountId}`
+  "buyer": "A String", # Output only. Refers to a buyer in The Realtime-bidding API. Format: `buyers/{buyerAccountId}`
+  "buyerContacts": [ # Contact information for the buyer.
+    { # Contains information on how a buyer or seller can be reached.
+      "displayName": "A String", # The display_name of the contact.
+      "email": "A String", # Email address for the contact.
+    },
+  ],
+  "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal or deal. # Buyer private data (hidden from seller).
+    "referenceId": "A String", # A buyer specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units).
+  },
+  "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+  "dealType": "A String", # Output only. Type of deal the proposal contains.
+  "displayName": "A String", # Output only. The descriptive name for the proposal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the proposal.
+  "isRenegotiating": True or False, # Output only. True if the proposal was previously finalized and is now being renegotiated.
+  "lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or left a comment.
+  "name": "A String", # Immutable. The name of the proposal serving as a unique identifier. Format: buyers/{accountId}/proposals/{proposalId}
+  "notes": [ # A list of notes from the buyer and the seller attached to this proposal.
+    { # A text note attached to the proposal to facilitate the communication between buyers and sellers.
+      "createTime": "A String", # Output only. When this note was created.
+      "creatorRole": "A String", # Output only. The role who created the note.
+      "note": "A String", # The text of the note. Maximum length is 1024 characters.
+    },
+  ],
+  "originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.
+  "pausingConsented": True or False, # Whether pausing is allowed for the proposal. This is a negotiable term between buyers and publishers.
+  "proposalRevision": "A String", # Output only. The revision number for the proposal. Each update to the proposal or deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.
+  "publisherProfile": "A String", # Immutable. Reference to the seller on the proposal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}` Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error.
+  "sellerContacts": [ # Output only. Contact information for the seller.
+    { # Contains information on how a buyer or seller can be reached.
+      "displayName": "A String", # The display_name of the contact.
+      "email": "A String", # Email address for the contact.
+    },
+  ],
+  "state": "A String", # Output only. Indicates the state of the proposal.
+  "termsAndConditions": "A String", # Output only. The terms and conditions associated with this proposal. Accepting a proposal implies acceptance of this field. This is created by the seller, the buyer can only view it.
+  "updateTime": "A String", # Output only. The time when the proposal was last revised.
+}
+
+ +
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists proposals. A filter expression using [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) may be specified to filter the results.
+
+Args:
+  parent: string, Required. Parent that owns the collection of proposals Format: `buyers/{accountId}` (required)
+  filter: string, Optional query string using the [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) Supported columns for filtering are: * displayName * dealType * updateTime * state
+  pageSize: integer, Requested page size. The server may return fewer results than requested. If unspecified, the server will put a size of 500.
+  pageToken: string, The page token as returned from ListProposalsResponse.
+  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 listing proposals.
+  "nextPageToken": "A String", # Continuation token for fetching the next page of results.
+  "proposals": [ # The list of proposals.
+    { # Represents a proposal in the Marketplace. A proposal is the unit of negotiation between a seller and a buyer.
+      "billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer. Format : `buyers/{buyerAccountId}`
+      "buyer": "A String", # Output only. Refers to a buyer in The Realtime-bidding API. Format: `buyers/{buyerAccountId}`
+      "buyerContacts": [ # Contact information for the buyer.
+        { # Contains information on how a buyer or seller can be reached.
+          "displayName": "A String", # The display_name of the contact.
+          "email": "A String", # Email address for the contact.
+        },
+      ],
+      "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal or deal. # Buyer private data (hidden from seller).
+        "referenceId": "A String", # A buyer specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units).
+      },
+      "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+      "dealType": "A String", # Output only. Type of deal the proposal contains.
+      "displayName": "A String", # Output only. The descriptive name for the proposal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the proposal.
+      "isRenegotiating": True or False, # Output only. True if the proposal was previously finalized and is now being renegotiated.
+      "lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or left a comment.
+      "name": "A String", # Immutable. The name of the proposal serving as a unique identifier. Format: buyers/{accountId}/proposals/{proposalId}
+      "notes": [ # A list of notes from the buyer and the seller attached to this proposal.
+        { # A text note attached to the proposal to facilitate the communication between buyers and sellers.
+          "createTime": "A String", # Output only. When this note was created.
+          "creatorRole": "A String", # Output only. The role who created the note.
+          "note": "A String", # The text of the note. Maximum length is 1024 characters.
+        },
+      ],
+      "originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.
+      "pausingConsented": True or False, # Whether pausing is allowed for the proposal. This is a negotiable term between buyers and publishers.
+      "proposalRevision": "A String", # Output only. The revision number for the proposal. Each update to the proposal or deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.
+      "publisherProfile": "A String", # Immutable. Reference to the seller on the proposal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}` Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error.
+      "sellerContacts": [ # Output only. Contact information for the seller.
+        { # Contains information on how a buyer or seller can be reached.
+          "displayName": "A String", # The display_name of the contact.
+          "email": "A String", # Email address for the contact.
+        },
+      ],
+      "state": "A String", # Output only. Indicates the state of the proposal.
+      "termsAndConditions": "A String", # Output only. The terms and conditions associated with this proposal. Accepting a proposal implies acceptance of this field. This is created by the seller, the buyer can only view it.
+      "updateTime": "A String", # Output only. The time when the proposal was last revised.
+    },
+  ],
+}
+
+ +
+ 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, body=None, updateMask=None, x__xgafv=None) +
Updates the proposal at the given revision number. If the revision number in the request is behind the latest one kept in the server, an error message will be returned. See FieldMask for how to use FieldMask. Only fields specified in the UpdateProposalRequest.update_mask will be updated; Fields noted as 'Immutable' or 'Output only' yet specified in the UpdateProposalRequest.update_mask will be ignored and left unchanged. Updating a private auction proposal is not allowed and will result in an error.
+
+Args:
+  name: string, Immutable. The name of the proposal serving as a unique identifier. Format: buyers/{accountId}/proposals/{proposalId} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a proposal in the Marketplace. A proposal is the unit of negotiation between a seller and a buyer.
+  "billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer. Format : `buyers/{buyerAccountId}`
+  "buyer": "A String", # Output only. Refers to a buyer in The Realtime-bidding API. Format: `buyers/{buyerAccountId}`
+  "buyerContacts": [ # Contact information for the buyer.
+    { # Contains information on how a buyer or seller can be reached.
+      "displayName": "A String", # The display_name of the contact.
+      "email": "A String", # Email address for the contact.
+    },
+  ],
+  "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal or deal. # Buyer private data (hidden from seller).
+    "referenceId": "A String", # A buyer specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units).
+  },
+  "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+  "dealType": "A String", # Output only. Type of deal the proposal contains.
+  "displayName": "A String", # Output only. The descriptive name for the proposal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the proposal.
+  "isRenegotiating": True or False, # Output only. True if the proposal was previously finalized and is now being renegotiated.
+  "lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or left a comment.
+  "name": "A String", # Immutable. The name of the proposal serving as a unique identifier. Format: buyers/{accountId}/proposals/{proposalId}
+  "notes": [ # A list of notes from the buyer and the seller attached to this proposal.
+    { # A text note attached to the proposal to facilitate the communication between buyers and sellers.
+      "createTime": "A String", # Output only. When this note was created.
+      "creatorRole": "A String", # Output only. The role who created the note.
+      "note": "A String", # The text of the note. Maximum length is 1024 characters.
+    },
+  ],
+  "originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.
+  "pausingConsented": True or False, # Whether pausing is allowed for the proposal. This is a negotiable term between buyers and publishers.
+  "proposalRevision": "A String", # Output only. The revision number for the proposal. Each update to the proposal or deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.
+  "publisherProfile": "A String", # Immutable. Reference to the seller on the proposal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}` Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error.
+  "sellerContacts": [ # Output only. Contact information for the seller.
+    { # Contains information on how a buyer or seller can be reached.
+      "displayName": "A String", # The display_name of the contact.
+      "email": "A String", # Email address for the contact.
+    },
+  ],
+  "state": "A String", # Output only. Indicates the state of the proposal.
+  "termsAndConditions": "A String", # Output only. The terms and conditions associated with this proposal. Accepting a proposal implies acceptance of this field. This is created by the seller, the buyer can only view it.
+  "updateTime": "A String", # Output only. The time when the proposal was last revised.
+}
+
+  updateMask: string, List of fields to be updated. If empty or unspecified, the service will update all fields populated in the update request excluding the output only fields and primitive fields with default value. Note that explicit field mask is required in order to reset a primitive field back to its default value, for example, false for boolean fields, 0 for integer fields. A special field mask consisting of a single path "*" can be used to indicate full replacement(the equivalent of PUT method), updatable fields unset or unspecified in the input will be cleared or set to default value. Output only fields will be ignored regardless of the value of updateMask.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a proposal in the Marketplace. A proposal is the unit of negotiation between a seller and a buyer.
+  "billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer. Format : `buyers/{buyerAccountId}`
+  "buyer": "A String", # Output only. Refers to a buyer in The Realtime-bidding API. Format: `buyers/{buyerAccountId}`
+  "buyerContacts": [ # Contact information for the buyer.
+    { # Contains information on how a buyer or seller can be reached.
+      "displayName": "A String", # The display_name of the contact.
+      "email": "A String", # Email address for the contact.
+    },
+  ],
+  "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal or deal. # Buyer private data (hidden from seller).
+    "referenceId": "A String", # A buyer specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units).
+  },
+  "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+  "dealType": "A String", # Output only. Type of deal the proposal contains.
+  "displayName": "A String", # Output only. The descriptive name for the proposal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the proposal.
+  "isRenegotiating": True or False, # Output only. True if the proposal was previously finalized and is now being renegotiated.
+  "lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or left a comment.
+  "name": "A String", # Immutable. The name of the proposal serving as a unique identifier. Format: buyers/{accountId}/proposals/{proposalId}
+  "notes": [ # A list of notes from the buyer and the seller attached to this proposal.
+    { # A text note attached to the proposal to facilitate the communication between buyers and sellers.
+      "createTime": "A String", # Output only. When this note was created.
+      "creatorRole": "A String", # Output only. The role who created the note.
+      "note": "A String", # The text of the note. Maximum length is 1024 characters.
+    },
+  ],
+  "originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.
+  "pausingConsented": True or False, # Whether pausing is allowed for the proposal. This is a negotiable term between buyers and publishers.
+  "proposalRevision": "A String", # Output only. The revision number for the proposal. Each update to the proposal or deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.
+  "publisherProfile": "A String", # Immutable. Reference to the seller on the proposal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}` Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error.
+  "sellerContacts": [ # Output only. Contact information for the seller.
+    { # Contains information on how a buyer or seller can be reached.
+      "displayName": "A String", # The display_name of the contact.
+      "email": "A String", # Email address for the contact.
+    },
+  ],
+  "state": "A String", # Output only. Indicates the state of the proposal.
+  "termsAndConditions": "A String", # Output only. The terms and conditions associated with this proposal. Accepting a proposal implies acceptance of this field. This is created by the seller, the buyer can only view it.
+  "updateTime": "A String", # Output only. The time when the proposal was last revised.
+}
+
+ +
+ sendRfp(buyer, body=None, x__xgafv=None) +
Sends a request for proposal (RFP) to a publisher to initiate the negotiation regarding certain inventory. In the RFP, buyers can specify the deal type, deal terms, start and end dates, targeting, and a message to the publisher. Once the RFP is sent, a proposal in `SELLER_REVIEW_REQUESTED` state will be created and returned in the response. The publisher may review your request and respond with detailed deals in the proposal.
+
+Args:
+  buyer: string, Required. The current buyer who is sending the RFP in the format: `buyers/{accountId}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request to send an RFP. All fields in this request are proposed to publisher and subject to changes by publisher during later negotiation.
+  "buyerContacts": [ # Contact information for the buyer.
+    { # Contains information on how a buyer or seller can be reached.
+      "displayName": "A String", # The display_name of the contact.
+      "email": "A String", # Email address for the contact.
+    },
+  ],
+  "client": "A String", # If the current buyer is sending the RFP on behalf of its client, use this field to specify the name of the client in the format: `buyers/{accountId}/clients/{clientAccountid}`.
+  "displayName": "A String", # Required. The display name of the proposal being created by this RFP.
+  "estimatedGrossSpend": { # Represents an amount of money with its currency type. # Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly.
+    "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.
+  },
+  "flightEndTime": "A String", # Required. Proposed flight end time of the RFP. A timestamp in RFC3339 UTC "Zulu" format. Note that the specified value will be truncated to a granularity of one second.
+  "flightStartTime": "A String", # Required. Proposed flight start time of the RFP. A timestamp in RFC3339 UTC "Zulu" format. Note that the specified value will be truncated to a granularity of one second.
+  "geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Geo criteria IDs to be targeted. Refer to Geo tables.
+    "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+      "A String",
+    ],
+    "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+      "A String",
+    ],
+  },
+  "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on a bid request. # Inventory sizes to be targeted.
+    "excludedInventorySizes": [ # A list of inventory sizes to be excluded.
+      { # Represents size of a single ad slot, or a creative.
+        "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+        "type": "A String", # The type of the ad slot size.
+        "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+      },
+    ],
+    "targetedInventorySizes": [ # A list of inventory sizes to be included.
+      { # Represents size of a single ad slot, or a creative.
+        "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+        "type": "A String", # The type of the ad slot size.
+        "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+      },
+    ],
+  },
+  "note": "A String", # A message that is sent to the publisher. Maximum length is 1024 characters.
+  "preferredDealTerms": { # Pricing terms for Preferred Deals. # The terms for preferred deals.
+    "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+      "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+        "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.
+      },
+      "type": "A String", # The pricing type for the deal.
+    },
+  },
+  "programmaticGuaranteedTerms": { # Pricing terms for Programmatic Guaranteed Deals. # The terms for programmatic guaranteed deals.
+    "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+      "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+        "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.
+      },
+      "type": "A String", # The pricing type for the deal.
+    },
+    "guaranteedLooks": "A String", # Count of guaranteed looks. For CPD deals, buyer changes to guaranteed_looks will be ignored.
+    "impressionCap": "A String", # The lifetime impression cap for CPM Sponsorship deals. Deal will stop serving when cap is reached.
+    "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.
+    "percentShareOfVoice": "A String", # For sponsorship deals, this is the percentage of the seller's eligible impressions that the deal will serve until the cap is reached. Valid value is within range 0~100.
+    "reservationType": "A String", # The reservation type for a Programmatic Guaranteed deal. This indicates whether the number of impressions is fixed, or a percent of available impressions. If not specified, the default reservation type is STANDARD.
+  },
+  "publisherProfile": "A String", # Required. The profile of the publisher who will receive this RFP in the format: `buyers/{accountId}/publisherProfiles/{publisherProfileId}`.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a proposal in the Marketplace. A proposal is the unit of negotiation between a seller and a buyer.
+  "billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer. Format : `buyers/{buyerAccountId}`
+  "buyer": "A String", # Output only. Refers to a buyer in The Realtime-bidding API. Format: `buyers/{buyerAccountId}`
+  "buyerContacts": [ # Contact information for the buyer.
+    { # Contains information on how a buyer or seller can be reached.
+      "displayName": "A String", # The display_name of the contact.
+      "email": "A String", # Email address for the contact.
+    },
+  ],
+  "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal or deal. # Buyer private data (hidden from seller).
+    "referenceId": "A String", # A buyer specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units).
+  },
+  "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+  "dealType": "A String", # Output only. Type of deal the proposal contains.
+  "displayName": "A String", # Output only. The descriptive name for the proposal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the proposal.
+  "isRenegotiating": True or False, # Output only. True if the proposal was previously finalized and is now being renegotiated.
+  "lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or left a comment.
+  "name": "A String", # Immutable. The name of the proposal serving as a unique identifier. Format: buyers/{accountId}/proposals/{proposalId}
+  "notes": [ # A list of notes from the buyer and the seller attached to this proposal.
+    { # A text note attached to the proposal to facilitate the communication between buyers and sellers.
+      "createTime": "A String", # Output only. When this note was created.
+      "creatorRole": "A String", # Output only. The role who created the note.
+      "note": "A String", # The text of the note. Maximum length is 1024 characters.
+    },
+  ],
+  "originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.
+  "pausingConsented": True or False, # Whether pausing is allowed for the proposal. This is a negotiable term between buyers and publishers.
+  "proposalRevision": "A String", # Output only. The revision number for the proposal. Each update to the proposal or deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.
+  "publisherProfile": "A String", # Immutable. Reference to the seller on the proposal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}` Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error.
+  "sellerContacts": [ # Output only. Contact information for the seller.
+    { # Contains information on how a buyer or seller can be reached.
+      "displayName": "A String", # The display_name of the contact.
+      "email": "A String", # Email address for the contact.
+    },
+  ],
+  "state": "A String", # Output only. Indicates the state of the proposal.
+  "termsAndConditions": "A String", # Output only. The terms and conditions associated with this proposal. Accepting a proposal implies acceptance of this field. This is created by the seller, the buyer can only view it.
+  "updateTime": "A String", # Output only. The time when the proposal was last revised.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.publisherProfiles.html b/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.publisherProfiles.html new file mode 100644 index 00000000000..f81b3defa29 --- /dev/null +++ b/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.publisherProfiles.html @@ -0,0 +1,203 @@ + + + +

Authorized Buyers Marketplace API . buyers . publisherProfiles

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Gets the requested publisher profile by name.

+

+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists publisher profiles. The returned publisher profiles aren't in any defined order. The order of the results might change. A new publisher profile can appear in any place in the list of returned results.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Gets the requested publisher profile by name.
+
+Args:
+  name: string, Required. Name of the publisher profile. Format: `buyers/{buyerId}/publisherProfiles/{publisherProfileId}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The values in the publisher profile are supplied by the publisher. All fields are not filterable unless stated otherwise.
+  "audienceDescription": "A String", # Description on the publisher's audience.
+  "directDealsContact": "A String", # Contact information for direct reservation deals. This is free text entered by the publisher and may include information like names, phone numbers and email addresses.
+  "displayName": "A String", # Display name of the publisher profile. Can be used to filter the response of the publisherProfiles.list method.
+  "domains": [ # The list of domains represented in this publisher profile. Empty if this is a parent profile. These are top private domains, meaning that these will not contain a string like "photos.google.co.uk/123", but will instead contain "google.co.uk". Can be used to filter the response of the publisherProfiles.list method.
+    "A String",
+  ],
+  "isParent": True or False, # Indicates if this profile is the parent profile of the seller. A parent profile represents all the inventory from the seller, as opposed to child profile that is created to brand a portion of inventory. One seller has only one parent publisher profile, and can have multiple child profiles. See https://support.google.com/admanager/answer/6035806 for details. Can be used to filter the response of the publisherProfiles.list method by setting the filter to "is_parent: true".
+  "logoUrl": "A String", # A Google public URL to the logo for this publisher profile. The logo is stored as a PNG, JPG, or GIF image.
+  "mediaKitUrl": "A String", # URL to additional marketing and sales materials.
+  "mobileApps": [ # The list of apps represented in this publisher profile. Empty if this is a parent profile.
+    { # A mobile application that contains a external app ID, name, and app store.
+      "appStore": "A String", # The app store the app belongs to. Can be used to filter the response of the publisherProfiles.list method.
+      "externalAppId": "A String", # The external ID for the app from its app store. Can be used to filter the response of the publisherProfiles.list method.
+      "name": "A String", # The name of the app.
+    },
+  ],
+  "name": "A String", # Name of the publisher profile. Format: `buyers/{buyer}/publisherProfiles/{publisher_profile}`
+  "overview": "A String", # Overview of the publisher.
+  "pitchStatement": "A String", # Statement explaining what's unique about publisher's business, and why buyers should partner with the publisher.
+  "programmaticDealsContact": "A String", # Contact information for programmatic deals. This is free text entered by the publisher and may include information like names, phone numbers and email addresses.
+  "publisherCode": "A String", # A unique identifying code for the seller. This value is the same for all of the seller's parent and child publisher profiles. Can be used to filter the response of the publisherProfiles.list method.
+  "samplePageUrl": "A String", # URL to a sample content page.
+  "topHeadlines": [ # Up to three key metrics and rankings. For example, "#1 Mobile News Site for 20 Straight Months".
+    "A String",
+  ],
+}
+
+ +
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists publisher profiles. The returned publisher profiles aren't in any defined order. The order of the results might change. A new publisher profile can appear in any place in the list of returned results.
+
+Args:
+  parent: string, Required. Parent that owns the collection of publisher profiles Format: `buyers/{buyerId}` (required)
+  filter: string, Optional query string using the [Cloud API list filtering] (https://developers.google.com/authorized-buyers/apis/guides/list-filters) syntax.
+  pageSize: integer, Requested page size. The server may return fewer results than requested. If requested more than 500, the server will return 500 results per page. If unspecified, the server will pick a default page size of 100.
+  pageToken: string, The page token as returned from a previous ListPublisherProfilesResponse.
+  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 profiles visible to the buyer.
+  "nextPageToken": "A String", # Token to fetch the next page of results.
+  "publisherProfiles": [ # The list of matching publisher profiles.
+    { # The values in the publisher profile are supplied by the publisher. All fields are not filterable unless stated otherwise.
+      "audienceDescription": "A String", # Description on the publisher's audience.
+      "directDealsContact": "A String", # Contact information for direct reservation deals. This is free text entered by the publisher and may include information like names, phone numbers and email addresses.
+      "displayName": "A String", # Display name of the publisher profile. Can be used to filter the response of the publisherProfiles.list method.
+      "domains": [ # The list of domains represented in this publisher profile. Empty if this is a parent profile. These are top private domains, meaning that these will not contain a string like "photos.google.co.uk/123", but will instead contain "google.co.uk". Can be used to filter the response of the publisherProfiles.list method.
+        "A String",
+      ],
+      "isParent": True or False, # Indicates if this profile is the parent profile of the seller. A parent profile represents all the inventory from the seller, as opposed to child profile that is created to brand a portion of inventory. One seller has only one parent publisher profile, and can have multiple child profiles. See https://support.google.com/admanager/answer/6035806 for details. Can be used to filter the response of the publisherProfiles.list method by setting the filter to "is_parent: true".
+      "logoUrl": "A String", # A Google public URL to the logo for this publisher profile. The logo is stored as a PNG, JPG, or GIF image.
+      "mediaKitUrl": "A String", # URL to additional marketing and sales materials.
+      "mobileApps": [ # The list of apps represented in this publisher profile. Empty if this is a parent profile.
+        { # A mobile application that contains a external app ID, name, and app store.
+          "appStore": "A String", # The app store the app belongs to. Can be used to filter the response of the publisherProfiles.list method.
+          "externalAppId": "A String", # The external ID for the app from its app store. Can be used to filter the response of the publisherProfiles.list method.
+          "name": "A String", # The name of the app.
+        },
+      ],
+      "name": "A String", # Name of the publisher profile. Format: `buyers/{buyer}/publisherProfiles/{publisher_profile}`
+      "overview": "A String", # Overview of the publisher.
+      "pitchStatement": "A String", # Statement explaining what's unique about publisher's business, and why buyers should partner with the publisher.
+      "programmaticDealsContact": "A String", # Contact information for programmatic deals. This is free text entered by the publisher and may include information like names, phone numbers and email addresses.
+      "publisherCode": "A String", # A unique identifying code for the seller. This value is the same for all of the seller's parent and child publisher profiles. Can be used to filter the response of the publisherProfiles.list method.
+      "samplePageUrl": "A String", # URL to a sample content page.
+      "topHeadlines": [ # Up to three key metrics and rankings. For example, "#1 Mobile News Site for 20 Straight Months".
+        "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.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/authorizedbuyersmarketplace_v1alpha.html b/docs/dyn/authorizedbuyersmarketplace_v1alpha.html new file mode 100644 index 00000000000..b2211770e4b --- /dev/null +++ b/docs/dyn/authorizedbuyersmarketplace_v1alpha.html @@ -0,0 +1,116 @@ + + + +

Authorized Buyers Marketplace API

+

Instance Methods

+

+ bidders() +

+

Returns the bidders Resource.

+ +

+ buyers() +

+

Returns the buyers Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ new_batch_http_request()

+

Create a BatchHttpRequest object based on the discovery document.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ 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.
+                
+
+ + \ No newline at end of file diff --git a/docs/dyn/backupdr_v1.projects.locations.backupVaults.dataSources.backups.html b/docs/dyn/backupdr_v1.projects.locations.backupVaults.dataSources.backups.html index 744d6089bfd..9eb2465f3d8 100644 --- a/docs/dyn/backupdr_v1.projects.locations.backupVaults.dataSources.backups.html +++ b/docs/dyn/backupdr_v1.projects.locations.backupVaults.dataSources.backups.html @@ -189,6 +189,7 @@

Method Details

"diskInterface": "A String", # Optional. Specifies the disk interface to use for attaching this disk. "diskSizeGb": "A String", # Optional. The size of the disk in GB. "diskType": "A String", # Optional. Specifies the type of the disk. + "diskTypeUri": "A String", # Optional. Output only. The URI of the disk type resource. For example: projects/project/zones/zone/diskTypes/pd-standard or pd-ssd "guestOsFeature": [ # Optional. A list of features to enable on the guest operating system. Applicable only for bootable images. { # Feature type of the Guest OS. "type": "A String", # The ID of a supported feature. @@ -301,7 +302,7 @@

Method Details

], }, ], - "sourceInstanceName": "A String", # Name of the source instance at the time of backup. The name is 1-63 characters long, and complies with RFC1035. + "sourceInstance": "A String", # The source instance used to create this backup. This can be a partial or full URL to the resource. For example, the following are valid values: -https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance -projects/project/zones/zone/instances/instance "tags": { # A set of instance tags. # A list of tags to apply to the instances that are created from these properties. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035 (https://www.ietf.org/rfc/rfc1035.txt). "items": [ # Optional. An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035. "A String", @@ -405,6 +406,7 @@

Method Details

"diskInterface": "A String", # Optional. Specifies the disk interface to use for attaching this disk. "diskSizeGb": "A String", # Optional. The size of the disk in GB. "diskType": "A String", # Optional. Specifies the type of the disk. + "diskTypeUri": "A String", # Optional. Output only. The URI of the disk type resource. For example: projects/project/zones/zone/diskTypes/pd-standard or pd-ssd "guestOsFeature": [ # Optional. A list of features to enable on the guest operating system. Applicable only for bootable images. { # Feature type of the Guest OS. "type": "A String", # The ID of a supported feature. @@ -517,7 +519,7 @@

Method Details

], }, ], - "sourceInstanceName": "A String", # Name of the source instance at the time of backup. The name is 1-63 characters long, and complies with RFC1035. + "sourceInstance": "A String", # The source instance used to create this backup. This can be a partial or full URL to the resource. For example, the following are valid values: -https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance -projects/project/zones/zone/instances/instance "tags": { # A set of instance tags. # A list of tags to apply to the instances that are created from these properties. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035 (https://www.ietf.org/rfc/rfc1035.txt). "items": [ # Optional. An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035. "A String", @@ -630,6 +632,7 @@

Method Details

"diskInterface": "A String", # Optional. Specifies the disk interface to use for attaching this disk. "diskSizeGb": "A String", # Optional. The size of the disk in GB. "diskType": "A String", # Optional. Specifies the type of the disk. + "diskTypeUri": "A String", # Optional. Output only. The URI of the disk type resource. For example: projects/project/zones/zone/diskTypes/pd-standard or pd-ssd "guestOsFeature": [ # Optional. A list of features to enable on the guest operating system. Applicable only for bootable images. { # Feature type of the Guest OS. "type": "A String", # The ID of a supported feature. @@ -742,7 +745,7 @@

Method Details

], }, ], - "sourceInstanceName": "A String", # Name of the source instance at the time of backup. The name is 1-63 characters long, and complies with RFC1035. + "sourceInstance": "A String", # The source instance used to create this backup. This can be a partial or full URL to the resource. For example, the following are valid values: -https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance -projects/project/zones/zone/instances/instance "tags": { # A set of instance tags. # A list of tags to apply to the instances that are created from these properties. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035 (https://www.ietf.org/rfc/rfc1035.txt). "items": [ # Optional. An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035. "A String", diff --git a/docs/dyn/backupdr_v1.projects.locations.backupVaults.html b/docs/dyn/backupdr_v1.projects.locations.backupVaults.html index 8245ff0edeb..b79c4ff9268 100644 --- a/docs/dyn/backupdr_v1.projects.locations.backupVaults.html +++ b/docs/dyn/backupdr_v1.projects.locations.backupVaults.html @@ -104,7 +104,7 @@

Instance Methods

list_next()

Retrieves the next page of results.

- patch(name, body=None, requestId=None, updateMask=None, validateOnly=None, x__xgafv=None)

+ patch(name, body=None, force=None, requestId=None, updateMask=None, validateOnly=None, x__xgafv=None)

Updates the settings of a BackupVault.

testIamPermissions(resource, body=None, x__xgafv=None)

@@ -386,7 +386,7 @@

Method Details

- patch(name, body=None, requestId=None, updateMask=None, validateOnly=None, x__xgafv=None) + patch(name, body=None, force=None, requestId=None, updateMask=None, validateOnly=None, x__xgafv=None)
Updates the settings of a BackupVault.
 
 Args:
@@ -417,6 +417,7 @@ 

Method Details

"updateTime": "A String", # Output only. The time when the instance was updated. } + force: boolean, Optional. If set to true, will not check plan duration against backup vault enforcement duration. Non-standard field. requestId: string, Optional. An optional 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 BackupVault 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 the request will fail. validateOnly: boolean, Optional. Only validate the request, but do not perform mutations. The default is 'false'. diff --git a/docs/dyn/certificatemanager_v1.projects.locations.dnsAuthorizations.html b/docs/dyn/certificatemanager_v1.projects.locations.dnsAuthorizations.html index 9b951663993..f12d788cc46 100644 --- a/docs/dyn/certificatemanager_v1.projects.locations.dnsAuthorizations.html +++ b/docs/dyn/certificatemanager_v1.projects.locations.dnsAuthorizations.html @@ -123,7 +123,7 @@

Method Details

"a_key": "A String", }, "name": "A String", # A user-defined name of the dns authorization. DnsAuthorization names must be unique globally and match pattern `projects/*/locations/*/dnsAuthorizations/*`. - "type": "A String", # Immutable. Type of DnsAuthorization. If unset during resource creation the following default will be used: - in location global: FIXED_RECORD. + "type": "A String", # Immutable. Type of DnsAuthorization. If unset during resource creation the following default will be used: - in location `global`: FIXED_RECORD, - in other locations: PER_PROJECT_RECORD. "updateTime": "A String", # Output only. The last update timestamp of a DnsAuthorization. } @@ -219,7 +219,7 @@

Method Details

"a_key": "A String", }, "name": "A String", # A user-defined name of the dns authorization. DnsAuthorization names must be unique globally and match pattern `projects/*/locations/*/dnsAuthorizations/*`. - "type": "A String", # Immutable. Type of DnsAuthorization. If unset during resource creation the following default will be used: - in location global: FIXED_RECORD. + "type": "A String", # Immutable. Type of DnsAuthorization. If unset during resource creation the following default will be used: - in location `global`: FIXED_RECORD, - in other locations: PER_PROJECT_RECORD. "updateTime": "A String", # Output only. The last update timestamp of a DnsAuthorization. }
@@ -257,7 +257,7 @@

Method Details

"a_key": "A String", }, "name": "A String", # A user-defined name of the dns authorization. DnsAuthorization names must be unique globally and match pattern `projects/*/locations/*/dnsAuthorizations/*`. - "type": "A String", # Immutable. Type of DnsAuthorization. If unset during resource creation the following default will be used: - in location global: FIXED_RECORD. + "type": "A String", # Immutable. Type of DnsAuthorization. If unset during resource creation the following default will be used: - in location `global`: FIXED_RECORD, - in other locations: PER_PROJECT_RECORD. "updateTime": "A String", # Output only. The last update timestamp of a DnsAuthorization. }, ], @@ -304,7 +304,7 @@

Method Details

"a_key": "A String", }, "name": "A String", # A user-defined name of the dns authorization. DnsAuthorization names must be unique globally and match pattern `projects/*/locations/*/dnsAuthorizations/*`. - "type": "A String", # Immutable. Type of DnsAuthorization. If unset during resource creation the following default will be used: - in location global: FIXED_RECORD. + "type": "A String", # Immutable. Type of DnsAuthorization. If unset during resource creation the following default will be used: - in location `global`: FIXED_RECORD, - in other locations: PER_PROJECT_RECORD. "updateTime": "A String", # Output only. The last update timestamp of a DnsAuthorization. } diff --git a/docs/dyn/classroom_v1.courses.announcements.html b/docs/dyn/classroom_v1.courses.announcements.html index 0d8b5afa2f9..a2858be0b3d 100644 --- a/docs/dyn/classroom_v1.courses.announcements.html +++ b/docs/dyn/classroom_v1.courses.announcements.html @@ -317,7 +317,7 @@

Method Details

courseId: string, Required. Identifier of the course. (required) itemId: string, Identifier of the announcement, courseWork, or courseWorkMaterial under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id. (required) addOnToken: string, Optional. Token that authorizes the request. The token is passed as a query parameter when the user is redirected from Classroom to the add-on's URL. The authorization token is required when neither of the following is true: * The add-on has attachments on the post. * The developer project issuing the request is the same project that created the post. - attachmentId: string, Optional. The identifier of the attachment. This field is required for student users and optional for teacher users. If not provided in the student case, an error is returned. + attachmentId: string, Optional. The identifier of the attachment. This field is required for all requests except when the user is in the [Attachment Discovery iframe](https://developers.google.com/classroom/add-ons/get-started/iframes/attachment-discovery-iframe). postId: string, Optional. Deprecated, use item_id instead. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/classroom_v1.courses.courseWork.html b/docs/dyn/classroom_v1.courses.courseWork.html index f772b9376fa..cb566efb8b4 100644 --- a/docs/dyn/classroom_v1.courses.courseWork.html +++ b/docs/dyn/classroom_v1.courses.courseWork.html @@ -427,7 +427,7 @@

Method Details

courseId: string, Required. Identifier of the course. (required) itemId: string, Identifier of the announcement, courseWork, or courseWorkMaterial under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id. (required) addOnToken: string, Optional. Token that authorizes the request. The token is passed as a query parameter when the user is redirected from Classroom to the add-on's URL. The authorization token is required when neither of the following is true: * The add-on has attachments on the post. * The developer project issuing the request is the same project that created the post. - attachmentId: string, Optional. The identifier of the attachment. This field is required for student users and optional for teacher users. If not provided in the student case, an error is returned. + attachmentId: string, Optional. The identifier of the attachment. This field is required for all requests except when the user is in the [Attachment Discovery iframe](https://developers.google.com/classroom/add-ons/get-started/iframes/attachment-discovery-iframe). postId: string, Optional. Deprecated, use item_id instead. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/classroom_v1.courses.courseWorkMaterials.html b/docs/dyn/classroom_v1.courses.courseWorkMaterials.html index 60dc67f5b2e..db4cef97d3e 100644 --- a/docs/dyn/classroom_v1.courses.courseWorkMaterials.html +++ b/docs/dyn/classroom_v1.courses.courseWorkMaterials.html @@ -320,7 +320,7 @@

Method Details

courseId: string, Required. Identifier of the course. (required) itemId: string, Identifier of the announcement, courseWork, or courseWorkMaterial under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id. (required) addOnToken: string, Optional. Token that authorizes the request. The token is passed as a query parameter when the user is redirected from Classroom to the add-on's URL. The authorization token is required when neither of the following is true: * The add-on has attachments on the post. * The developer project issuing the request is the same project that created the post. - attachmentId: string, Optional. The identifier of the attachment. This field is required for student users and optional for teacher users. If not provided in the student case, an error is returned. + attachmentId: string, Optional. The identifier of the attachment. This field is required for all requests except when the user is in the [Attachment Discovery iframe](https://developers.google.com/classroom/add-ons/get-started/iframes/attachment-discovery-iframe). postId: string, Optional. Deprecated, use item_id instead. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/classroom_v1.courses.posts.html b/docs/dyn/classroom_v1.courses.posts.html index ce6012db225..69854c1fe07 100644 --- a/docs/dyn/classroom_v1.courses.posts.html +++ b/docs/dyn/classroom_v1.courses.posts.html @@ -99,7 +99,7 @@

Method Details

courseId: string, Required. Identifier of the course. (required) postId: string, Optional. Deprecated, use item_id instead. (required) addOnToken: string, Optional. Token that authorizes the request. The token is passed as a query parameter when the user is redirected from Classroom to the add-on's URL. The authorization token is required when neither of the following is true: * The add-on has attachments on the post. * The developer project issuing the request is the same project that created the post. - attachmentId: string, Optional. The identifier of the attachment. This field is required for student users and optional for teacher users. If not provided in the student case, an error is returned. + attachmentId: string, Optional. The identifier of the attachment. This field is required for all requests except when the user is in the [Attachment Discovery iframe](https://developers.google.com/classroom/add-ons/get-started/iframes/attachment-discovery-iframe). itemId: string, Identifier of the announcement, courseWork, or courseWorkMaterial under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/cloudasset_v1.assets.html b/docs/dyn/cloudasset_v1.assets.html index e8682327109..74785f6737d 100644 --- a/docs/dyn/cloudasset_v1.assets.html +++ b/docs/dyn/cloudasset_v1.assets.html @@ -158,7 +158,7 @@

Method Details

], "vpcNetworkSources": [ # The request must originate from one of the provided VPC networks in Google Cloud. Cannot specify this field together with `ip_subnetworks`. { # The originating network source in Google Cloud. - "vpcSubnetwork": { # Sub-segment ranges inside of a VPC Network. # Sub-segment ranges of a VPC network. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "vpcSubnetwork": { # Sub-segment ranges inside of a VPC Network. # Sub-segment ranges of a VPC network. "network": "A String", # Required. Network name. If the network is not part of the organization, the `compute.network.get` permission must be granted to the caller. Format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NETWORK_NAME}` Example: `//compute.googleapis.com/projects/my-project/global/networks/network-1` "vpcIpSubnetworks": [ # CIDR block IP subnetwork specification. The IP address must be an IPv4 address and can be a public or private IP address. Note that for a CIDR IP address block, the specified IP address portion must be properly truncated (i.e. all the host bits must be zero) or the input is considered malformed. For example, "192.0.2.0/24" is accepted but "192.0.2.1/24" is not. If empty, all IP addresses are allowed. "A String", @@ -466,9 +466,9 @@

Method Details

], "identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. "sourceRestriction": "A String", # Whether to enforce traffic restrictions based on `sources` field. If the `sources` fields is non-empty, then this field must be set to `SOURCE_RESTRICTION_ENABLED`. - "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. - "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. }, ], }, @@ -550,9 +550,9 @@

Method Details

], "identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. "sourceRestriction": "A String", # Whether to enforce traffic restrictions based on `sources` field. If the `sources` fields is non-empty, then this field must be set to `SOURCE_RESTRICTION_ENABLED`. - "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. - "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. }, ], }, diff --git a/docs/dyn/cloudasset_v1.v1.html b/docs/dyn/cloudasset_v1.v1.html index eda1a58ed4b..61088d6130c 100644 --- a/docs/dyn/cloudasset_v1.v1.html +++ b/docs/dyn/cloudasset_v1.v1.html @@ -1046,7 +1046,7 @@

Method Details

], "vpcNetworkSources": [ # The request must originate from one of the provided VPC networks in Google Cloud. Cannot specify this field together with `ip_subnetworks`. { # The originating network source in Google Cloud. - "vpcSubnetwork": { # Sub-segment ranges inside of a VPC Network. # Sub-segment ranges of a VPC network. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "vpcSubnetwork": { # Sub-segment ranges inside of a VPC Network. # Sub-segment ranges of a VPC network. "network": "A String", # Required. Network name. If the network is not part of the organization, the `compute.network.get` permission must be granted to the caller. Format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NETWORK_NAME}` Example: `//compute.googleapis.com/projects/my-project/global/networks/network-1` "vpcIpSubnetworks": [ # CIDR block IP subnetwork specification. The IP address must be an IPv4 address and can be a public or private IP address. Note that for a CIDR IP address block, the specified IP address portion must be properly truncated (i.e. all the host bits must be zero) or the input is considered malformed. For example, "192.0.2.0/24" is accepted but "192.0.2.1/24" is not. If empty, all IP addresses are allowed. "A String", @@ -1354,9 +1354,9 @@

Method Details

], "identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. "sourceRestriction": "A String", # Whether to enforce traffic restrictions based on `sources` field. If the `sources` fields is non-empty, then this field must be set to `SOURCE_RESTRICTION_ENABLED`. - "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. - "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. }, ], }, @@ -1438,9 +1438,9 @@

Method Details

], "identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. "sourceRestriction": "A String", # Whether to enforce traffic restrictions based on `sources` field. If the `sources` fields is non-empty, then this field must be set to `SOURCE_RESTRICTION_ENABLED`. - "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. - "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. }, ], }, @@ -1555,7 +1555,7 @@

Method Details

], "vpcNetworkSources": [ # The request must originate from one of the provided VPC networks in Google Cloud. Cannot specify this field together with `ip_subnetworks`. { # The originating network source in Google Cloud. - "vpcSubnetwork": { # Sub-segment ranges inside of a VPC Network. # Sub-segment ranges of a VPC network. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "vpcSubnetwork": { # Sub-segment ranges inside of a VPC Network. # Sub-segment ranges of a VPC network. "network": "A String", # Required. Network name. If the network is not part of the organization, the `compute.network.get` permission must be granted to the caller. Format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NETWORK_NAME}` Example: `//compute.googleapis.com/projects/my-project/global/networks/network-1` "vpcIpSubnetworks": [ # CIDR block IP subnetwork specification. The IP address must be an IPv4 address and can be a public or private IP address. Note that for a CIDR IP address block, the specified IP address portion must be properly truncated (i.e. all the host bits must be zero) or the input is considered malformed. For example, "192.0.2.0/24" is accepted but "192.0.2.1/24" is not. If empty, all IP addresses are allowed. "A String", @@ -1863,9 +1863,9 @@

Method Details

], "identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. "sourceRestriction": "A String", # Whether to enforce traffic restrictions based on `sources` field. If the `sources` fields is non-empty, then this field must be set to `SOURCE_RESTRICTION_ENABLED`. - "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. - "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. }, ], }, @@ -1947,9 +1947,9 @@

Method Details

], "identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. "sourceRestriction": "A String", # Whether to enforce traffic restrictions based on `sources` field. If the `sources` fields is non-empty, then this field must be set to `SOURCE_RESTRICTION_ENABLED`. - "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. - "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. }, ], }, diff --git a/docs/dyn/cloudasset_v1beta1.organizations.html b/docs/dyn/cloudasset_v1beta1.organizations.html index 00d3ecdd0e0..a26d702ee7d 100644 --- a/docs/dyn/cloudasset_v1beta1.organizations.html +++ b/docs/dyn/cloudasset_v1beta1.organizations.html @@ -153,7 +153,7 @@

Method Details

], "vpcNetworkSources": [ # The request must originate from one of the provided VPC networks in Google Cloud. Cannot specify this field together with `ip_subnetworks`. { # The originating network source in Google Cloud. - "vpcSubnetwork": { # Sub-segment ranges inside of a VPC Network. # Sub-segment ranges of a VPC network. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "vpcSubnetwork": { # Sub-segment ranges inside of a VPC Network. # Sub-segment ranges of a VPC network. "network": "A String", # Required. Network name. If the network is not part of the organization, the `compute.network.get` permission must be granted to the caller. Format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NETWORK_NAME}` Example: `//compute.googleapis.com/projects/my-project/global/networks/network-1` "vpcIpSubnetworks": [ # CIDR block IP subnetwork specification. The IP address must be an IPv4 address and can be a public or private IP address. Note that for a CIDR IP address block, the specified IP address portion must be properly truncated (i.e. all the host bits must be zero) or the input is considered malformed. For example, "192.0.2.0/24" is accepted but "192.0.2.1/24" is not. If empty, all IP addresses are allowed. "A String", @@ -268,9 +268,9 @@

Method Details

], "identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. "sourceRestriction": "A String", # Whether to enforce traffic restrictions based on `sources` field. If the `sources` fields is non-empty, then this field must be set to `SOURCE_RESTRICTION_ENABLED`. - "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. - "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. }, ], }, @@ -352,9 +352,9 @@

Method Details

], "identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. "sourceRestriction": "A String", # Whether to enforce traffic restrictions based on `sources` field. If the `sources` fields is non-empty, then this field must be set to `SOURCE_RESTRICTION_ENABLED`. - "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. - "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. }, ], }, diff --git a/docs/dyn/cloudasset_v1beta1.projects.html b/docs/dyn/cloudasset_v1beta1.projects.html index 1ff73a11d59..9c99f0d09c9 100644 --- a/docs/dyn/cloudasset_v1beta1.projects.html +++ b/docs/dyn/cloudasset_v1beta1.projects.html @@ -153,7 +153,7 @@

Method Details

], "vpcNetworkSources": [ # The request must originate from one of the provided VPC networks in Google Cloud. Cannot specify this field together with `ip_subnetworks`. { # The originating network source in Google Cloud. - "vpcSubnetwork": { # Sub-segment ranges inside of a VPC Network. # Sub-segment ranges of a VPC network. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "vpcSubnetwork": { # Sub-segment ranges inside of a VPC Network. # Sub-segment ranges of a VPC network. "network": "A String", # Required. Network name. If the network is not part of the organization, the `compute.network.get` permission must be granted to the caller. Format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NETWORK_NAME}` Example: `//compute.googleapis.com/projects/my-project/global/networks/network-1` "vpcIpSubnetworks": [ # CIDR block IP subnetwork specification. The IP address must be an IPv4 address and can be a public or private IP address. Note that for a CIDR IP address block, the specified IP address portion must be properly truncated (i.e. all the host bits must be zero) or the input is considered malformed. For example, "192.0.2.0/24" is accepted but "192.0.2.1/24" is not. If empty, all IP addresses are allowed. "A String", @@ -268,9 +268,9 @@

Method Details

], "identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. "sourceRestriction": "A String", # Whether to enforce traffic restrictions based on `sources` field. If the `sources` fields is non-empty, then this field must be set to `SOURCE_RESTRICTION_ENABLED`. - "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. - "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. }, ], }, @@ -352,9 +352,9 @@

Method Details

], "identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. "sourceRestriction": "A String", # Whether to enforce traffic restrictions based on `sources` field. If the `sources` fields is non-empty, then this field must be set to `SOURCE_RESTRICTION_ENABLED`. - "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. - "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. }, ], }, diff --git a/docs/dyn/cloudasset_v1p5beta1.assets.html b/docs/dyn/cloudasset_v1p5beta1.assets.html index 12bef1eaf69..eca1de91d8e 100644 --- a/docs/dyn/cloudasset_v1p5beta1.assets.html +++ b/docs/dyn/cloudasset_v1p5beta1.assets.html @@ -155,7 +155,7 @@

Method Details

], "vpcNetworkSources": [ # The request must originate from one of the provided VPC networks in Google Cloud. Cannot specify this field together with `ip_subnetworks`. { # The originating network source in Google Cloud. - "vpcSubnetwork": { # Sub-segment ranges inside of a VPC Network. # Sub-segment ranges of a VPC network. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "vpcSubnetwork": { # Sub-segment ranges inside of a VPC Network. # Sub-segment ranges of a VPC network. "network": "A String", # Required. Network name. If the network is not part of the organization, the `compute.network.get` permission must be granted to the caller. Format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NETWORK_NAME}` Example: `//compute.googleapis.com/projects/my-project/global/networks/network-1` "vpcIpSubnetworks": [ # CIDR block IP subnetwork specification. The IP address must be an IPv4 address and can be a public or private IP address. Note that for a CIDR IP address block, the specified IP address portion must be properly truncated (i.e. all the host bits must be zero) or the input is considered malformed. For example, "192.0.2.0/24" is accepted but "192.0.2.1/24" is not. If empty, all IP addresses are allowed. "A String", @@ -273,9 +273,9 @@

Method Details

], "identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. "sourceRestriction": "A String", # Whether to enforce traffic restrictions based on `sources` field. If the `sources` fields is non-empty, then this field must be set to `SOURCE_RESTRICTION_ENABLED`. - "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. - "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. }, ], }, @@ -357,9 +357,9 @@

Method Details

], "identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. "sourceRestriction": "A String", # Whether to enforce traffic restrictions based on `sources` field. If the `sources` fields is non-empty, then this field must be set to `SOURCE_RESTRICTION_ENABLED`. - "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. - "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. }, ], }, diff --git a/docs/dyn/cloudcontrolspartner_v1.organizations.locations.customers.html b/docs/dyn/cloudcontrolspartner_v1.organizations.locations.customers.html index a53b33136d5..d0450779025 100644 --- a/docs/dyn/cloudcontrolspartner_v1.organizations.locations.customers.html +++ b/docs/dyn/cloudcontrolspartner_v1.organizations.locations.customers.html @@ -112,7 +112,7 @@

Method Details

An object of the form: { # Contains metadata around a Cloud Controls Partner Customer - "customerOnboardingState": { # Container for customer onboarding steps # Container for customer onboarding steps + "customerOnboardingState": { # Container for customer onboarding steps # Output only. Container for customer onboarding steps "onboardingSteps": [ # List of customer onboarding steps { # Container for customer onboarding information "completionState": "A String", # Output only. Current state of the step @@ -122,8 +122,8 @@

Method Details

}, ], }, - "displayName": "A String", # The customer organization's display name. E.g. "google.com". - "isOnboarded": True or False, # Indicates whether a customer is fully onboarded + "displayName": "A String", # Output only. The customer organization's display name. E.g. "google.com". + "isOnboarded": True or False, # Output only. Indicates whether a customer is fully onboarded "name": "A String", # Identifier. Format: `organizations/{organization}/locations/{location}/customers/{customer}` }
@@ -149,7 +149,7 @@

Method Details

{ # Response message for list customer Customers requests "customers": [ # List of customers { # Contains metadata around a Cloud Controls Partner Customer - "customerOnboardingState": { # Container for customer onboarding steps # Container for customer onboarding steps + "customerOnboardingState": { # Container for customer onboarding steps # Output only. Container for customer onboarding steps "onboardingSteps": [ # List of customer onboarding steps { # Container for customer onboarding information "completionState": "A String", # Output only. Current state of the step @@ -159,8 +159,8 @@

Method Details

}, ], }, - "displayName": "A String", # The customer organization's display name. E.g. "google.com". - "isOnboarded": True or False, # Indicates whether a customer is fully onboarded + "displayName": "A String", # Output only. The customer organization's display name. E.g. "google.com". + "isOnboarded": True or False, # Output only. Indicates whether a customer is fully onboarded "name": "A String", # Identifier. Format: `organizations/{organization}/locations/{location}/customers/{customer}` }, ], diff --git a/docs/dyn/cloudcontrolspartner_v1beta.organizations.locations.customers.html b/docs/dyn/cloudcontrolspartner_v1beta.organizations.locations.customers.html index eb0754056d8..0a8609c2d8f 100644 --- a/docs/dyn/cloudcontrolspartner_v1beta.organizations.locations.customers.html +++ b/docs/dyn/cloudcontrolspartner_v1beta.organizations.locations.customers.html @@ -112,7 +112,7 @@

Method Details

An object of the form: { # Contains metadata around a Cloud Controls Partner Customer - "customerOnboardingState": { # Container for customer onboarding steps # Container for customer onboarding steps + "customerOnboardingState": { # Container for customer onboarding steps # Output only. Container for customer onboarding steps "onboardingSteps": [ # List of customer onboarding steps { # Container for customer onboarding information "completionState": "A String", # Output only. Current state of the step @@ -122,8 +122,8 @@

Method Details

}, ], }, - "displayName": "A String", # The customer organization's display name. E.g. "google.com". - "isOnboarded": True or False, # Indicates whether a customer is fully onboarded + "displayName": "A String", # Output only. The customer organization's display name. E.g. "google.com". + "isOnboarded": True or False, # Output only. Indicates whether a customer is fully onboarded "name": "A String", # Identifier. Format: `organizations/{organization}/locations/{location}/customers/{customer}` }
@@ -149,7 +149,7 @@

Method Details

{ # Response message for list customer Customers requests "customers": [ # List of customers { # Contains metadata around a Cloud Controls Partner Customer - "customerOnboardingState": { # Container for customer onboarding steps # Container for customer onboarding steps + "customerOnboardingState": { # Container for customer onboarding steps # Output only. Container for customer onboarding steps "onboardingSteps": [ # List of customer onboarding steps { # Container for customer onboarding information "completionState": "A String", # Output only. Current state of the step @@ -159,8 +159,8 @@

Method Details

}, ], }, - "displayName": "A String", # The customer organization's display name. E.g. "google.com". - "isOnboarded": True or False, # Indicates whether a customer is fully onboarded + "displayName": "A String", # Output only. The customer organization's display name. E.g. "google.com". + "isOnboarded": True or False, # Output only. Indicates whether a customer is fully onboarded "name": "A String", # Identifier. Format: `organizations/{organization}/locations/{location}/customers/{customer}` }, ], diff --git a/docs/dyn/cloudfunctions_v1.projects.locations.functions.html b/docs/dyn/cloudfunctions_v1.projects.locations.functions.html index 5a3b311fea1..f0f796c78a6 100644 --- a/docs/dyn/cloudfunctions_v1.projects.locations.functions.html +++ b/docs/dyn/cloudfunctions_v1.projects.locations.functions.html @@ -225,7 +225,7 @@

Method Details

"sourceArchiveUrl": "A String", # The Google Cloud Storage URL, starting with `gs://`, pointing to the zip archive which contains the function. "sourceRepository": { # Describes SourceRepository, used to represent parameters related to source repository where a function is hosted. # **Beta Feature** The source repository where a function is hosted. "deployedUrl": "A String", # Output only. The URL pointing to the hosted repository where the function were defined at the time of deployment. It always points to a specific commit in the format described above. - "url": "A String", # The URL pointing to the hosted repository where the function is defined. There are supported Cloud Source Repository URLs in the following formats: To refer to a specific commit: `https://source.developers.google.com/projects/*/repos/*/revisions/*/paths/*` To refer to a moveable alias (branch): `https://source.developers.google.com/projects/*/repos/*/moveable-aliases/*/paths/*` In particular, to refer to HEAD use `master` moveable alias. To refer to a specific fixed alias (tag): `https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*` You may omit `paths/*` if you want to use the main directory. + "url": "A String", # The URL pointing to the hosted repository where the function is defined. There are supported Cloud Source Repository URLs in the following formats: To refer to a specific commit: `https://source.developers.google.com/projects/*/repos/*/revisions/*/paths/*` To refer to a moveable alias (branch): `https://source.developers.google.com/projects/*/repos/*/moveable-aliases/*/paths/*` In particular, to refer to HEAD use `master` moveable alias. To refer to a specific fixed alias (tag): `https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*` You may omit `paths/*` if you want to use the main directory. The function response may add an empty `/paths/` to the URL. }, "sourceToken": "A String", # Input only. An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments. "sourceUploadUrl": "A String", # The Google Cloud Storage signed URL used for source uploading, generated by calling [google.cloud.functions.v1.GenerateUploadUrl]. The signature is validated on write methods (Create, Update) The signature is stripped from the Function object on read methods (Get, List) @@ -437,7 +437,7 @@

Method Details

"sourceArchiveUrl": "A String", # The Google Cloud Storage URL, starting with `gs://`, pointing to the zip archive which contains the function. "sourceRepository": { # Describes SourceRepository, used to represent parameters related to source repository where a function is hosted. # **Beta Feature** The source repository where a function is hosted. "deployedUrl": "A String", # Output only. The URL pointing to the hosted repository where the function were defined at the time of deployment. It always points to a specific commit in the format described above. - "url": "A String", # The URL pointing to the hosted repository where the function is defined. There are supported Cloud Source Repository URLs in the following formats: To refer to a specific commit: `https://source.developers.google.com/projects/*/repos/*/revisions/*/paths/*` To refer to a moveable alias (branch): `https://source.developers.google.com/projects/*/repos/*/moveable-aliases/*/paths/*` In particular, to refer to HEAD use `master` moveable alias. To refer to a specific fixed alias (tag): `https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*` You may omit `paths/*` if you want to use the main directory. + "url": "A String", # The URL pointing to the hosted repository where the function is defined. There are supported Cloud Source Repository URLs in the following formats: To refer to a specific commit: `https://source.developers.google.com/projects/*/repos/*/revisions/*/paths/*` To refer to a moveable alias (branch): `https://source.developers.google.com/projects/*/repos/*/moveable-aliases/*/paths/*` In particular, to refer to HEAD use `master` moveable alias. To refer to a specific fixed alias (tag): `https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*` You may omit `paths/*` if you want to use the main directory. The function response may add an empty `/paths/` to the URL. }, "sourceToken": "A String", # Input only. An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments. "sourceUploadUrl": "A String", # The Google Cloud Storage signed URL used for source uploading, generated by calling [google.cloud.functions.v1.GenerateUploadUrl]. The signature is validated on write methods (Create, Update) The signature is stripped from the Function object on read methods (Get, List) @@ -585,7 +585,7 @@

Method Details

"sourceArchiveUrl": "A String", # The Google Cloud Storage URL, starting with `gs://`, pointing to the zip archive which contains the function. "sourceRepository": { # Describes SourceRepository, used to represent parameters related to source repository where a function is hosted. # **Beta Feature** The source repository where a function is hosted. "deployedUrl": "A String", # Output only. The URL pointing to the hosted repository where the function were defined at the time of deployment. It always points to a specific commit in the format described above. - "url": "A String", # The URL pointing to the hosted repository where the function is defined. There are supported Cloud Source Repository URLs in the following formats: To refer to a specific commit: `https://source.developers.google.com/projects/*/repos/*/revisions/*/paths/*` To refer to a moveable alias (branch): `https://source.developers.google.com/projects/*/repos/*/moveable-aliases/*/paths/*` In particular, to refer to HEAD use `master` moveable alias. To refer to a specific fixed alias (tag): `https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*` You may omit `paths/*` if you want to use the main directory. + "url": "A String", # The URL pointing to the hosted repository where the function is defined. There are supported Cloud Source Repository URLs in the following formats: To refer to a specific commit: `https://source.developers.google.com/projects/*/repos/*/revisions/*/paths/*` To refer to a moveable alias (branch): `https://source.developers.google.com/projects/*/repos/*/moveable-aliases/*/paths/*` In particular, to refer to HEAD use `master` moveable alias. To refer to a specific fixed alias (tag): `https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*` You may omit `paths/*` if you want to use the main directory. The function response may add an empty `/paths/` to the URL. }, "sourceToken": "A String", # Input only. An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments. "sourceUploadUrl": "A String", # The Google Cloud Storage signed URL used for source uploading, generated by calling [google.cloud.functions.v1.GenerateUploadUrl]. The signature is validated on write methods (Create, Update) The signature is stripped from the Function object on read methods (Get, List) @@ -696,7 +696,7 @@

Method Details

"sourceArchiveUrl": "A String", # The Google Cloud Storage URL, starting with `gs://`, pointing to the zip archive which contains the function. "sourceRepository": { # Describes SourceRepository, used to represent parameters related to source repository where a function is hosted. # **Beta Feature** The source repository where a function is hosted. "deployedUrl": "A String", # Output only. The URL pointing to the hosted repository where the function were defined at the time of deployment. It always points to a specific commit in the format described above. - "url": "A String", # The URL pointing to the hosted repository where the function is defined. There are supported Cloud Source Repository URLs in the following formats: To refer to a specific commit: `https://source.developers.google.com/projects/*/repos/*/revisions/*/paths/*` To refer to a moveable alias (branch): `https://source.developers.google.com/projects/*/repos/*/moveable-aliases/*/paths/*` In particular, to refer to HEAD use `master` moveable alias. To refer to a specific fixed alias (tag): `https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*` You may omit `paths/*` if you want to use the main directory. + "url": "A String", # The URL pointing to the hosted repository where the function is defined. There are supported Cloud Source Repository URLs in the following formats: To refer to a specific commit: `https://source.developers.google.com/projects/*/repos/*/revisions/*/paths/*` To refer to a moveable alias (branch): `https://source.developers.google.com/projects/*/repos/*/moveable-aliases/*/paths/*` In particular, to refer to HEAD use `master` moveable alias. To refer to a specific fixed alias (tag): `https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*` You may omit `paths/*` if you want to use the main directory. The function response may add an empty `/paths/` to the URL. }, "sourceToken": "A String", # Input only. An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments. "sourceUploadUrl": "A String", # The Google Cloud Storage signed URL used for source uploading, generated by calling [google.cloud.functions.v1.GenerateUploadUrl]. The signature is validated on write methods (Create, Update) The signature is stripped from the Function object on read methods (Get, List) diff --git a/docs/dyn/cloudtrace_v2beta1.projects.traceSinks.html b/docs/dyn/cloudtrace_v2beta1.projects.traceSinks.html index 8792212b774..1967ebdddc2 100644 --- a/docs/dyn/cloudtrace_v2beta1.projects.traceSinks.html +++ b/docs/dyn/cloudtrace_v2beta1.projects.traceSinks.html @@ -111,9 +111,9 @@

Method Details

The object takes the form of: { # Describes a sink used to export traces to a BigQuery dataset. The sink must be created within a project. - "name": "A String", # Required. The canonical sink resource name, unique within the project. Must be of the form: projects/[PROJECT_NUMBER]/traceSinks/[SINK_ID]. E.g.: `"projects/12345/traceSinks/my-project-trace-sink"`. Sink identifiers are limited to 256 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods. + "name": "A String", # Identifier. The canonical sink resource name, unique within the project. Must be of the form: projects/[PROJECT_NUMBER]/traceSinks/[SINK_ID]. E.g.: `"projects/12345/traceSinks/my-project-trace-sink"`. Sink identifiers are limited to 256 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods. "outputConfig": { # OutputConfig contains a destination for writing trace data. # Required. The export destination. - "destination": "A String", # The destination for writing trace data. Supported formats include: "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]" + "destination": "A String", # Required. The destination for writing trace data. Supported formats include: "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]" }, "writerIdentity": "A String", # Output only. A service account name for exporting the data. This field is set by sinks.create and sinks.update. The service account will need to be granted write access to the destination specified in the output configuration, see [Granting access for a resource](/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). To create tables and to write data, this account needs the `dataEditor` role. Read more about roles in the [BigQuery documentation](https://cloud.google.com/bigquery/docs/access-control). E.g.: "service-00000001@00000002.iam.gserviceaccount.com" } @@ -127,9 +127,9 @@

Method Details

An object of the form: { # Describes a sink used to export traces to a BigQuery dataset. The sink must be created within a project. - "name": "A String", # Required. The canonical sink resource name, unique within the project. Must be of the form: projects/[PROJECT_NUMBER]/traceSinks/[SINK_ID]. E.g.: `"projects/12345/traceSinks/my-project-trace-sink"`. Sink identifiers are limited to 256 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods. + "name": "A String", # Identifier. The canonical sink resource name, unique within the project. Must be of the form: projects/[PROJECT_NUMBER]/traceSinks/[SINK_ID]. E.g.: `"projects/12345/traceSinks/my-project-trace-sink"`. Sink identifiers are limited to 256 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods. "outputConfig": { # OutputConfig contains a destination for writing trace data. # Required. The export destination. - "destination": "A String", # The destination for writing trace data. Supported formats include: "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]" + "destination": "A String", # Required. The destination for writing trace data. Supported formats include: "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]" }, "writerIdentity": "A String", # Output only. A service account name for exporting the data. This field is set by sinks.create and sinks.update. The service account will need to be granted write access to the destination specified in the output configuration, see [Granting access for a resource](/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). To create tables and to write data, this account needs the `dataEditor` role. Read more about roles in the [BigQuery documentation](https://cloud.google.com/bigquery/docs/access-control). E.g.: "service-00000001@00000002.iam.gserviceaccount.com" }
@@ -168,9 +168,9 @@

Method Details

An object of the form: { # Describes a sink used to export traces to a BigQuery dataset. The sink must be created within a project. - "name": "A String", # Required. The canonical sink resource name, unique within the project. Must be of the form: projects/[PROJECT_NUMBER]/traceSinks/[SINK_ID]. E.g.: `"projects/12345/traceSinks/my-project-trace-sink"`. Sink identifiers are limited to 256 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods. + "name": "A String", # Identifier. The canonical sink resource name, unique within the project. Must be of the form: projects/[PROJECT_NUMBER]/traceSinks/[SINK_ID]. E.g.: `"projects/12345/traceSinks/my-project-trace-sink"`. Sink identifiers are limited to 256 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods. "outputConfig": { # OutputConfig contains a destination for writing trace data. # Required. The export destination. - "destination": "A String", # The destination for writing trace data. Supported formats include: "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]" + "destination": "A String", # Required. The destination for writing trace data. Supported formats include: "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]" }, "writerIdentity": "A String", # Output only. A service account name for exporting the data. This field is set by sinks.create and sinks.update. The service account will need to be granted write access to the destination specified in the output configuration, see [Granting access for a resource](/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). To create tables and to write data, this account needs the `dataEditor` role. Read more about roles in the [BigQuery documentation](https://cloud.google.com/bigquery/docs/access-control). E.g.: "service-00000001@00000002.iam.gserviceaccount.com" }
@@ -196,9 +196,9 @@

Method Details

"nextPageToken": "A String", # A paginated response where more pages might be available has `next_page_token` set. To get the next set of results, call the same method again using the value of `next_page_token` as `page_token`. "sinks": [ # A list of sinks. { # Describes a sink used to export traces to a BigQuery dataset. The sink must be created within a project. - "name": "A String", # Required. The canonical sink resource name, unique within the project. Must be of the form: projects/[PROJECT_NUMBER]/traceSinks/[SINK_ID]. E.g.: `"projects/12345/traceSinks/my-project-trace-sink"`. Sink identifiers are limited to 256 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods. + "name": "A String", # Identifier. The canonical sink resource name, unique within the project. Must be of the form: projects/[PROJECT_NUMBER]/traceSinks/[SINK_ID]. E.g.: `"projects/12345/traceSinks/my-project-trace-sink"`. Sink identifiers are limited to 256 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods. "outputConfig": { # OutputConfig contains a destination for writing trace data. # Required. The export destination. - "destination": "A String", # The destination for writing trace data. Supported formats include: "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]" + "destination": "A String", # Required. The destination for writing trace data. Supported formats include: "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]" }, "writerIdentity": "A String", # Output only. A service account name for exporting the data. This field is set by sinks.create and sinks.update. The service account will need to be granted write access to the destination specified in the output configuration, see [Granting access for a resource](/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). To create tables and to write data, this account needs the `dataEditor` role. Read more about roles in the [BigQuery documentation](https://cloud.google.com/bigquery/docs/access-control). E.g.: "service-00000001@00000002.iam.gserviceaccount.com" }, @@ -230,9 +230,9 @@

Method Details

The object takes the form of: { # Describes a sink used to export traces to a BigQuery dataset. The sink must be created within a project. - "name": "A String", # Required. The canonical sink resource name, unique within the project. Must be of the form: projects/[PROJECT_NUMBER]/traceSinks/[SINK_ID]. E.g.: `"projects/12345/traceSinks/my-project-trace-sink"`. Sink identifiers are limited to 256 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods. + "name": "A String", # Identifier. The canonical sink resource name, unique within the project. Must be of the form: projects/[PROJECT_NUMBER]/traceSinks/[SINK_ID]. E.g.: `"projects/12345/traceSinks/my-project-trace-sink"`. Sink identifiers are limited to 256 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods. "outputConfig": { # OutputConfig contains a destination for writing trace data. # Required. The export destination. - "destination": "A String", # The destination for writing trace data. Supported formats include: "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]" + "destination": "A String", # Required. The destination for writing trace data. Supported formats include: "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]" }, "writerIdentity": "A String", # Output only. A service account name for exporting the data. This field is set by sinks.create and sinks.update. The service account will need to be granted write access to the destination specified in the output configuration, see [Granting access for a resource](/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). To create tables and to write data, this account needs the `dataEditor` role. Read more about roles in the [BigQuery documentation](https://cloud.google.com/bigquery/docs/access-control). E.g.: "service-00000001@00000002.iam.gserviceaccount.com" } @@ -247,9 +247,9 @@

Method Details

An object of the form: { # Describes a sink used to export traces to a BigQuery dataset. The sink must be created within a project. - "name": "A String", # Required. The canonical sink resource name, unique within the project. Must be of the form: projects/[PROJECT_NUMBER]/traceSinks/[SINK_ID]. E.g.: `"projects/12345/traceSinks/my-project-trace-sink"`. Sink identifiers are limited to 256 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods. + "name": "A String", # Identifier. The canonical sink resource name, unique within the project. Must be of the form: projects/[PROJECT_NUMBER]/traceSinks/[SINK_ID]. E.g.: `"projects/12345/traceSinks/my-project-trace-sink"`. Sink identifiers are limited to 256 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods. "outputConfig": { # OutputConfig contains a destination for writing trace data. # Required. The export destination. - "destination": "A String", # The destination for writing trace data. Supported formats include: "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]" + "destination": "A String", # Required. The destination for writing trace data. Supported formats include: "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]" }, "writerIdentity": "A String", # Output only. A service account name for exporting the data. This field is set by sinks.create and sinks.update. The service account will need to be granted write access to the destination specified in the output configuration, see [Granting access for a resource](/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). To create tables and to write data, this account needs the `dataEditor` role. Read more about roles in the [BigQuery documentation](https://cloud.google.com/bigquery/docs/access-control). E.g.: "service-00000001@00000002.iam.gserviceaccount.com" }
diff --git a/docs/dyn/composer_v1.projects.locations.environments.html b/docs/dyn/composer_v1.projects.locations.environments.html index 537fa162fd9..2a6e2251d38 100644 --- a/docs/dyn/composer_v1.projects.locations.environments.html +++ b/docs/dyn/composer_v1.projects.locations.environments.html @@ -347,6 +347,7 @@

Method Details

"a_key": "A String", }, "name": "A String", # The resource name of the environment, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" EnvironmentId must start with a lowercase letter followed by up to 63 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. + "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. Reserved for future use. "state": "A String", # The current state of the environment. "storageConfig": { # The configuration for data storage in the environment. # Optional. Storage configuration for this environment. @@ -685,6 +686,7 @@

Method Details

"a_key": "A String", }, "name": "A String", # The resource name of the environment, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" EnvironmentId must start with a lowercase letter followed by up to 63 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. + "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. Reserved for future use. "state": "A String", # The current state of the environment. "storageConfig": { # The configuration for data storage in the environment. # Optional. Storage configuration for this environment. @@ -869,6 +871,7 @@

Method Details

"a_key": "A String", }, "name": "A String", # The resource name of the environment, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" EnvironmentId must start with a lowercase letter followed by up to 63 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. + "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. Reserved for future use. "state": "A String", # The current state of the environment. "storageConfig": { # The configuration for data storage in the environment. # Optional. Storage configuration for this environment. @@ -1107,6 +1110,7 @@

Method Details

"a_key": "A String", }, "name": "A String", # The resource name of the environment, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" EnvironmentId must start with a lowercase letter followed by up to 63 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. + "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. Reserved for future use. "state": "A String", # The current state of the environment. "storageConfig": { # The configuration for data storage in the environment. # Optional. Storage configuration for this environment. diff --git a/docs/dyn/composer_v1beta1.projects.locations.environments.html b/docs/dyn/composer_v1beta1.projects.locations.environments.html index 518a43c16d8..82dd8d0b9b1 100644 --- a/docs/dyn/composer_v1beta1.projects.locations.environments.html +++ b/docs/dyn/composer_v1beta1.projects.locations.environments.html @@ -352,6 +352,7 @@

Method Details

"a_key": "A String", }, "name": "A String", # The resource name of the environment, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" EnvironmentId must start with a lowercase letter followed by up to 63 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. + "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. Reserved for future use. "state": "A String", # The current state of the environment. "storageConfig": { # The configuration for data storage in the environment. # Optional. Storage configuration for this environment. @@ -692,6 +693,7 @@

Method Details

"a_key": "A String", }, "name": "A String", # The resource name of the environment, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" EnvironmentId must start with a lowercase letter followed by up to 63 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. + "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. Reserved for future use. "state": "A String", # The current state of the environment. "storageConfig": { # The configuration for data storage in the environment. # Optional. Storage configuration for this environment. @@ -878,6 +880,7 @@

Method Details

"a_key": "A String", }, "name": "A String", # The resource name of the environment, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" EnvironmentId must start with a lowercase letter followed by up to 63 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. + "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. Reserved for future use. "state": "A String", # The current state of the environment. "storageConfig": { # The configuration for data storage in the environment. # Optional. Storage configuration for this environment. @@ -1118,6 +1121,7 @@

Method Details

"a_key": "A String", }, "name": "A String", # The resource name of the environment, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" EnvironmentId must start with a lowercase letter followed by up to 63 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. + "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. Reserved for future use. "state": "A String", # The current state of the environment. "storageConfig": { # The configuration for data storage in the environment. # Optional. Storage configuration for this environment. diff --git a/docs/dyn/compute_alpha.html b/docs/dyn/compute_alpha.html index 79f8b7810f0..20547da92bb 100644 --- a/docs/dyn/compute_alpha.html +++ b/docs/dyn/compute_alpha.html @@ -224,6 +224,11 @@

Instance Methods

Returns the instances Resource.

+

+ instantSnapshotGroups() +

+

Returns the instantSnapshotGroups Resource.

+

instantSnapshots()

@@ -384,6 +389,11 @@

Instance Methods

Returns the regionHealthChecks Resource.

+

+ regionInstanceGroupManagerResizeRequests() +

+

Returns the regionInstanceGroupManagerResizeRequests Resource.

+

regionInstanceGroupManagers()

@@ -404,6 +414,11 @@

Instance Methods

Returns the regionInstances Resource.

+

+ regionInstantSnapshotGroups() +

+

Returns the regionInstantSnapshotGroups Resource.

+

regionInstantSnapshots()

diff --git a/docs/dyn/compute_alpha.instanceGroupManagers.html b/docs/dyn/compute_alpha.instanceGroupManagers.html index c3fd7e97f85..9a80e32b2b2 100644 --- a/docs/dyn/compute_alpha.instanceGroupManagers.html +++ b/docs/dyn/compute_alpha.instanceGroupManagers.html @@ -441,6 +441,9 @@

Method Details

}, }, "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources). + "resourcePolicies": { # Resource policies for this managed instance group. + "workloadPolicy": "A String", # The URL of the workload policy that is specified for this managed instance group. It can be a full or partial URL. For example, the following are all valid URLs to a workload policy: - https://www.googleapis.com/compute/v1/projects/project/regions/region /resourcePolicies/resourcePolicy - projects/project/regions/region/resourcePolicies/resourcePolicy - regions/region/resourcePolicies/resourcePolicy + }, "satisfiesPzi": True or False, # [Output Only] Reserved for future use. "satisfiesPzs": True or False, # [Output Only] Reserved for future use. "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL. @@ -1402,6 +1405,9 @@

Method Details

}, }, "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources). + "resourcePolicies": { # Resource policies for this managed instance group. + "workloadPolicy": "A String", # The URL of the workload policy that is specified for this managed instance group. It can be a full or partial URL. For example, the following are all valid URLs to a workload policy: - https://www.googleapis.com/compute/v1/projects/project/regions/region /resourcePolicies/resourcePolicy - projects/project/regions/region/resourcePolicies/resourcePolicy - regions/region/resourcePolicies/resourcePolicy + }, "satisfiesPzi": True or False, # [Output Only] Reserved for future use. "satisfiesPzs": True or False, # [Output Only] Reserved for future use. "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL. @@ -1602,6 +1608,9 @@

Method Details

}, }, "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources). + "resourcePolicies": { # Resource policies for this managed instance group. + "workloadPolicy": "A String", # The URL of the workload policy that is specified for this managed instance group. It can be a full or partial URL. For example, the following are all valid URLs to a workload policy: - https://www.googleapis.com/compute/v1/projects/project/regions/region /resourcePolicies/resourcePolicy - projects/project/regions/region/resourcePolicies/resourcePolicy - regions/region/resourcePolicies/resourcePolicy + }, "satisfiesPzi": True or False, # [Output Only] Reserved for future use. "satisfiesPzs": True or False, # [Output Only] Reserved for future use. "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL. @@ -1932,6 +1941,9 @@

Method Details

}, }, "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources). + "resourcePolicies": { # Resource policies for this managed instance group. + "workloadPolicy": "A String", # The URL of the workload policy that is specified for this managed instance group. It can be a full or partial URL. For example, the following are all valid URLs to a workload policy: - https://www.googleapis.com/compute/v1/projects/project/regions/region /resourcePolicies/resourcePolicy - projects/project/regions/region/resourcePolicies/resourcePolicy - regions/region/resourcePolicies/resourcePolicy + }, "satisfiesPzi": True or False, # [Output Only] Reserved for future use. "satisfiesPzs": True or False, # [Output Only] Reserved for future use. "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL. @@ -2485,6 +2497,9 @@

Method Details

}, }, "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources). + "resourcePolicies": { # Resource policies for this managed instance group. + "workloadPolicy": "A String", # The URL of the workload policy that is specified for this managed instance group. It can be a full or partial URL. For example, the following are all valid URLs to a workload policy: - https://www.googleapis.com/compute/v1/projects/project/regions/region /resourcePolicies/resourcePolicy - projects/project/regions/region/resourcePolicies/resourcePolicy - regions/region/resourcePolicies/resourcePolicy + }, "satisfiesPzi": True or False, # [Output Only] Reserved for future use. "satisfiesPzs": True or False, # [Output Only] Reserved for future use. "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL. @@ -4357,6 +4372,9 @@

Method Details

}, }, "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources). + "resourcePolicies": { # Resource policies for this managed instance group. + "workloadPolicy": "A String", # The URL of the workload policy that is specified for this managed instance group. It can be a full or partial URL. For example, the following are all valid URLs to a workload policy: - https://www.googleapis.com/compute/v1/projects/project/regions/region /resourcePolicies/resourcePolicy - projects/project/regions/region/resourcePolicies/resourcePolicy - regions/region/resourcePolicies/resourcePolicy + }, "satisfiesPzi": True or False, # [Output Only] Reserved for future use. "satisfiesPzs": True or False, # [Output Only] Reserved for future use. "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL. diff --git a/docs/dyn/compute_alpha.instantSnapshotGroups.html b/docs/dyn/compute_alpha.instantSnapshotGroups.html new file mode 100644 index 00000000000..b85ea5aa722 --- /dev/null +++ b/docs/dyn/compute_alpha.instantSnapshotGroups.html @@ -0,0 +1,490 @@ + + + +

Compute Engine API . instantSnapshotGroups

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ delete(project, zone, instantSnapshotGroup, requestId=None, x__xgafv=None)

+

deletes a Zonal InstantSnapshotGroup resource

+

+ get(project, zone, instantSnapshotGroup, x__xgafv=None)

+

returns the specified InstantSnapshotGroup resource in the specified zone.

+

+ insert(project, zone, body=None, requestId=None, sourceConsistencyGroup=None, x__xgafv=None)

+

inserts a Zonal InstantSnapshotGroup resource

+

+ list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

retrieves the list of InstantSnapshotGroup resources contained within the specified zone.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ delete(project, zone, instantSnapshotGroup, requestId=None, x__xgafv=None) +
deletes a Zonal InstantSnapshotGroup resource
+
+Args:
+  project: string, Project ID for this request. (required)
+  zone: string, The name of the zone for this request. (required)
+  instantSnapshotGroup: string, Name of the InstantSnapshot resource to delete. (required)
+  requestId: string, An optional 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. 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).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zoneOperations` resource. For more information, read Global, Regional, and Zonal Resources. Note that completed Operation resources have a limited retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error. Keys must match /a-z+/ but should ideally be lowerCamelCase. Also they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key). Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
+  "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key). Example key: zones/us-central1-a
+      "a_key": {
+        "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). # [Output Only] If state is `ABANDONED` or `FAILED`, this field is populated.
+          "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.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following: `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
+}
+
+ +
+ get(project, zone, instantSnapshotGroup, x__xgafv=None) +
returns the specified InstantSnapshotGroup resource in the specified zone.
+
+Args:
+  project: string, Project ID for this request. (required)
+  zone: string, The name of the zone for this request. (required)
+  instantSnapshotGroup: string, Name of the instantSnapshotGroup resource to return. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+  "description": "A String", # Optional. An optional description of this resource. Provide this property when you create the resource.
+  "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+  "kind": "compute#instantSnapshotGroup", # [Output Only] Type of the resource. Always compute#instantSnapshotGroup for InstantSnapshotGroup resources.
+  "name": "A String", # Identifier. Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+  "region": "A String", # [Output Only] URL of the region where the instant snapshot group resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
+  "resourceStatus": {
+    "consistencyMembershipResolutionTime": "A String", # [Output Only]
+    "sourceInfo": { # [Output Only]
+      "consistencyGroup": "A String",
+      "consistencyGroupId": "A String",
+    },
+  },
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource's resource id.
+  "status": "A String", # [Output Only]
+  "zone": "A String", # [Output Only] URL of the zone where the instant snapshot group resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
+}
+
+ +
+ insert(project, zone, body=None, requestId=None, sourceConsistencyGroup=None, x__xgafv=None) +
inserts a Zonal InstantSnapshotGroup resource
+
+Args:
+  project: string, Project ID for this request. (required)
+  zone: string, Name of the zone for this request. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{
+  "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+  "description": "A String", # Optional. An optional description of this resource. Provide this property when you create the resource.
+  "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+  "kind": "compute#instantSnapshotGroup", # [Output Only] Type of the resource. Always compute#instantSnapshotGroup for InstantSnapshotGroup resources.
+  "name": "A String", # Identifier. Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+  "region": "A String", # [Output Only] URL of the region where the instant snapshot group resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
+  "resourceStatus": {
+    "consistencyMembershipResolutionTime": "A String", # [Output Only]
+    "sourceInfo": { # [Output Only]
+      "consistencyGroup": "A String",
+      "consistencyGroupId": "A String",
+    },
+  },
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource's resource id.
+  "status": "A String", # [Output Only]
+  "zone": "A String", # [Output Only] URL of the zone where the instant snapshot group resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
+}
+
+  requestId: string, An optional 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. 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).
+  sourceConsistencyGroup: string, begin_interface: MixerMutationRequestBuilder
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zoneOperations` resource. For more information, read Global, Regional, and Zonal Resources. Note that completed Operation resources have a limited retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error. Keys must match /a-z+/ but should ideally be lowerCamelCase. Also they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key). Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
+  "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key). Example key: zones/us-central1-a
+      "a_key": {
+        "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). # [Output Only] If state is `ABANDONED` or `FAILED`, this field is populated.
+          "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.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following: `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
+}
+
+ +
+ list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) +
retrieves the list of InstantSnapshotGroup resources contained within the specified zone.
+
+Args:
+  project: string, Project ID for this request. (required)
+  zone: string, The name of the zone for this request. (required)
+  filter: string, A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.
+  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
+  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.
+  pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
+  returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Contains a list of InstantSnapshotGroup resources.
+  "etag": "A String",
+  "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+  "items": [ # A list of InstantSnapshotGroup resources.
+    {
+      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+      "description": "A String", # Optional. An optional description of this resource. Provide this property when you create the resource.
+      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+      "kind": "compute#instantSnapshotGroup", # [Output Only] Type of the resource. Always compute#instantSnapshotGroup for InstantSnapshotGroup resources.
+      "name": "A String", # Identifier. Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+      "region": "A String", # [Output Only] URL of the region where the instant snapshot group resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
+      "resourceStatus": {
+        "consistencyMembershipResolutionTime": "A String", # [Output Only]
+        "sourceInfo": { # [Output Only]
+          "consistencyGroup": "A String",
+          "consistencyGroupId": "A String",
+        },
+      },
+      "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+      "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource's resource id.
+      "status": "A String", # [Output Only]
+      "zone": "A String", # [Output Only] URL of the zone where the instant snapshot group resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
+    },
+  ],
+  "kind": "compute#instantSnapshotGroupsList", # Type of resource.
+  "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+  "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+  "unreachables": [ # [Output Only] Unreachable resources. end_interface: MixerListResponseWithEtagBuilder
+    "A String",
+  ],
+  "warning": { # [Output Only] Informational warning message.
+    "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+    "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+      {
+        "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+        "value": "A String", # [Output Only] A warning data value corresponding to the key.
+      },
+    ],
+    "message": "A String", # [Output Only] A human-readable description of the warning code.
+  },
+}
+
+ +
+ 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/compute_alpha.interconnects.html b/docs/dyn/compute_alpha.interconnects.html index d070351c802..6789842e579 100644 --- a/docs/dyn/compute_alpha.interconnects.html +++ b/docs/dyn/compute_alpha.interconnects.html @@ -271,6 +271,14 @@

Method Details

}, ], }, + "egressMinBandwidthPercentagePolicy": { + "bandwidthPercentages": [ # Specify bandwidth percentages for various traffic classes for queuing type Bandwidth Percent. + { # Specify bandwidth percentages [1-100] for various traffic classes in BandwidthPercentagePolicy. The sum of all percentages must equal 100. All traffic classes must have a percentage value specified. + "percentage": 42, # Bandwidth percentage for a specific traffic class. + "trafficClass": "A String", # TrafficClass whose bandwidth percentage is being specified. + }, + ], + }, "profileDescription": "A String", # A description for the AAI profile on this interconnect. "strictPriorityPolicy": { # Specify configuration for StrictPriorityPolicy. }, @@ -554,6 +562,14 @@

Method Details

}, ], }, + "egressMinBandwidthPercentagePolicy": { + "bandwidthPercentages": [ # Specify bandwidth percentages for various traffic classes for queuing type Bandwidth Percent. + { # Specify bandwidth percentages [1-100] for various traffic classes in BandwidthPercentagePolicy. The sum of all percentages must equal 100. All traffic classes must have a percentage value specified. + "percentage": 42, # Bandwidth percentage for a specific traffic class. + "trafficClass": "A String", # TrafficClass whose bandwidth percentage is being specified. + }, + ], + }, "profileDescription": "A String", # A description for the AAI profile on this interconnect. "strictPriorityPolicy": { # Specify configuration for StrictPriorityPolicy. }, @@ -777,6 +793,14 @@

Method Details

}, ], }, + "egressMinBandwidthPercentagePolicy": { + "bandwidthPercentages": [ # Specify bandwidth percentages for various traffic classes for queuing type Bandwidth Percent. + { # Specify bandwidth percentages [1-100] for various traffic classes in BandwidthPercentagePolicy. The sum of all percentages must equal 100. All traffic classes must have a percentage value specified. + "percentage": 42, # Bandwidth percentage for a specific traffic class. + "trafficClass": "A String", # TrafficClass whose bandwidth percentage is being specified. + }, + ], + }, "profileDescription": "A String", # A description for the AAI profile on this interconnect. "strictPriorityPolicy": { # Specify configuration for StrictPriorityPolicy. }, @@ -900,6 +924,14 @@

Method Details

}, ], }, + "egressMinBandwidthPercentagePolicy": { + "bandwidthPercentages": [ # Specify bandwidth percentages for various traffic classes for queuing type Bandwidth Percent. + { # Specify bandwidth percentages [1-100] for various traffic classes in BandwidthPercentagePolicy. The sum of all percentages must equal 100. All traffic classes must have a percentage value specified. + "percentage": 42, # Bandwidth percentage for a specific traffic class. + "trafficClass": "A String", # TrafficClass whose bandwidth percentage is being specified. + }, + ], + }, "profileDescription": "A String", # A description for the AAI profile on this interconnect. "strictPriorityPolicy": { # Specify configuration for StrictPriorityPolicy. }, diff --git a/docs/dyn/compute_alpha.regionInstanceGroupManagerResizeRequests.html b/docs/dyn/compute_alpha.regionInstanceGroupManagerResizeRequests.html new file mode 100644 index 00000000000..3d327f613e8 --- /dev/null +++ b/docs/dyn/compute_alpha.regionInstanceGroupManagerResizeRequests.html @@ -0,0 +1,479 @@ + + + +

Compute Engine API . regionInstanceGroupManagerResizeRequests

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(project, region, instanceGroupManager, resizeRequest, x__xgafv=None)

+

Returns all of the details about the specified resize request.

+

+ insert(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)

+

Creates a new Resize Request that starts provisioning VMs immediately or queues VM creation.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(project, region, instanceGroupManager, resizeRequest, x__xgafv=None) +
Returns all of the details about the specified resize request.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, The name of the region scoping this request. Name should conform to RFC1035. (required)
+  instanceGroupManager: string, The name of the managed instance group. Name should conform to RFC1035 or be a resource ID. (required)
+  resizeRequest: string, The name of the resize request. Name should conform to RFC1035 or be a resource ID. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # InstanceGroupManagerResizeRequest represents a request to create a number of VMs: either immediately or by queuing the request for the specified time. This resize request is nested under InstanceGroupManager and the VMs created by this request are added to the owning InstanceGroupManager.
+  "count": 42, # This field is deprecated, please use resize_by instead. The count of instances to create as part of this resize request.
+  "creationTimestamp": "A String", # [Output Only] The creation timestamp for this resize request in RFC3339 text format.
+  "description": "A String", # An optional description of this resource.
+  "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
+  "kind": "compute#instanceGroupManagerResizeRequest", # [Output Only] The resource type, which is always compute#instanceGroupManagerResizeRequest for resize requests.
+  "name": "A String", # The name of this resize request. The name must be 1-63 characters long, and comply with RFC1035.
+  "queuingPolicy": { # Queuing parameters for the requested deferred capacity. # This field is deprecated, ResizeRequests would not be provisioned immediately and would stay in the queue until explicitly cancelled. When set, defines queing parameters for the requested deferred capacity. When unset, the request starts provisioning immediately, or fails if immediate provisioning is not possible.
+    "validUntilDuration": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Relative deadline for waiting for capacity.
+      "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.
+      "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+    },
+    "validUntilTime": "A String", # Absolute deadline for waiting for capacity in RFC3339 text format.
+  },
+  "requestedRunDuration": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Requested run duration for instances that will be created by this request. At the end of the run duration instance will be deleted.
+    "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.
+    "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+  },
+  "resizeBy": 42, # The number of instances to be created by this resize request. The group's target size will be increased by this number.
+  "selfLink": "A String", # [Output Only] The URL for this resize request. The server defines this URL.
+  "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
+  "state": "A String", # [Output only] Current state of the request.
+  "status": { # [Output only] Status of the request.
+    "error": { # [Output only] Fatal errors encountered during the queueing or provisioning phases of the ResizeRequest that caused the transition to the FAILED state. Contrary to the last_attempt errors, this field is final and errors are never removed from here, as the ResizeRequest is not going to retry.
+      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+        {
+          "code": "A String", # [Output Only] The error type identifier for this error.
+          "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.
+            {
+              "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }
+                "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
+                "metadatas": { # Additional structured details about this error. Keys must match /a-z+/ but should ideally be lowerCamelCase. Also they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
+                  "a_key": "A String",
+                },
+                "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
+              },
+              "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
+                "links": [ # URL(s) pointing to additional information on handling the current error.
+                  { # Describes a URL link.
+                    "description": "A String", # Describes what the link offers.
+                    "url": "A String", # The URL of the link.
+                  },
+                ],
+              },
+              "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
+                "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
+                "message": "A String", # The localized error message in the above locale.
+              },
+              "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+                "dimensions": { # The map holding related quota dimensions.
+                  "a_key": "A String",
+                },
+                "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota type or metric.
+                "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type or metric.
+                "limitName": "A String", # The name of the quota limit.
+                "metricName": "A String", # The Compute Engine quota metric name.
+                "rolloutStatus": "A String", # Rollout status of the future quota limit.
+              },
+            },
+          ],
+          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+          "message": "A String", # [Output Only] An optional, human-readable error message.
+        },
+      ],
+    },
+    "lastAttempt": { # [Output only] Information about the last attempt to fulfill the request. The value is temporary since the ResizeRequest can retry, as long as it's still active and the last attempt value can either be cleared or replaced with a different error. Since ResizeRequest retries infrequently, the value may be stale and no longer show an active problem. The value is cleared when ResizeRequest transitions to the final state (becomes inactive). If the final state is FAILED the error describing it will be storred in the "error" field only.
+      "error": { # Errors that prevented the ResizeRequest to be fulfilled.
+        "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+          {
+            "code": "A String", # [Output Only] The error type identifier for this error.
+            "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.
+              {
+                "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }
+                  "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
+                  "metadatas": { # Additional structured details about this error. Keys must match /a-z+/ but should ideally be lowerCamelCase. Also they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
+                    "a_key": "A String",
+                  },
+                  "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
+                },
+                "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
+                  "links": [ # URL(s) pointing to additional information on handling the current error.
+                    { # Describes a URL link.
+                      "description": "A String", # Describes what the link offers.
+                      "url": "A String", # The URL of the link.
+                    },
+                  ],
+                },
+                "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
+                  "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
+                  "message": "A String", # The localized error message in the above locale.
+                },
+                "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+                  "dimensions": { # The map holding related quota dimensions.
+                    "a_key": "A String",
+                  },
+                  "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota type or metric.
+                  "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type or metric.
+                  "limitName": "A String", # The name of the quota limit.
+                  "metricName": "A String", # The Compute Engine quota metric name.
+                  "rolloutStatus": "A String", # Rollout status of the future quota limit.
+                },
+              },
+            ],
+            "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+            "message": "A String", # [Output Only] An optional, human-readable error message.
+          },
+        ],
+      },
+    },
+    "queuingPolicy": { # Queuing parameters for the requested deferred capacity. # This field is deprecated, setting queueing policy is no longer supported. Constraints for the time when the instances start provisioning. Always exposed as absolute time.
+      "validUntilDuration": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Relative deadline for waiting for capacity.
+        "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.
+        "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+      },
+      "validUntilTime": "A String", # Absolute deadline for waiting for capacity in RFC3339 text format.
+    },
+  },
+  "zone": "A String", # [Output Only] The URL of a zone where the resize request is located. Populated only for zonal resize requests.
+}
+
+ +
+ insert(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None) +
Creates a new Resize Request that starts provisioning VMs immediately or queues VM creation.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, Name of the region scoping this request. Name should conform to RFC1035. (required)
+  instanceGroupManager: string, Name of the managed instance group to which the resize request is scoped. Name should conform to RFC1035 or be a resource ID. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # InstanceGroupManagerResizeRequest represents a request to create a number of VMs: either immediately or by queuing the request for the specified time. This resize request is nested under InstanceGroupManager and the VMs created by this request are added to the owning InstanceGroupManager.
+  "count": 42, # This field is deprecated, please use resize_by instead. The count of instances to create as part of this resize request.
+  "creationTimestamp": "A String", # [Output Only] The creation timestamp for this resize request in RFC3339 text format.
+  "description": "A String", # An optional description of this resource.
+  "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
+  "kind": "compute#instanceGroupManagerResizeRequest", # [Output Only] The resource type, which is always compute#instanceGroupManagerResizeRequest for resize requests.
+  "name": "A String", # The name of this resize request. The name must be 1-63 characters long, and comply with RFC1035.
+  "queuingPolicy": { # Queuing parameters for the requested deferred capacity. # This field is deprecated, ResizeRequests would not be provisioned immediately and would stay in the queue until explicitly cancelled. When set, defines queing parameters for the requested deferred capacity. When unset, the request starts provisioning immediately, or fails if immediate provisioning is not possible.
+    "validUntilDuration": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Relative deadline for waiting for capacity.
+      "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.
+      "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+    },
+    "validUntilTime": "A String", # Absolute deadline for waiting for capacity in RFC3339 text format.
+  },
+  "requestedRunDuration": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Requested run duration for instances that will be created by this request. At the end of the run duration instance will be deleted.
+    "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.
+    "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+  },
+  "resizeBy": 42, # The number of instances to be created by this resize request. The group's target size will be increased by this number.
+  "selfLink": "A String", # [Output Only] The URL for this resize request. The server defines this URL.
+  "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
+  "state": "A String", # [Output only] Current state of the request.
+  "status": { # [Output only] Status of the request.
+    "error": { # [Output only] Fatal errors encountered during the queueing or provisioning phases of the ResizeRequest that caused the transition to the FAILED state. Contrary to the last_attempt errors, this field is final and errors are never removed from here, as the ResizeRequest is not going to retry.
+      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+        {
+          "code": "A String", # [Output Only] The error type identifier for this error.
+          "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.
+            {
+              "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }
+                "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
+                "metadatas": { # Additional structured details about this error. Keys must match /a-z+/ but should ideally be lowerCamelCase. Also they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
+                  "a_key": "A String",
+                },
+                "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
+              },
+              "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
+                "links": [ # URL(s) pointing to additional information on handling the current error.
+                  { # Describes a URL link.
+                    "description": "A String", # Describes what the link offers.
+                    "url": "A String", # The URL of the link.
+                  },
+                ],
+              },
+              "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
+                "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
+                "message": "A String", # The localized error message in the above locale.
+              },
+              "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+                "dimensions": { # The map holding related quota dimensions.
+                  "a_key": "A String",
+                },
+                "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota type or metric.
+                "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type or metric.
+                "limitName": "A String", # The name of the quota limit.
+                "metricName": "A String", # The Compute Engine quota metric name.
+                "rolloutStatus": "A String", # Rollout status of the future quota limit.
+              },
+            },
+          ],
+          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+          "message": "A String", # [Output Only] An optional, human-readable error message.
+        },
+      ],
+    },
+    "lastAttempt": { # [Output only] Information about the last attempt to fulfill the request. The value is temporary since the ResizeRequest can retry, as long as it's still active and the last attempt value can either be cleared or replaced with a different error. Since ResizeRequest retries infrequently, the value may be stale and no longer show an active problem. The value is cleared when ResizeRequest transitions to the final state (becomes inactive). If the final state is FAILED the error describing it will be storred in the "error" field only.
+      "error": { # Errors that prevented the ResizeRequest to be fulfilled.
+        "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+          {
+            "code": "A String", # [Output Only] The error type identifier for this error.
+            "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.
+              {
+                "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }
+                  "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
+                  "metadatas": { # Additional structured details about this error. Keys must match /a-z+/ but should ideally be lowerCamelCase. Also they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
+                    "a_key": "A String",
+                  },
+                  "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
+                },
+                "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
+                  "links": [ # URL(s) pointing to additional information on handling the current error.
+                    { # Describes a URL link.
+                      "description": "A String", # Describes what the link offers.
+                      "url": "A String", # The URL of the link.
+                    },
+                  ],
+                },
+                "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
+                  "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
+                  "message": "A String", # The localized error message in the above locale.
+                },
+                "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+                  "dimensions": { # The map holding related quota dimensions.
+                    "a_key": "A String",
+                  },
+                  "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota type or metric.
+                  "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type or metric.
+                  "limitName": "A String", # The name of the quota limit.
+                  "metricName": "A String", # The Compute Engine quota metric name.
+                  "rolloutStatus": "A String", # Rollout status of the future quota limit.
+                },
+              },
+            ],
+            "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+            "message": "A String", # [Output Only] An optional, human-readable error message.
+          },
+        ],
+      },
+    },
+    "queuingPolicy": { # Queuing parameters for the requested deferred capacity. # This field is deprecated, setting queueing policy is no longer supported. Constraints for the time when the instances start provisioning. Always exposed as absolute time.
+      "validUntilDuration": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Relative deadline for waiting for capacity.
+        "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.
+        "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+      },
+      "validUntilTime": "A String", # Absolute deadline for waiting for capacity in RFC3339 text format.
+    },
+  },
+  "zone": "A String", # [Output Only] The URL of a zone where the resize request is located. Populated only for zonal resize requests.
+}
+
+  requestId: string, An optional 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. 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).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zoneOperations` resource. For more information, read Global, Regional, and Zonal Resources. Note that completed Operation resources have a limited retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error. Keys must match /a-z+/ but should ideally be lowerCamelCase. Also they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key). Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
+  "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key). Example key: zones/us-central1-a
+      "a_key": {
+        "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). # [Output Only] If state is `ABANDONED` or `FAILED`, this field is populated.
+          "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.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following: `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/compute_alpha.regionInstanceGroupManagers.html b/docs/dyn/compute_alpha.regionInstanceGroupManagers.html index c73db1a04e9..43d462f6f32 100644 --- a/docs/dyn/compute_alpha.regionInstanceGroupManagers.html +++ b/docs/dyn/compute_alpha.regionInstanceGroupManagers.html @@ -1133,6 +1133,9 @@

Method Details

}, }, "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources). + "resourcePolicies": { # Resource policies for this managed instance group. + "workloadPolicy": "A String", # The URL of the workload policy that is specified for this managed instance group. It can be a full or partial URL. For example, the following are all valid URLs to a workload policy: - https://www.googleapis.com/compute/v1/projects/project/regions/region /resourcePolicies/resourcePolicy - projects/project/regions/region/resourcePolicies/resourcePolicy - regions/region/resourcePolicies/resourcePolicy + }, "satisfiesPzi": True or False, # [Output Only] Reserved for future use. "satisfiesPzs": True or False, # [Output Only] Reserved for future use. "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL. @@ -1333,6 +1336,9 @@

Method Details

}, }, "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources). + "resourcePolicies": { # Resource policies for this managed instance group. + "workloadPolicy": "A String", # The URL of the workload policy that is specified for this managed instance group. It can be a full or partial URL. For example, the following are all valid URLs to a workload policy: - https://www.googleapis.com/compute/v1/projects/project/regions/region /resourcePolicies/resourcePolicy - projects/project/regions/region/resourcePolicies/resourcePolicy - regions/region/resourcePolicies/resourcePolicy + }, "satisfiesPzi": True or False, # [Output Only] Reserved for future use. "satisfiesPzs": True or False, # [Output Only] Reserved for future use. "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL. @@ -1663,6 +1669,9 @@

Method Details

}, }, "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources). + "resourcePolicies": { # Resource policies for this managed instance group. + "workloadPolicy": "A String", # The URL of the workload policy that is specified for this managed instance group. It can be a full or partial URL. For example, the following are all valid URLs to a workload policy: - https://www.googleapis.com/compute/v1/projects/project/regions/region /resourcePolicies/resourcePolicy - projects/project/regions/region/resourcePolicies/resourcePolicy - regions/region/resourcePolicies/resourcePolicy + }, "satisfiesPzi": True or False, # [Output Only] Reserved for future use. "satisfiesPzs": True or False, # [Output Only] Reserved for future use. "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL. @@ -2216,6 +2225,9 @@

Method Details

}, }, "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources). + "resourcePolicies": { # Resource policies for this managed instance group. + "workloadPolicy": "A String", # The URL of the workload policy that is specified for this managed instance group. It can be a full or partial URL. For example, the following are all valid URLs to a workload policy: - https://www.googleapis.com/compute/v1/projects/project/regions/region /resourcePolicies/resourcePolicy - projects/project/regions/region/resourcePolicies/resourcePolicy - regions/region/resourcePolicies/resourcePolicy + }, "satisfiesPzi": True or False, # [Output Only] Reserved for future use. "satisfiesPzs": True or False, # [Output Only] Reserved for future use. "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL. @@ -4088,6 +4100,9 @@

Method Details

}, }, "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources). + "resourcePolicies": { # Resource policies for this managed instance group. + "workloadPolicy": "A String", # The URL of the workload policy that is specified for this managed instance group. It can be a full or partial URL. For example, the following are all valid URLs to a workload policy: - https://www.googleapis.com/compute/v1/projects/project/regions/region /resourcePolicies/resourcePolicy - projects/project/regions/region/resourcePolicies/resourcePolicy - regions/region/resourcePolicies/resourcePolicy + }, "satisfiesPzi": True or False, # [Output Only] Reserved for future use. "satisfiesPzs": True or False, # [Output Only] Reserved for future use. "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL. diff --git a/docs/dyn/compute_alpha.regionInstantSnapshotGroups.html b/docs/dyn/compute_alpha.regionInstantSnapshotGroups.html new file mode 100644 index 00000000000..3de09899788 --- /dev/null +++ b/docs/dyn/compute_alpha.regionInstantSnapshotGroups.html @@ -0,0 +1,490 @@ + + + +

Compute Engine API . regionInstantSnapshotGroups

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ delete(project, region, instantSnapshotGroup, requestId=None, x__xgafv=None)

+

deletes a Regional InstantSnapshotGroup resource

+

+ get(project, region, instantSnapshot, x__xgafv=None)

+

returns the specified InstantSnapshotGroup resource in the specified region.

+

+ insert(project, region, body=None, requestId=None, sourceConsistencyGroup=None, x__xgafv=None)

+

creates a Regional InstantSnapshotGroup resource

+

+ list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

retrieves the list of InstantSnapshotGroup resources contained within the specified region.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ delete(project, region, instantSnapshotGroup, requestId=None, x__xgafv=None) +
deletes a Regional InstantSnapshotGroup resource
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, The name of the region for this request. (required)
+  instantSnapshotGroup: string, Name of the InstantSnapshotGroup resource to delete. (required)
+  requestId: string, An optional 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. 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).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zoneOperations` resource. For more information, read Global, Regional, and Zonal Resources. Note that completed Operation resources have a limited retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error. Keys must match /a-z+/ but should ideally be lowerCamelCase. Also they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key). Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
+  "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key). Example key: zones/us-central1-a
+      "a_key": {
+        "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). # [Output Only] If state is `ABANDONED` or `FAILED`, this field is populated.
+          "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.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following: `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
+}
+
+ +
+ get(project, region, instantSnapshot, x__xgafv=None) +
returns the specified InstantSnapshotGroup resource in the specified region.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, The name of the region for this request. (required)
+  instantSnapshot: string, Name of the InstantSnapshotGroup resource to return. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+  "description": "A String", # Optional. An optional description of this resource. Provide this property when you create the resource.
+  "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+  "kind": "compute#instantSnapshotGroup", # [Output Only] Type of the resource. Always compute#instantSnapshotGroup for InstantSnapshotGroup resources.
+  "name": "A String", # Identifier. Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+  "region": "A String", # [Output Only] URL of the region where the instant snapshot group resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
+  "resourceStatus": {
+    "consistencyMembershipResolutionTime": "A String", # [Output Only]
+    "sourceInfo": { # [Output Only]
+      "consistencyGroup": "A String",
+      "consistencyGroupId": "A String",
+    },
+  },
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource's resource id.
+  "status": "A String", # [Output Only]
+  "zone": "A String", # [Output Only] URL of the zone where the instant snapshot group resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
+}
+
+ +
+ insert(project, region, body=None, requestId=None, sourceConsistencyGroup=None, x__xgafv=None) +
creates a Regional InstantSnapshotGroup resource
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, Name of the region for this request. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{
+  "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+  "description": "A String", # Optional. An optional description of this resource. Provide this property when you create the resource.
+  "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+  "kind": "compute#instantSnapshotGroup", # [Output Only] Type of the resource. Always compute#instantSnapshotGroup for InstantSnapshotGroup resources.
+  "name": "A String", # Identifier. Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+  "region": "A String", # [Output Only] URL of the region where the instant snapshot group resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
+  "resourceStatus": {
+    "consistencyMembershipResolutionTime": "A String", # [Output Only]
+    "sourceInfo": { # [Output Only]
+      "consistencyGroup": "A String",
+      "consistencyGroupId": "A String",
+    },
+  },
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource's resource id.
+  "status": "A String", # [Output Only]
+  "zone": "A String", # [Output Only] URL of the zone where the instant snapshot group resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
+}
+
+  requestId: string, An optional 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. 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).
+  sourceConsistencyGroup: string, begin_interface: MixerMutationRequestBuilder
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zoneOperations` resource. For more information, read Global, Regional, and Zonal Resources. Note that completed Operation resources have a limited retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error. Keys must match /a-z+/ but should ideally be lowerCamelCase. Also they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key). Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
+  "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key). Example key: zones/us-central1-a
+      "a_key": {
+        "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). # [Output Only] If state is `ABANDONED` or `FAILED`, this field is populated.
+          "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.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following: `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
+}
+
+ +
+ list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) +
retrieves the list of InstantSnapshotGroup resources contained within the specified region.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, The name of the region for this request. (required)
+  filter: string, A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.
+  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
+  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.
+  pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
+  returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Contains a list of InstantSnapshotGroup resources.
+  "etag": "A String",
+  "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+  "items": [ # A list of InstantSnapshotGroup resources.
+    {
+      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+      "description": "A String", # Optional. An optional description of this resource. Provide this property when you create the resource.
+      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+      "kind": "compute#instantSnapshotGroup", # [Output Only] Type of the resource. Always compute#instantSnapshotGroup for InstantSnapshotGroup resources.
+      "name": "A String", # Identifier. Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+      "region": "A String", # [Output Only] URL of the region where the instant snapshot group resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
+      "resourceStatus": {
+        "consistencyMembershipResolutionTime": "A String", # [Output Only]
+        "sourceInfo": { # [Output Only]
+          "consistencyGroup": "A String",
+          "consistencyGroupId": "A String",
+        },
+      },
+      "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+      "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource's resource id.
+      "status": "A String", # [Output Only]
+      "zone": "A String", # [Output Only] URL of the zone where the instant snapshot group resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
+    },
+  ],
+  "kind": "compute#instantSnapshotGroupsList", # Type of resource.
+  "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+  "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+  "unreachables": [ # [Output Only] Unreachable resources. end_interface: MixerListResponseWithEtagBuilder
+    "A String",
+  ],
+  "warning": { # [Output Only] Informational warning message.
+    "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+    "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+      {
+        "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+        "value": "A String", # [Output Only] A warning data value corresponding to the key.
+      },
+    ],
+    "message": "A String", # [Output Only] A human-readable description of the warning code.
+  },
+}
+
+ +
+ 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/compute_alpha.regionMultiMigs.html b/docs/dyn/compute_alpha.regionMultiMigs.html index a683dc258e9..537897dedec 100644 --- a/docs/dyn/compute_alpha.regionMultiMigs.html +++ b/docs/dyn/compute_alpha.regionMultiMigs.html @@ -357,6 +357,9 @@

Method Details

}, }, "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources). + "resourcePolicies": { # Resource policies for this managed instance group. + "workloadPolicy": "A String", # The URL of the workload policy that is specified for this managed instance group. It can be a full or partial URL. For example, the following are all valid URLs to a workload policy: - https://www.googleapis.com/compute/v1/projects/project/regions/region /resourcePolicies/resourcePolicy - projects/project/regions/region/resourcePolicies/resourcePolicy - regions/region/resourcePolicies/resourcePolicy + }, "satisfiesPzi": True or False, # [Output Only] Reserved for future use. "satisfiesPzs": True or False, # [Output Only] Reserved for future use. "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL. @@ -450,6 +453,11 @@

Method Details

}, "selfLink": "A String", # [Output only] Server-defined URL for the resource. "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. + "status": { + "memberInstanceGroupManagers": [ + "A String", + ], + }, }
@@ -580,6 +588,9 @@

Method Details

}, }, "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources). + "resourcePolicies": { # Resource policies for this managed instance group. + "workloadPolicy": "A String", # The URL of the workload policy that is specified for this managed instance group. It can be a full or partial URL. For example, the following are all valid URLs to a workload policy: - https://www.googleapis.com/compute/v1/projects/project/regions/region /resourcePolicies/resourcePolicy - projects/project/regions/region/resourcePolicies/resourcePolicy - regions/region/resourcePolicies/resourcePolicy + }, "satisfiesPzi": True or False, # [Output Only] Reserved for future use. "satisfiesPzs": True or False, # [Output Only] Reserved for future use. "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL. @@ -673,6 +684,11 @@

Method Details

}, "selfLink": "A String", # [Output only] Server-defined URL for the resource. "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. + "status": { + "memberInstanceGroupManagers": [ + "A String", + ], + }, } requestId: string, An optional 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. 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). @@ -934,6 +950,9 @@

Method Details

}, }, "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources). + "resourcePolicies": { # Resource policies for this managed instance group. + "workloadPolicy": "A String", # The URL of the workload policy that is specified for this managed instance group. It can be a full or partial URL. For example, the following are all valid URLs to a workload policy: - https://www.googleapis.com/compute/v1/projects/project/regions/region /resourcePolicies/resourcePolicy - projects/project/regions/region/resourcePolicies/resourcePolicy - regions/region/resourcePolicies/resourcePolicy + }, "satisfiesPzi": True or False, # [Output Only] Reserved for future use. "satisfiesPzs": True or False, # [Output Only] Reserved for future use. "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL. @@ -1027,6 +1046,11 @@

Method Details

}, "selfLink": "A String", # [Output only] Server-defined URL for the resource. "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. + "status": { + "memberInstanceGroupManagers": [ + "A String", + ], + }, }, ], "kind": "compute#multiMigList", # Type of resource. diff --git a/docs/dyn/config_v1.projects.locations.deployments.html b/docs/dyn/config_v1.projects.locations.deployments.html index 3c7aab9d3ab..14453a45672 100644 --- a/docs/dyn/config_v1.projects.locations.deployments.html +++ b/docs/dyn/config_v1.projects.locations.deployments.html @@ -174,8 +174,8 @@

Method Details

"state": "A String", # Output only. Current state of the deployment. "stateDetail": "A String", # Output only. Additional information regarding the current state. "terraformBlueprint": { # TerraformBlueprint describes the source of a Terraform root module which describes the resources and configs to be deployed. # A blueprint described using Terraform's HashiCorp Configuration Language as a root module. - "gcsSource": "A String", # Required. URI of an object in Google Cloud Storage. Format: `gs://{bucket}/{object}` URI may also specify an object version for zipped objects. Format: `gs://{bucket}/{object}#{version}` - "gitSource": { # A set of files in a Git repository. # Required. URI of a public Git repo. + "gcsSource": "A String", # URI of an object in Google Cloud Storage. Format: `gs://{bucket}/{object}` URI may also specify an object version for zipped objects. Format: `gs://{bucket}/{object}#{version}` + "gitSource": { # A set of files in a Git repository. # URI of a public Git repo. "directory": "A String", # Optional. Subdirectory inside the repository. Example: 'staging/my-package' "ref": "A String", # Optional. Git reference (e.g. branch or tag). "repo": "A String", # Optional. Repository URL. Example: 'https://github.com/kubernetes/examples.git' @@ -402,8 +402,8 @@

Method Details

"state": "A String", # Output only. Current state of the deployment. "stateDetail": "A String", # Output only. Additional information regarding the current state. "terraformBlueprint": { # TerraformBlueprint describes the source of a Terraform root module which describes the resources and configs to be deployed. # A blueprint described using Terraform's HashiCorp Configuration Language as a root module. - "gcsSource": "A String", # Required. URI of an object in Google Cloud Storage. Format: `gs://{bucket}/{object}` URI may also specify an object version for zipped objects. Format: `gs://{bucket}/{object}#{version}` - "gitSource": { # A set of files in a Git repository. # Required. URI of a public Git repo. + "gcsSource": "A String", # URI of an object in Google Cloud Storage. Format: `gs://{bucket}/{object}` URI may also specify an object version for zipped objects. Format: `gs://{bucket}/{object}#{version}` + "gitSource": { # A set of files in a Git repository. # URI of a public Git repo. "directory": "A String", # Optional. Subdirectory inside the repository. Example: 'staging/my-package' "ref": "A String", # Optional. Git reference (e.g. branch or tag). "repo": "A String", # Optional. Repository URL. Example: 'https://github.com/kubernetes/examples.git' @@ -563,8 +563,8 @@

Method Details

"state": "A String", # Output only. Current state of the deployment. "stateDetail": "A String", # Output only. Additional information regarding the current state. "terraformBlueprint": { # TerraformBlueprint describes the source of a Terraform root module which describes the resources and configs to be deployed. # A blueprint described using Terraform's HashiCorp Configuration Language as a root module. - "gcsSource": "A String", # Required. URI of an object in Google Cloud Storage. Format: `gs://{bucket}/{object}` URI may also specify an object version for zipped objects. Format: `gs://{bucket}/{object}#{version}` - "gitSource": { # A set of files in a Git repository. # Required. URI of a public Git repo. + "gcsSource": "A String", # URI of an object in Google Cloud Storage. Format: `gs://{bucket}/{object}` URI may also specify an object version for zipped objects. Format: `gs://{bucket}/{object}#{version}` + "gitSource": { # A set of files in a Git repository. # URI of a public Git repo. "directory": "A String", # Optional. Subdirectory inside the repository. Example: 'staging/my-package' "ref": "A String", # Optional. Git reference (e.g. branch or tag). "repo": "A String", # Optional. Repository URL. Example: 'https://github.com/kubernetes/examples.git' @@ -700,8 +700,8 @@

Method Details

"state": "A String", # Output only. Current state of the deployment. "stateDetail": "A String", # Output only. Additional information regarding the current state. "terraformBlueprint": { # TerraformBlueprint describes the source of a Terraform root module which describes the resources and configs to be deployed. # A blueprint described using Terraform's HashiCorp Configuration Language as a root module. - "gcsSource": "A String", # Required. URI of an object in Google Cloud Storage. Format: `gs://{bucket}/{object}` URI may also specify an object version for zipped objects. Format: `gs://{bucket}/{object}#{version}` - "gitSource": { # A set of files in a Git repository. # Required. URI of a public Git repo. + "gcsSource": "A String", # URI of an object in Google Cloud Storage. Format: `gs://{bucket}/{object}` URI may also specify an object version for zipped objects. Format: `gs://{bucket}/{object}#{version}` + "gitSource": { # A set of files in a Git repository. # URI of a public Git repo. "directory": "A String", # Optional. Subdirectory inside the repository. Example: 'staging/my-package' "ref": "A String", # Optional. Git reference (e.g. branch or tag). "repo": "A String", # Optional. Repository URL. Example: 'https://github.com/kubernetes/examples.git' diff --git a/docs/dyn/config_v1.projects.locations.deployments.revisions.html b/docs/dyn/config_v1.projects.locations.deployments.revisions.html index c3cb6a5a466..5e4a1798a03 100644 --- a/docs/dyn/config_v1.projects.locations.deployments.revisions.html +++ b/docs/dyn/config_v1.projects.locations.deployments.revisions.html @@ -164,8 +164,8 @@

Method Details

"state": "A String", # Output only. Current state of the revision. "stateDetail": "A String", # Output only. Additional info regarding the current state. "terraformBlueprint": { # TerraformBlueprint describes the source of a Terraform root module which describes the resources and configs to be deployed. # Output only. A blueprint described using Terraform's HashiCorp Configuration Language as a root module. - "gcsSource": "A String", # Required. URI of an object in Google Cloud Storage. Format: `gs://{bucket}/{object}` URI may also specify an object version for zipped objects. Format: `gs://{bucket}/{object}#{version}` - "gitSource": { # A set of files in a Git repository. # Required. URI of a public Git repo. + "gcsSource": "A String", # URI of an object in Google Cloud Storage. Format: `gs://{bucket}/{object}` URI may also specify an object version for zipped objects. Format: `gs://{bucket}/{object}#{version}` + "gitSource": { # A set of files in a Git repository. # URI of a public Git repo. "directory": "A String", # Optional. Subdirectory inside the repository. Example: 'staging/my-package' "ref": "A String", # Optional. Git reference (e.g. branch or tag). "repo": "A String", # Optional. Repository URL. Example: 'https://github.com/kubernetes/examples.git' @@ -245,8 +245,8 @@

Method Details

"state": "A String", # Output only. Current state of the revision. "stateDetail": "A String", # Output only. Additional info regarding the current state. "terraformBlueprint": { # TerraformBlueprint describes the source of a Terraform root module which describes the resources and configs to be deployed. # Output only. A blueprint described using Terraform's HashiCorp Configuration Language as a root module. - "gcsSource": "A String", # Required. URI of an object in Google Cloud Storage. Format: `gs://{bucket}/{object}` URI may also specify an object version for zipped objects. Format: `gs://{bucket}/{object}#{version}` - "gitSource": { # A set of files in a Git repository. # Required. URI of a public Git repo. + "gcsSource": "A String", # URI of an object in Google Cloud Storage. Format: `gs://{bucket}/{object}` URI may also specify an object version for zipped objects. Format: `gs://{bucket}/{object}#{version}` + "gitSource": { # A set of files in a Git repository. # URI of a public Git repo. "directory": "A String", # Optional. Subdirectory inside the repository. Example: 'staging/my-package' "ref": "A String", # Optional. Git reference (e.g. branch or tag). "repo": "A String", # Optional. Repository URL. Example: 'https://github.com/kubernetes/examples.git' diff --git a/docs/dyn/config_v1.projects.locations.previews.html b/docs/dyn/config_v1.projects.locations.previews.html index 176959165a6..44d4ac2ed8a 100644 --- a/docs/dyn/config_v1.projects.locations.previews.html +++ b/docs/dyn/config_v1.projects.locations.previews.html @@ -142,8 +142,8 @@

Method Details

"serviceAccount": "A String", # Optional. User-specified Service Account (SA) credentials to be used when previewing resources. Format: `projects/{projectID}/serviceAccounts/{serviceAccount}` "state": "A String", # Output only. Current state of the preview. "terraformBlueprint": { # TerraformBlueprint describes the source of a Terraform root module which describes the resources and configs to be deployed. # The terraform blueprint to preview. - "gcsSource": "A String", # Required. URI of an object in Google Cloud Storage. Format: `gs://{bucket}/{object}` URI may also specify an object version for zipped objects. Format: `gs://{bucket}/{object}#{version}` - "gitSource": { # A set of files in a Git repository. # Required. URI of a public Git repo. + "gcsSource": "A String", # URI of an object in Google Cloud Storage. Format: `gs://{bucket}/{object}` URI may also specify an object version for zipped objects. Format: `gs://{bucket}/{object}#{version}` + "gitSource": { # A set of files in a Git repository. # URI of a public Git repo. "directory": "A String", # Optional. Subdirectory inside the repository. Example: 'staging/my-package' "ref": "A String", # Optional. Git reference (e.g. branch or tag). "repo": "A String", # Optional. Repository URL. Example: 'https://github.com/kubernetes/examples.git' @@ -316,8 +316,8 @@

Method Details

"serviceAccount": "A String", # Optional. User-specified Service Account (SA) credentials to be used when previewing resources. Format: `projects/{projectID}/serviceAccounts/{serviceAccount}` "state": "A String", # Output only. Current state of the preview. "terraformBlueprint": { # TerraformBlueprint describes the source of a Terraform root module which describes the resources and configs to be deployed. # The terraform blueprint to preview. - "gcsSource": "A String", # Required. URI of an object in Google Cloud Storage. Format: `gs://{bucket}/{object}` URI may also specify an object version for zipped objects. Format: `gs://{bucket}/{object}#{version}` - "gitSource": { # A set of files in a Git repository. # Required. URI of a public Git repo. + "gcsSource": "A String", # URI of an object in Google Cloud Storage. Format: `gs://{bucket}/{object}` URI may also specify an object version for zipped objects. Format: `gs://{bucket}/{object}#{version}` + "gitSource": { # A set of files in a Git repository. # URI of a public Git repo. "directory": "A String", # Optional. Subdirectory inside the repository. Example: 'staging/my-package' "ref": "A String", # Optional. Git reference (e.g. branch or tag). "repo": "A String", # Optional. Repository URL. Example: 'https://github.com/kubernetes/examples.git' @@ -403,8 +403,8 @@

Method Details

"serviceAccount": "A String", # Optional. User-specified Service Account (SA) credentials to be used when previewing resources. Format: `projects/{projectID}/serviceAccounts/{serviceAccount}` "state": "A String", # Output only. Current state of the preview. "terraformBlueprint": { # TerraformBlueprint describes the source of a Terraform root module which describes the resources and configs to be deployed. # The terraform blueprint to preview. - "gcsSource": "A String", # Required. URI of an object in Google Cloud Storage. Format: `gs://{bucket}/{object}` URI may also specify an object version for zipped objects. Format: `gs://{bucket}/{object}#{version}` - "gitSource": { # A set of files in a Git repository. # Required. URI of a public Git repo. + "gcsSource": "A String", # URI of an object in Google Cloud Storage. Format: `gs://{bucket}/{object}` URI may also specify an object version for zipped objects. Format: `gs://{bucket}/{object}#{version}` + "gitSource": { # A set of files in a Git repository. # URI of a public Git repo. "directory": "A String", # Optional. Subdirectory inside the repository. Example: 'staging/my-package' "ref": "A String", # Optional. Git reference (e.g. branch or tag). "repo": "A String", # Optional. Repository URL. Example: 'https://github.com/kubernetes/examples.git' diff --git a/docs/dyn/connectors_v1.projects.locations.connections.html b/docs/dyn/connectors_v1.projects.locations.connections.html index 0739667e877..495752c1f73 100644 --- a/docs/dyn/connectors_v1.projects.locations.connections.html +++ b/docs/dyn/connectors_v1.projects.locations.connections.html @@ -155,6 +155,7 @@

Method Details

The object takes the form of: { # Connection represents an instance of connector. + "asyncOperationsEnabled": True or False, # Optional. Async operations enabled for the connection. If Async Operations is enabled, Connection allows the customers to initiate async long running operations using the actions API. "authConfig": { # AuthConfig defines details of a authentication type. # Optional. Configuration for establishing the connection's authentication with an external system. "additionalVariables": [ # List containing additional auth configs. { # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig. @@ -243,6 +244,7 @@

Method Details

"connectorVersionInfraConfig": { # This cofiguration provides infra configs like rate limit threshold which need to be configurable for every connector version # Output only. Infra configs supported by Connector Version. "connectionRatelimitWindowSeconds": "A String", # Output only. The window used for ratelimiting runtime requests to connections. "deploymentModel": "A String", # Optional. Indicates whether connector is deployed on GKE/CloudRun + "deploymentModelMigrationState": "A String", # Output only. Status of the deployment model migration. "hpaConfig": { # Autoscaling config for connector deployment system metrics. # Output only. HPA autoscaling config. "cpuUtilizationThreshold": "A String", # Output only. Percent CPU utilization where HPA triggers autoscaling. "memoryUtilizationThreshold": "A String", # Output only. Percent Memory utilization where HPA triggers autoscaling. @@ -629,6 +631,7 @@

Method Details

An object of the form: { # Connection represents an instance of connector. + "asyncOperationsEnabled": True or False, # Optional. Async operations enabled for the connection. If Async Operations is enabled, Connection allows the customers to initiate async long running operations using the actions API. "authConfig": { # AuthConfig defines details of a authentication type. # Optional. Configuration for establishing the connection's authentication with an external system. "additionalVariables": [ # List containing additional auth configs. { # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig. @@ -717,6 +720,7 @@

Method Details

"connectorVersionInfraConfig": { # This cofiguration provides infra configs like rate limit threshold which need to be configurable for every connector version # Output only. Infra configs supported by Connector Version. "connectionRatelimitWindowSeconds": "A String", # Output only. The window used for ratelimiting runtime requests to connections. "deploymentModel": "A String", # Optional. Indicates whether connector is deployed on GKE/CloudRun + "deploymentModelMigrationState": "A String", # Output only. Status of the deployment model migration. "hpaConfig": { # Autoscaling config for connector deployment system metrics. # Output only. HPA autoscaling config. "cpuUtilizationThreshold": "A String", # Output only. Percent CPU utilization where HPA triggers autoscaling. "memoryUtilizationThreshold": "A String", # Output only. Percent Memory utilization where HPA triggers autoscaling. @@ -1122,6 +1126,7 @@

Method Details

{ # Response message for ConnectorsService.ListConnections "connections": [ # Connections. { # Connection represents an instance of connector. + "asyncOperationsEnabled": True or False, # Optional. Async operations enabled for the connection. If Async Operations is enabled, Connection allows the customers to initiate async long running operations using the actions API. "authConfig": { # AuthConfig defines details of a authentication type. # Optional. Configuration for establishing the connection's authentication with an external system. "additionalVariables": [ # List containing additional auth configs. { # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig. @@ -1210,6 +1215,7 @@

Method Details

"connectorVersionInfraConfig": { # This cofiguration provides infra configs like rate limit threshold which need to be configurable for every connector version # Output only. Infra configs supported by Connector Version. "connectionRatelimitWindowSeconds": "A String", # Output only. The window used for ratelimiting runtime requests to connections. "deploymentModel": "A String", # Optional. Indicates whether connector is deployed on GKE/CloudRun + "deploymentModelMigrationState": "A String", # Output only. Status of the deployment model migration. "hpaConfig": { # Autoscaling config for connector deployment system metrics. # Output only. HPA autoscaling config. "cpuUtilizationThreshold": "A String", # Output only. Percent CPU utilization where HPA triggers autoscaling. "memoryUtilizationThreshold": "A String", # Output only. Percent Memory utilization where HPA triggers autoscaling. @@ -1569,6 +1575,7 @@

Method Details

The object takes the form of: { # Connection represents an instance of connector. + "asyncOperationsEnabled": True or False, # Optional. Async operations enabled for the connection. If Async Operations is enabled, Connection allows the customers to initiate async long running operations using the actions API. "authConfig": { # AuthConfig defines details of a authentication type. # Optional. Configuration for establishing the connection's authentication with an external system. "additionalVariables": [ # List containing additional auth configs. { # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig. @@ -1657,6 +1664,7 @@

Method Details

"connectorVersionInfraConfig": { # This cofiguration provides infra configs like rate limit threshold which need to be configurable for every connector version # Output only. Infra configs supported by Connector Version. "connectionRatelimitWindowSeconds": "A String", # Output only. The window used for ratelimiting runtime requests to connections. "deploymentModel": "A String", # Optional. Indicates whether connector is deployed on GKE/CloudRun + "deploymentModelMigrationState": "A String", # Output only. Status of the deployment model migration. "hpaConfig": { # Autoscaling config for connector deployment system metrics. # Output only. HPA autoscaling config. "cpuUtilizationThreshold": "A String", # Output only. Percent CPU utilization where HPA triggers autoscaling. "memoryUtilizationThreshold": "A String", # Output only. Percent Memory utilization where HPA triggers autoscaling. @@ -2149,6 +2157,7 @@

Method Details

], }, "connection": { # Connection represents an instance of connector. # Output only. Connection details + "asyncOperationsEnabled": True or False, # Optional. Async operations enabled for the connection. If Async Operations is enabled, Connection allows the customers to initiate async long running operations using the actions API. "authConfig": { # AuthConfig defines details of a authentication type. # Optional. Configuration for establishing the connection's authentication with an external system. "additionalVariables": [ # List containing additional auth configs. { # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig. @@ -2237,6 +2246,7 @@

Method Details

"connectorVersionInfraConfig": { # This cofiguration provides infra configs like rate limit threshold which need to be configurable for every connector version # Output only. Infra configs supported by Connector Version. "connectionRatelimitWindowSeconds": "A String", # Output only. The window used for ratelimiting runtime requests to connections. "deploymentModel": "A String", # Optional. Indicates whether connector is deployed on GKE/CloudRun + "deploymentModelMigrationState": "A String", # Output only. Status of the deployment model migration. "hpaConfig": { # Autoscaling config for connector deployment system metrics. # Output only. HPA autoscaling config. "cpuUtilizationThreshold": "A String", # Output only. Percent CPU utilization where HPA triggers autoscaling. "memoryUtilizationThreshold": "A String", # Output only. Percent Memory utilization where HPA triggers autoscaling. 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 c098918d86e..677f038795c 100644 --- a/docs/dyn/connectors_v1.projects.locations.providers.connectors.versions.html +++ b/docs/dyn/connectors_v1.projects.locations.providers.connectors.versions.html @@ -268,6 +268,7 @@

Method Details

"memoryUtilizationThreshold": "A String", # Output only. Percent Memory utilization where HPA triggers autoscaling. }, "internalclientRatelimitThreshold": "A String", # Max QPS supported for internal requests originating from Connd. + "migrateDeploymentModel": True or False, # Indicate whether connector is being migrated to cloud run deployment model. "ratelimitThreshold": "A String", # Max QPS supported by the connector version before throttling of requests. "resourceLimits": { # Resource limits defined for connection pods of a given connector type. # System resource limits. "cpu": "A String", # Output only. CPU limit. @@ -993,6 +994,7 @@

Method Details

"memoryUtilizationThreshold": "A String", # Output only. Percent Memory utilization where HPA triggers autoscaling. }, "internalclientRatelimitThreshold": "A String", # Max QPS supported for internal requests originating from Connd. + "migrateDeploymentModel": True or False, # Indicate whether connector is being migrated to cloud run deployment model. "ratelimitThreshold": "A String", # Max QPS supported by the connector version before throttling of requests. "resourceLimits": { # Resource limits defined for connection pods of a given connector type. # System resource limits. "cpu": "A String", # Output only. CPU limit. diff --git a/docs/dyn/container_v1.projects.locations.clusters.html b/docs/dyn/container_v1.projects.locations.clusters.html index b3502ea1674..fddc1650534 100644 --- a/docs/dyn/container_v1.projects.locations.clusters.html +++ b/docs/dyn/container_v1.projects.locations.clusters.html @@ -213,8 +213,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -224,8 +224,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -233,8 +233,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -249,12 +249,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }
@@ -341,8 +341,8 @@

Method Details

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered. "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. @@ -396,10 +396,10 @@

Method Details

"costManagementConfig": { # Configuration for fine-grained cost management feature. # Configuration for the fine-grained cost management feature. "enabled": True or False, # Whether the feature is enabled or not. }, - "createTime": "A String", # [Output only] The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "currentMasterVersion": "A String", # [Output only] The current software version of the master endpoint. - "currentNodeCount": 42, # [Output only] The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. - "currentNodeVersion": "A String", # [Output only] Deprecated, use [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. + "createTime": "A String", # Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "currentMasterVersion": "A String", # Output only. The current software version of the master endpoint. + "currentNodeCount": 42, # Output only. The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. + "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. "databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption. "currentState": "A String", # Output only. The current state of etcd encryption. "decryptionKeys": [ # Output only. Keys in use by the cluster for decrypting existing objects, in addition to the key in `key_name`. Each item is a CloudKMS key resource. @@ -426,15 +426,15 @@

Method Details

}, "enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1alpha1) and features that may not be production ready in the kubernetes version of the master and nodes. The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are automatically deleted thirty days after creation. "enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster. - "endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. + "endpoint": "A String", # Output only. The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. "enterpriseConfig": { # EnterpriseConfig is the cluster enterprise configuration. # GKE Enterprise Configuration. - "clusterTier": "A String", # Output only. [Output only] cluster_tier specifies the premium tier of the cluster. + "clusterTier": "A String", # Output only. cluster_tier specifies the premium tier of the cluster. }, "etag": "A String", # This checksum is computed by the server based on the value of cluster fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. - "expireTime": "A String", # [Output only] The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "expireTime": "A String", # Output only. The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "fleet": { # Fleet is the fleet configuration for the cluster. # Fleet information for the cluster. - "membership": "A String", # [Output only] The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`. - "preRegistered": True or False, # [Output only] Whether the cluster has been registered through the fleet API. + "membership": "A String", # Output only. The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`. + "preRegistered": True or False, # Output only. Whether the cluster has been registered through the fleet API. "project": "A String", # The Fleet host project(project ID or project number) where this cluster will be registered to. This field cannot be changed after the cluster has been registered. }, "id": "A String", # Output only. Unique id for the cluster. @@ -443,15 +443,15 @@

Method Details

}, "initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "","-": picks the default Kubernetes version "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead. - "instanceGroupUrls": [ # Deprecated. Use node_pools.instance_group_urls. + "instanceGroupUrls": [ # Output only. Deprecated. Use node_pools.instance_group_urls. "A String", ], "ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the cluster. # Configuration for cluster IP allocation. - "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # Output only. [Output only] The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy. - "podRangeInfo": [ # Output only. [Output only] Information for additional pod range. + "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # Output only. The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy. + "podRangeInfo": [ # Output only. Information for additional pod range. { # RangeInfo contains the range name and the range utilization by this cluster. - "rangeName": "A String", # Output only. [Output only] Name of a range. - "utilization": 3.14, # Output only. [Output only] The utilization of the range. + "rangeName": "A String", # Output only. Name of a range. + "utilization": 3.14, # Output only. The utilization of the range. }, ], "podRangeNames": [ # Name for pod secondary ipv4 range which has the actual range defined ahead. @@ -462,7 +462,7 @@

Method Details

"clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then `cluster.cluster_ipv4_cidr` must be left blank. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. "clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases is true and create_subnetwork is false. "createSubnetwork": True or False, # Whether a new subnetwork will be created automatically for the cluster. This field is only applicable when `use_ip_aliases` is true. - "defaultPodIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "defaultPodIpv4RangeUtilization": 3.14, # Output only. The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "ipv6AccessType": "A String", # The ipv6 access type (internal or external) when create_subnetwork is true "nodeIpv4Cidr": "A String", # This field is deprecated, use node_ipv4_cidr_block. "nodeIpv4CidrBlock": "A String", # The IP address range of the instance IPs in this cluster. This is applicable only if `create_subnetwork` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. @@ -471,10 +471,10 @@

Method Details

}, "servicesIpv4Cidr": "A String", # This field is deprecated, use services_ipv4_cidr_block. "servicesIpv4CidrBlock": "A String", # The IP address range of the services IPs in this cluster. If blank, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. - "servicesIpv6CidrBlock": "A String", # Output only. [Output only] The services IPv6 CIDR block for the cluster. + "servicesIpv6CidrBlock": "A String", # Output only. The services IPv6 CIDR block for the cluster. "servicesSecondaryRangeName": "A String", # The name of the secondary range to be used as for the services CIDR block. The secondary range will be used for service ClusterIPs. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases is true and create_subnetwork is false. "stackType": "A String", # The IP stack type of the cluster - "subnetIpv6CidrBlock": "A String", # Output only. [Output only] The subnet's IPv6 CIDR block used by nodes and pods. + "subnetIpv6CidrBlock": "A String", # Output only. The subnet's IPv6 CIDR block used by nodes and pods. "subnetworkName": "A String", # A custom subnetwork name to be used if `create_subnetwork` is true. If this field is empty, then an automatic name will be chosen for the new subnetwork. "tpuIpv4CidrBlock": "A String", # The IP address range of the Cloud TPUs in this cluster. If unspecified, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. If unspecified, the range will use the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. "useIpAliases": True or False, # Whether alias IPs will be used for pod IPs in the cluster. This is used in conjunction with use_routes. It cannot be true if use_routes is true. If both use_ip_aliases and use_routes are false, then the server picks the default IP allocation mode @@ -484,7 +484,7 @@

Method Details

"legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization mode. # Configuration for the legacy ABAC authorization mode. "enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed. "A String", ], @@ -500,7 +500,7 @@

Method Details

"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of the policy won't accidentally undo intermediate changes (and so that users of the API unaware of some fields won't accidentally remove other fields). Make a `get()` request to the cluster to get the current resource version and include it with requests to set the policy. "window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed. "dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window. - "duration": "A String", # [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "PTnHnMnS". + "duration": "A String", # Output only. Duration of the time window, automatically chosen to be smallest possible in the given scenario. Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "PTnHnMnS". "startTime": "A String", # Time within the maintenance window to start the maintenance operations. Time format should be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "HH:MM", where HH : [00-23] and MM : [00-59] GMT. }, "maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows. @@ -525,12 +525,12 @@

Method Details

}, }, "masterAuth": { # The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. # The authentication information for accessing the master endpoint. If unspecified, the defaults are used: For clusters before v1.12, if master_auth is unspecified, `username` will be set to "admin", a random password will be generated, and a client certificate will be issued. - "clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. + "clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. "clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued. "issueClientCertificate": True or False, # Issue a client certificate. }, - "clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint. - "clusterCaCertificate": "A String", # [Output only] Base64-encoded public certificate that is the root of trust for the cluster. + "clientKey": "A String", # Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint. + "clusterCaCertificate": "A String", # Output only. Base64-encoded public certificate that is the root of trust for the cluster. "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication }, @@ -752,7 +752,7 @@

Method Details

"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running on the node pool. }, }, - "nodeIpv4CidrSize": 42, # [Output only] The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode. + "nodeIpv4CidrSize": 42, # Output only. The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode. "nodePoolAutoConfig": { # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. "networkTags": { # Collection of Compute Engine network tags that can be applied to a node's underlying VM instance. # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster creation. Each tag within the list must comply with RFC1035. "tags": [ # List of network tags. @@ -983,7 +983,7 @@

Method Details

}, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. @@ -993,8 +993,8 @@

Method Details

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered. "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool. @@ -1026,7 +1026,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -1034,14 +1034,14 @@

Method Details

"tpuTopology": "A String", # Optional. TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, - "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool. + "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, - "selfLink": "A String", # [Output only] Server-defined URL for the resource. - "status": "A String", # [Output only] The status of the nodes in this pool instance. - "statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. - "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. [Output only] Update info contains relevant information during a node pool update. + "selfLink": "A String", # Output only. Server-defined URL for the resource. + "status": "A String", # Output only. The status of the nodes in this pool instance. + "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. + "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. Update info contains relevant information during a node pool update. "blueGreenInfo": { # Information relevant to blue-green upgrade. # Information of a blue-green upgrade. "blueInstanceGroupUrls": [ # The resource URLs of the [managed instance groups] (/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with blue pool. "A String", @@ -1120,22 +1120,22 @@

Method Details

"mode": "A String", # Sets which mode to use for Security Posture features. "vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning. }, - "selfLink": "A String", # [Output only] Server-defined URL for the resource. - "servicesIpv4Cidr": "A String", # [Output only] The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR. + "selfLink": "A String", # Output only. Server-defined URL for the resource. + "servicesIpv4Cidr": "A String", # Output only. The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR. "shieldedNodes": { # Configuration of Shielded Nodes feature. # Shielded Nodes configuration. "enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster. }, - "status": "A String", # [Output only] The current status of this cluster. - "statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available. + "status": "A String", # Output only. The current status of this cluster. + "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available. "subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected. - "tpuIpv4CidrBlock": "A String", # [Output only] The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). + "tpuIpv4CidrBlock": "A String", # Output only. The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). "verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it. # Cluster-level Vertical Pod Autoscaling configuration. "enabled": True or False, # Enables vertical pod autoscaling. }, "workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to. }, - "zone": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. }, "parent": "A String", # The parent (project and location) where the cluster will be created. Specified in the format `projects/*/locations/*`. "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. @@ -1158,8 +1158,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -1169,8 +1169,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -1178,8 +1178,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -1194,12 +1194,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }
@@ -1228,8 +1228,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -1239,8 +1239,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -1248,8 +1248,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -1264,12 +1264,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }
@@ -1363,8 +1363,8 @@

Method Details

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered. "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. @@ -1418,10 +1418,10 @@

Method Details

"costManagementConfig": { # Configuration for fine-grained cost management feature. # Configuration for the fine-grained cost management feature. "enabled": True or False, # Whether the feature is enabled or not. }, - "createTime": "A String", # [Output only] The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "currentMasterVersion": "A String", # [Output only] The current software version of the master endpoint. - "currentNodeCount": 42, # [Output only] The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. - "currentNodeVersion": "A String", # [Output only] Deprecated, use [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. + "createTime": "A String", # Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "currentMasterVersion": "A String", # Output only. The current software version of the master endpoint. + "currentNodeCount": 42, # Output only. The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. + "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. "databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption. "currentState": "A String", # Output only. The current state of etcd encryption. "decryptionKeys": [ # Output only. Keys in use by the cluster for decrypting existing objects, in addition to the key in `key_name`. Each item is a CloudKMS key resource. @@ -1448,15 +1448,15 @@

Method Details

}, "enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1alpha1) and features that may not be production ready in the kubernetes version of the master and nodes. The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are automatically deleted thirty days after creation. "enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster. - "endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. + "endpoint": "A String", # Output only. The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. "enterpriseConfig": { # EnterpriseConfig is the cluster enterprise configuration. # GKE Enterprise Configuration. - "clusterTier": "A String", # Output only. [Output only] cluster_tier specifies the premium tier of the cluster. + "clusterTier": "A String", # Output only. cluster_tier specifies the premium tier of the cluster. }, "etag": "A String", # This checksum is computed by the server based on the value of cluster fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. - "expireTime": "A String", # [Output only] The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "expireTime": "A String", # Output only. The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "fleet": { # Fleet is the fleet configuration for the cluster. # Fleet information for the cluster. - "membership": "A String", # [Output only] The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`. - "preRegistered": True or False, # [Output only] Whether the cluster has been registered through the fleet API. + "membership": "A String", # Output only. The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`. + "preRegistered": True or False, # Output only. Whether the cluster has been registered through the fleet API. "project": "A String", # The Fleet host project(project ID or project number) where this cluster will be registered to. This field cannot be changed after the cluster has been registered. }, "id": "A String", # Output only. Unique id for the cluster. @@ -1465,15 +1465,15 @@

Method Details

}, "initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "","-": picks the default Kubernetes version "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead. - "instanceGroupUrls": [ # Deprecated. Use node_pools.instance_group_urls. + "instanceGroupUrls": [ # Output only. Deprecated. Use node_pools.instance_group_urls. "A String", ], "ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the cluster. # Configuration for cluster IP allocation. - "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # Output only. [Output only] The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy. - "podRangeInfo": [ # Output only. [Output only] Information for additional pod range. + "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # Output only. The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy. + "podRangeInfo": [ # Output only. Information for additional pod range. { # RangeInfo contains the range name and the range utilization by this cluster. - "rangeName": "A String", # Output only. [Output only] Name of a range. - "utilization": 3.14, # Output only. [Output only] The utilization of the range. + "rangeName": "A String", # Output only. Name of a range. + "utilization": 3.14, # Output only. The utilization of the range. }, ], "podRangeNames": [ # Name for pod secondary ipv4 range which has the actual range defined ahead. @@ -1484,7 +1484,7 @@

Method Details

"clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then `cluster.cluster_ipv4_cidr` must be left blank. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. "clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases is true and create_subnetwork is false. "createSubnetwork": True or False, # Whether a new subnetwork will be created automatically for the cluster. This field is only applicable when `use_ip_aliases` is true. - "defaultPodIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "defaultPodIpv4RangeUtilization": 3.14, # Output only. The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "ipv6AccessType": "A String", # The ipv6 access type (internal or external) when create_subnetwork is true "nodeIpv4Cidr": "A String", # This field is deprecated, use node_ipv4_cidr_block. "nodeIpv4CidrBlock": "A String", # The IP address range of the instance IPs in this cluster. This is applicable only if `create_subnetwork` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. @@ -1493,10 +1493,10 @@

Method Details

}, "servicesIpv4Cidr": "A String", # This field is deprecated, use services_ipv4_cidr_block. "servicesIpv4CidrBlock": "A String", # The IP address range of the services IPs in this cluster. If blank, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. - "servicesIpv6CidrBlock": "A String", # Output only. [Output only] The services IPv6 CIDR block for the cluster. + "servicesIpv6CidrBlock": "A String", # Output only. The services IPv6 CIDR block for the cluster. "servicesSecondaryRangeName": "A String", # The name of the secondary range to be used as for the services CIDR block. The secondary range will be used for service ClusterIPs. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases is true and create_subnetwork is false. "stackType": "A String", # The IP stack type of the cluster - "subnetIpv6CidrBlock": "A String", # Output only. [Output only] The subnet's IPv6 CIDR block used by nodes and pods. + "subnetIpv6CidrBlock": "A String", # Output only. The subnet's IPv6 CIDR block used by nodes and pods. "subnetworkName": "A String", # A custom subnetwork name to be used if `create_subnetwork` is true. If this field is empty, then an automatic name will be chosen for the new subnetwork. "tpuIpv4CidrBlock": "A String", # The IP address range of the Cloud TPUs in this cluster. If unspecified, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. If unspecified, the range will use the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. "useIpAliases": True or False, # Whether alias IPs will be used for pod IPs in the cluster. This is used in conjunction with use_routes. It cannot be true if use_routes is true. If both use_ip_aliases and use_routes are false, then the server picks the default IP allocation mode @@ -1506,7 +1506,7 @@

Method Details

"legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization mode. # Configuration for the legacy ABAC authorization mode. "enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed. "A String", ], @@ -1522,7 +1522,7 @@

Method Details

"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of the policy won't accidentally undo intermediate changes (and so that users of the API unaware of some fields won't accidentally remove other fields). Make a `get()` request to the cluster to get the current resource version and include it with requests to set the policy. "window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed. "dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window. - "duration": "A String", # [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "PTnHnMnS". + "duration": "A String", # Output only. Duration of the time window, automatically chosen to be smallest possible in the given scenario. Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "PTnHnMnS". "startTime": "A String", # Time within the maintenance window to start the maintenance operations. Time format should be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "HH:MM", where HH : [00-23] and MM : [00-59] GMT. }, "maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows. @@ -1547,12 +1547,12 @@

Method Details

}, }, "masterAuth": { # The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. # The authentication information for accessing the master endpoint. If unspecified, the defaults are used: For clusters before v1.12, if master_auth is unspecified, `username` will be set to "admin", a random password will be generated, and a client certificate will be issued. - "clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. + "clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. "clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued. "issueClientCertificate": True or False, # Issue a client certificate. }, - "clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint. - "clusterCaCertificate": "A String", # [Output only] Base64-encoded public certificate that is the root of trust for the cluster. + "clientKey": "A String", # Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint. + "clusterCaCertificate": "A String", # Output only. Base64-encoded public certificate that is the root of trust for the cluster. "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication }, @@ -1774,7 +1774,7 @@

Method Details

"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running on the node pool. }, }, - "nodeIpv4CidrSize": 42, # [Output only] The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode. + "nodeIpv4CidrSize": 42, # Output only. The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode. "nodePoolAutoConfig": { # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. "networkTags": { # Collection of Compute Engine network tags that can be applied to a node's underlying VM instance. # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster creation. Each tag within the list must comply with RFC1035. "tags": [ # List of network tags. @@ -2005,7 +2005,7 @@

Method Details

}, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. @@ -2015,8 +2015,8 @@

Method Details

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered. "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool. @@ -2048,7 +2048,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -2056,14 +2056,14 @@

Method Details

"tpuTopology": "A String", # Optional. TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, - "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool. + "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, - "selfLink": "A String", # [Output only] Server-defined URL for the resource. - "status": "A String", # [Output only] The status of the nodes in this pool instance. - "statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. - "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. [Output only] Update info contains relevant information during a node pool update. + "selfLink": "A String", # Output only. Server-defined URL for the resource. + "status": "A String", # Output only. The status of the nodes in this pool instance. + "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. + "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. Update info contains relevant information during a node pool update. "blueGreenInfo": { # Information relevant to blue-green upgrade. # Information of a blue-green upgrade. "blueInstanceGroupUrls": [ # The resource URLs of the [managed instance groups] (/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with blue pool. "A String", @@ -2142,22 +2142,22 @@

Method Details

"mode": "A String", # Sets which mode to use for Security Posture features. "vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning. }, - "selfLink": "A String", # [Output only] Server-defined URL for the resource. - "servicesIpv4Cidr": "A String", # [Output only] The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR. + "selfLink": "A String", # Output only. Server-defined URL for the resource. + "servicesIpv4Cidr": "A String", # Output only. The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR. "shieldedNodes": { # Configuration of Shielded Nodes feature. # Shielded Nodes configuration. "enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster. }, - "status": "A String", # [Output only] The current status of this cluster. - "statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available. + "status": "A String", # Output only. The current status of this cluster. + "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available. "subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected. - "tpuIpv4CidrBlock": "A String", # [Output only] The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). + "tpuIpv4CidrBlock": "A String", # Output only. The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). "verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it. # Cluster-level Vertical Pod Autoscaling configuration. "enabled": True or False, # Enables vertical pod autoscaling. }, "workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to. }, - "zone": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. }
@@ -2288,8 +2288,8 @@

Method Details

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered. "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. @@ -2343,10 +2343,10 @@

Method Details

"costManagementConfig": { # Configuration for fine-grained cost management feature. # Configuration for the fine-grained cost management feature. "enabled": True or False, # Whether the feature is enabled or not. }, - "createTime": "A String", # [Output only] The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "currentMasterVersion": "A String", # [Output only] The current software version of the master endpoint. - "currentNodeCount": 42, # [Output only] The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. - "currentNodeVersion": "A String", # [Output only] Deprecated, use [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. + "createTime": "A String", # Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "currentMasterVersion": "A String", # Output only. The current software version of the master endpoint. + "currentNodeCount": 42, # Output only. The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. + "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. "databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption. "currentState": "A String", # Output only. The current state of etcd encryption. "decryptionKeys": [ # Output only. Keys in use by the cluster for decrypting existing objects, in addition to the key in `key_name`. Each item is a CloudKMS key resource. @@ -2373,15 +2373,15 @@

Method Details

}, "enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1alpha1) and features that may not be production ready in the kubernetes version of the master and nodes. The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are automatically deleted thirty days after creation. "enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster. - "endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. + "endpoint": "A String", # Output only. The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. "enterpriseConfig": { # EnterpriseConfig is the cluster enterprise configuration. # GKE Enterprise Configuration. - "clusterTier": "A String", # Output only. [Output only] cluster_tier specifies the premium tier of the cluster. + "clusterTier": "A String", # Output only. cluster_tier specifies the premium tier of the cluster. }, "etag": "A String", # This checksum is computed by the server based on the value of cluster fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. - "expireTime": "A String", # [Output only] The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "expireTime": "A String", # Output only. The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "fleet": { # Fleet is the fleet configuration for the cluster. # Fleet information for the cluster. - "membership": "A String", # [Output only] The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`. - "preRegistered": True or False, # [Output only] Whether the cluster has been registered through the fleet API. + "membership": "A String", # Output only. The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`. + "preRegistered": True or False, # Output only. Whether the cluster has been registered through the fleet API. "project": "A String", # The Fleet host project(project ID or project number) where this cluster will be registered to. This field cannot be changed after the cluster has been registered. }, "id": "A String", # Output only. Unique id for the cluster. @@ -2390,15 +2390,15 @@

Method Details

}, "initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "","-": picks the default Kubernetes version "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead. - "instanceGroupUrls": [ # Deprecated. Use node_pools.instance_group_urls. + "instanceGroupUrls": [ # Output only. Deprecated. Use node_pools.instance_group_urls. "A String", ], "ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the cluster. # Configuration for cluster IP allocation. - "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # Output only. [Output only] The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy. - "podRangeInfo": [ # Output only. [Output only] Information for additional pod range. + "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # Output only. The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy. + "podRangeInfo": [ # Output only. Information for additional pod range. { # RangeInfo contains the range name and the range utilization by this cluster. - "rangeName": "A String", # Output only. [Output only] Name of a range. - "utilization": 3.14, # Output only. [Output only] The utilization of the range. + "rangeName": "A String", # Output only. Name of a range. + "utilization": 3.14, # Output only. The utilization of the range. }, ], "podRangeNames": [ # Name for pod secondary ipv4 range which has the actual range defined ahead. @@ -2409,7 +2409,7 @@

Method Details

"clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then `cluster.cluster_ipv4_cidr` must be left blank. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. "clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases is true and create_subnetwork is false. "createSubnetwork": True or False, # Whether a new subnetwork will be created automatically for the cluster. This field is only applicable when `use_ip_aliases` is true. - "defaultPodIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "defaultPodIpv4RangeUtilization": 3.14, # Output only. The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "ipv6AccessType": "A String", # The ipv6 access type (internal or external) when create_subnetwork is true "nodeIpv4Cidr": "A String", # This field is deprecated, use node_ipv4_cidr_block. "nodeIpv4CidrBlock": "A String", # The IP address range of the instance IPs in this cluster. This is applicable only if `create_subnetwork` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. @@ -2418,10 +2418,10 @@

Method Details

}, "servicesIpv4Cidr": "A String", # This field is deprecated, use services_ipv4_cidr_block. "servicesIpv4CidrBlock": "A String", # The IP address range of the services IPs in this cluster. If blank, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. - "servicesIpv6CidrBlock": "A String", # Output only. [Output only] The services IPv6 CIDR block for the cluster. + "servicesIpv6CidrBlock": "A String", # Output only. The services IPv6 CIDR block for the cluster. "servicesSecondaryRangeName": "A String", # The name of the secondary range to be used as for the services CIDR block. The secondary range will be used for service ClusterIPs. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases is true and create_subnetwork is false. "stackType": "A String", # The IP stack type of the cluster - "subnetIpv6CidrBlock": "A String", # Output only. [Output only] The subnet's IPv6 CIDR block used by nodes and pods. + "subnetIpv6CidrBlock": "A String", # Output only. The subnet's IPv6 CIDR block used by nodes and pods. "subnetworkName": "A String", # A custom subnetwork name to be used if `create_subnetwork` is true. If this field is empty, then an automatic name will be chosen for the new subnetwork. "tpuIpv4CidrBlock": "A String", # The IP address range of the Cloud TPUs in this cluster. If unspecified, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. If unspecified, the range will use the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. "useIpAliases": True or False, # Whether alias IPs will be used for pod IPs in the cluster. This is used in conjunction with use_routes. It cannot be true if use_routes is true. If both use_ip_aliases and use_routes are false, then the server picks the default IP allocation mode @@ -2431,7 +2431,7 @@

Method Details

"legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization mode. # Configuration for the legacy ABAC authorization mode. "enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed. "A String", ], @@ -2447,7 +2447,7 @@

Method Details

"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of the policy won't accidentally undo intermediate changes (and so that users of the API unaware of some fields won't accidentally remove other fields). Make a `get()` request to the cluster to get the current resource version and include it with requests to set the policy. "window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed. "dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window. - "duration": "A String", # [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "PTnHnMnS". + "duration": "A String", # Output only. Duration of the time window, automatically chosen to be smallest possible in the given scenario. Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "PTnHnMnS". "startTime": "A String", # Time within the maintenance window to start the maintenance operations. Time format should be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "HH:MM", where HH : [00-23] and MM : [00-59] GMT. }, "maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows. @@ -2472,12 +2472,12 @@

Method Details

}, }, "masterAuth": { # The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. # The authentication information for accessing the master endpoint. If unspecified, the defaults are used: For clusters before v1.12, if master_auth is unspecified, `username` will be set to "admin", a random password will be generated, and a client certificate will be issued. - "clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. + "clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. "clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued. "issueClientCertificate": True or False, # Issue a client certificate. }, - "clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint. - "clusterCaCertificate": "A String", # [Output only] Base64-encoded public certificate that is the root of trust for the cluster. + "clientKey": "A String", # Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint. + "clusterCaCertificate": "A String", # Output only. Base64-encoded public certificate that is the root of trust for the cluster. "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication }, @@ -2699,7 +2699,7 @@

Method Details

"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running on the node pool. }, }, - "nodeIpv4CidrSize": 42, # [Output only] The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode. + "nodeIpv4CidrSize": 42, # Output only. The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode. "nodePoolAutoConfig": { # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. "networkTags": { # Collection of Compute Engine network tags that can be applied to a node's underlying VM instance. # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster creation. Each tag within the list must comply with RFC1035. "tags": [ # List of network tags. @@ -2930,7 +2930,7 @@

Method Details

}, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. @@ -2940,8 +2940,8 @@

Method Details

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered. "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool. @@ -2973,7 +2973,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -2981,14 +2981,14 @@

Method Details

"tpuTopology": "A String", # Optional. TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, - "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool. + "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, - "selfLink": "A String", # [Output only] Server-defined URL for the resource. - "status": "A String", # [Output only] The status of the nodes in this pool instance. - "statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. - "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. [Output only] Update info contains relevant information during a node pool update. + "selfLink": "A String", # Output only. Server-defined URL for the resource. + "status": "A String", # Output only. The status of the nodes in this pool instance. + "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. + "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. Update info contains relevant information during a node pool update. "blueGreenInfo": { # Information relevant to blue-green upgrade. # Information of a blue-green upgrade. "blueInstanceGroupUrls": [ # The resource URLs of the [managed instance groups] (/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with blue pool. "A String", @@ -3067,22 +3067,22 @@

Method Details

"mode": "A String", # Sets which mode to use for Security Posture features. "vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning. }, - "selfLink": "A String", # [Output only] Server-defined URL for the resource. - "servicesIpv4Cidr": "A String", # [Output only] The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR. + "selfLink": "A String", # Output only. Server-defined URL for the resource. + "servicesIpv4Cidr": "A String", # Output only. The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR. "shieldedNodes": { # Configuration of Shielded Nodes feature. # Shielded Nodes configuration. "enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster. }, - "status": "A String", # [Output only] The current status of this cluster. - "statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available. + "status": "A String", # Output only. The current status of this cluster. + "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available. "subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected. - "tpuIpv4CidrBlock": "A String", # [Output only] The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). + "tpuIpv4CidrBlock": "A String", # Output only. The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). "verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it. # Cluster-level Vertical Pod Autoscaling configuration. "enabled": True or False, # Enables vertical pod autoscaling. }, "workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to. }, - "zone": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. }, ], "missingZones": [ # If any zones are listed here, the list of clusters returned may be missing those zones. @@ -3171,8 +3171,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -3182,8 +3182,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -3191,8 +3191,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -3207,12 +3207,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }
@@ -3249,8 +3249,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -3260,8 +3260,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -3269,8 +3269,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -3285,12 +3285,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }
@@ -3329,8 +3329,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -3340,8 +3340,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -3349,8 +3349,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -3365,12 +3365,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }
@@ -3407,8 +3407,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -3418,8 +3418,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -3427,8 +3427,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -3443,12 +3443,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -3467,7 +3467,7 @@

Method Details

"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of the policy won't accidentally undo intermediate changes (and so that users of the API unaware of some fields won't accidentally remove other fields). Make a `get()` request to the cluster to get the current resource version and include it with requests to set the policy. "window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed. "dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window. - "duration": "A String", # [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "PTnHnMnS". + "duration": "A String", # Output only. Duration of the time window, automatically chosen to be smallest possible in the given scenario. Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "PTnHnMnS". "startTime": "A String", # Time within the maintenance window to start the maintenance operations. Time format should be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "HH:MM", where HH : [00-23] and MM : [00-59] GMT. }, "maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows. @@ -3512,8 +3512,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -3523,8 +3523,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -3532,8 +3532,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -3548,12 +3548,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -3572,12 +3572,12 @@

Method Details

"name": "A String", # The name (project, location, cluster) of the cluster to set auth. Specified in the format `projects/*/locations/*/clusters/*`. "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. "update": { # The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. # Required. A description of the update. - "clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. + "clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. "clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued. "issueClientCertificate": True or False, # Issue a client certificate. }, - "clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint. - "clusterCaCertificate": "A String", # [Output only] Base64-encoded public certificate that is the root of trust for the cluster. + "clientKey": "A String", # Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint. + "clusterCaCertificate": "A String", # Output only. Base64-encoded public certificate that is the root of trust for the cluster. "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication }, @@ -3600,8 +3600,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -3611,8 +3611,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -3620,8 +3620,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -3636,12 +3636,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -3678,8 +3678,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -3689,8 +3689,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -3698,8 +3698,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -3714,12 +3714,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -3759,8 +3759,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -3770,8 +3770,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -3779,8 +3779,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -3795,12 +3795,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -3840,8 +3840,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -3851,8 +3851,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -3860,8 +3860,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -3876,12 +3876,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -3918,8 +3918,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -3929,8 +3929,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -3938,8 +3938,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -3954,12 +3954,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -3978,10 +3978,10 @@

Method Details

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. "update": { # ClusterUpdate describes an update to the cluster. Exactly one update can be applied to a cluster with each request, so at most one field can be provided. # Required. A description of the update. "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # The additional pod ranges to be added to the cluster. These pod ranges can be used by node pools to allocate pod IPs. - "podRangeInfo": [ # Output only. [Output only] Information for additional pod range. + "podRangeInfo": [ # Output only. Information for additional pod range. { # RangeInfo contains the range name and the range utilization by this cluster. - "rangeName": "A String", # Output only. [Output only] Name of a range. - "utilization": 3.14, # Output only. [Output only] The utilization of the range. + "rangeName": "A String", # Output only. Name of a range. + "utilization": 3.14, # Output only. The utilization of the range. }, ], "podRangeNames": [ # Name for pod secondary ipv4 range which has the actual range defined ahead. @@ -4061,8 +4061,8 @@

Method Details

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered. "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. @@ -4146,8 +4146,8 @@

Method Details

"desiredEnableMultiNetworking": True or False, # Enable/Disable Multi-Networking for the cluster "desiredEnablePrivateEndpoint": True or False, # Enable/Disable private endpoint for the cluster's master. "desiredFleet": { # Fleet is the fleet configuration for the cluster. # The desired fleet configuration for the cluster. - "membership": "A String", # [Output only] The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`. - "preRegistered": True or False, # [Output only] Whether the cluster has been registered through the fleet API. + "membership": "A String", # Output only. The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`. + "preRegistered": True or False, # Output only. Whether the cluster has been registered through the fleet API. "project": "A String", # The Fleet host project(project ID or project number) where this cluster will be registered to. This field cannot be changed after the cluster has been registered. }, "desiredGatewayApiConfig": { # GatewayAPIConfig contains the desired config of Gateway API on this cluster. # The desired config of Gateway API on this cluster. @@ -4322,10 +4322,10 @@

Method Details

}, "etag": "A String", # The current etag of the cluster. If an etag is provided and does not match the current etag of the cluster, update will be blocked and an ABORTED error will be returned. "removedAdditionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # The additional pod ranges that are to be removed from the cluster. The pod ranges specified here must have been specified earlier in the 'additional_pod_ranges_config' argument. - "podRangeInfo": [ # Output only. [Output only] Information for additional pod range. + "podRangeInfo": [ # Output only. Information for additional pod range. { # RangeInfo contains the range name and the range utilization by this cluster. - "rangeName": "A String", # Output only. [Output only] Name of a range. - "utilization": 3.14, # Output only. [Output only] The utilization of the range. + "rangeName": "A String", # Output only. Name of a range. + "utilization": 3.14, # Output only. The utilization of the range. }, ], "podRangeNames": [ # Name for pod secondary ipv4 range which has the actual range defined ahead. @@ -4352,8 +4352,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -4363,8 +4363,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -4372,8 +4372,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -4388,12 +4388,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -4430,8 +4430,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -4441,8 +4441,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -4450,8 +4450,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -4466,12 +4466,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } diff --git a/docs/dyn/container_v1.projects.locations.clusters.nodePools.html b/docs/dyn/container_v1.projects.locations.clusters.nodePools.html index daa25d9f7c1..ea57bac531b 100644 --- a/docs/dyn/container_v1.projects.locations.clusters.nodePools.html +++ b/docs/dyn/container_v1.projects.locations.clusters.nodePools.html @@ -324,7 +324,7 @@

Method Details

}, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. @@ -334,8 +334,8 @@

Method Details

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered. "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool. @@ -367,7 +367,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -375,14 +375,14 @@

Method Details

"tpuTopology": "A String", # Optional. TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, - "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool. + "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, - "selfLink": "A String", # [Output only] Server-defined URL for the resource. - "status": "A String", # [Output only] The status of the nodes in this pool instance. - "statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. - "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. [Output only] Update info contains relevant information during a node pool update. + "selfLink": "A String", # Output only. Server-defined URL for the resource. + "status": "A String", # Output only. The status of the nodes in this pool instance. + "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. + "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. Update info contains relevant information during a node pool update. "blueGreenInfo": { # Information relevant to blue-green upgrade. # Information of a blue-green upgrade. "blueInstanceGroupUrls": [ # The resource URLs of the [managed instance groups] (/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with blue pool. "A String", @@ -431,8 +431,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -442,8 +442,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -451,8 +451,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -467,12 +467,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -502,8 +502,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -513,8 +513,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -522,8 +522,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -538,12 +538,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -741,7 +741,7 @@

Method Details

}, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. @@ -751,8 +751,8 @@

Method Details

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered. "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool. @@ -784,7 +784,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -792,14 +792,14 @@

Method Details

"tpuTopology": "A String", # Optional. TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, - "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool. + "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, - "selfLink": "A String", # [Output only] Server-defined URL for the resource. - "status": "A String", # [Output only] The status of the nodes in this pool instance. - "statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. - "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. [Output only] Update info contains relevant information during a node pool update. + "selfLink": "A String", # Output only. Server-defined URL for the resource. + "status": "A String", # Output only. The status of the nodes in this pool instance. + "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. + "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. Update info contains relevant information during a node pool update. "blueGreenInfo": { # Information relevant to blue-green upgrade. # Information of a blue-green upgrade. "blueInstanceGroupUrls": [ # The resource URLs of the [managed instance groups] (/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with blue pool. "A String", @@ -1024,7 +1024,7 @@

Method Details

}, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. @@ -1034,8 +1034,8 @@

Method Details

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered. "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool. @@ -1067,7 +1067,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -1075,14 +1075,14 @@

Method Details

"tpuTopology": "A String", # Optional. TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, - "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool. + "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, - "selfLink": "A String", # [Output only] Server-defined URL for the resource. - "status": "A String", # [Output only] The status of the nodes in this pool instance. - "statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. - "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. [Output only] Update info contains relevant information during a node pool update. + "selfLink": "A String", # Output only. Server-defined URL for the resource. + "status": "A String", # Output only. The status of the nodes in this pool instance. + "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. + "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. Update info contains relevant information during a node pool update. "blueGreenInfo": { # Information relevant to blue-green upgrade. # Information of a blue-green upgrade. "blueInstanceGroupUrls": [ # The resource URLs of the [managed instance groups] (/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with blue pool. "A String", @@ -1148,8 +1148,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -1159,8 +1159,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -1168,8 +1168,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -1184,12 +1184,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -1235,8 +1235,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -1246,8 +1246,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -1255,8 +1255,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -1271,12 +1271,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -1295,8 +1295,8 @@

Method Details

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered. "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "name": "A String", # The name (project, location, cluster, node pool id) of the node pool to set management properties. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. @@ -1321,8 +1321,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -1332,8 +1332,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -1341,8 +1341,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -1357,12 +1357,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -1400,8 +1400,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -1411,8 +1411,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -1420,8 +1420,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -1436,12 +1436,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -1558,7 +1558,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "nodePoolId": "A String", # Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. @@ -1629,8 +1629,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -1640,8 +1640,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -1649,8 +1649,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -1665,12 +1665,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } diff --git a/docs/dyn/container_v1.projects.locations.operations.html b/docs/dyn/container_v1.projects.locations.operations.html index 37086edd12f..6c0e4e223c7 100644 --- a/docs/dyn/container_v1.projects.locations.operations.html +++ b/docs/dyn/container_v1.projects.locations.operations.html @@ -145,8 +145,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -156,8 +156,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -165,8 +165,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -181,12 +181,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -219,8 +219,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -230,8 +230,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -239,8 +239,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -255,12 +255,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }, ], } diff --git a/docs/dyn/container_v1.projects.zones.clusters.html b/docs/dyn/container_v1.projects.zones.clusters.html index 37702af9bb6..138ed928f8a 100644 --- a/docs/dyn/container_v1.projects.zones.clusters.html +++ b/docs/dyn/container_v1.projects.zones.clusters.html @@ -216,8 +216,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -227,8 +227,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -236,8 +236,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -252,12 +252,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -300,8 +300,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -311,8 +311,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -320,8 +320,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -336,12 +336,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -429,8 +429,8 @@

Method Details

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered. "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. @@ -484,10 +484,10 @@

Method Details

"costManagementConfig": { # Configuration for fine-grained cost management feature. # Configuration for the fine-grained cost management feature. "enabled": True or False, # Whether the feature is enabled or not. }, - "createTime": "A String", # [Output only] The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "currentMasterVersion": "A String", # [Output only] The current software version of the master endpoint. - "currentNodeCount": 42, # [Output only] The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. - "currentNodeVersion": "A String", # [Output only] Deprecated, use [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. + "createTime": "A String", # Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "currentMasterVersion": "A String", # Output only. The current software version of the master endpoint. + "currentNodeCount": 42, # Output only. The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. + "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. "databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption. "currentState": "A String", # Output only. The current state of etcd encryption. "decryptionKeys": [ # Output only. Keys in use by the cluster for decrypting existing objects, in addition to the key in `key_name`. Each item is a CloudKMS key resource. @@ -514,15 +514,15 @@

Method Details

}, "enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1alpha1) and features that may not be production ready in the kubernetes version of the master and nodes. The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are automatically deleted thirty days after creation. "enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster. - "endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. + "endpoint": "A String", # Output only. The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. "enterpriseConfig": { # EnterpriseConfig is the cluster enterprise configuration. # GKE Enterprise Configuration. - "clusterTier": "A String", # Output only. [Output only] cluster_tier specifies the premium tier of the cluster. + "clusterTier": "A String", # Output only. cluster_tier specifies the premium tier of the cluster. }, "etag": "A String", # This checksum is computed by the server based on the value of cluster fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. - "expireTime": "A String", # [Output only] The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "expireTime": "A String", # Output only. The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "fleet": { # Fleet is the fleet configuration for the cluster. # Fleet information for the cluster. - "membership": "A String", # [Output only] The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`. - "preRegistered": True or False, # [Output only] Whether the cluster has been registered through the fleet API. + "membership": "A String", # Output only. The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`. + "preRegistered": True or False, # Output only. Whether the cluster has been registered through the fleet API. "project": "A String", # The Fleet host project(project ID or project number) where this cluster will be registered to. This field cannot be changed after the cluster has been registered. }, "id": "A String", # Output only. Unique id for the cluster. @@ -531,15 +531,15 @@

Method Details

}, "initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "","-": picks the default Kubernetes version "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead. - "instanceGroupUrls": [ # Deprecated. Use node_pools.instance_group_urls. + "instanceGroupUrls": [ # Output only. Deprecated. Use node_pools.instance_group_urls. "A String", ], "ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the cluster. # Configuration for cluster IP allocation. - "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # Output only. [Output only] The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy. - "podRangeInfo": [ # Output only. [Output only] Information for additional pod range. + "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # Output only. The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy. + "podRangeInfo": [ # Output only. Information for additional pod range. { # RangeInfo contains the range name and the range utilization by this cluster. - "rangeName": "A String", # Output only. [Output only] Name of a range. - "utilization": 3.14, # Output only. [Output only] The utilization of the range. + "rangeName": "A String", # Output only. Name of a range. + "utilization": 3.14, # Output only. The utilization of the range. }, ], "podRangeNames": [ # Name for pod secondary ipv4 range which has the actual range defined ahead. @@ -550,7 +550,7 @@

Method Details

"clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then `cluster.cluster_ipv4_cidr` must be left blank. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. "clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases is true and create_subnetwork is false. "createSubnetwork": True or False, # Whether a new subnetwork will be created automatically for the cluster. This field is only applicable when `use_ip_aliases` is true. - "defaultPodIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "defaultPodIpv4RangeUtilization": 3.14, # Output only. The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "ipv6AccessType": "A String", # The ipv6 access type (internal or external) when create_subnetwork is true "nodeIpv4Cidr": "A String", # This field is deprecated, use node_ipv4_cidr_block. "nodeIpv4CidrBlock": "A String", # The IP address range of the instance IPs in this cluster. This is applicable only if `create_subnetwork` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. @@ -559,10 +559,10 @@

Method Details

}, "servicesIpv4Cidr": "A String", # This field is deprecated, use services_ipv4_cidr_block. "servicesIpv4CidrBlock": "A String", # The IP address range of the services IPs in this cluster. If blank, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. - "servicesIpv6CidrBlock": "A String", # Output only. [Output only] The services IPv6 CIDR block for the cluster. + "servicesIpv6CidrBlock": "A String", # Output only. The services IPv6 CIDR block for the cluster. "servicesSecondaryRangeName": "A String", # The name of the secondary range to be used as for the services CIDR block. The secondary range will be used for service ClusterIPs. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases is true and create_subnetwork is false. "stackType": "A String", # The IP stack type of the cluster - "subnetIpv6CidrBlock": "A String", # Output only. [Output only] The subnet's IPv6 CIDR block used by nodes and pods. + "subnetIpv6CidrBlock": "A String", # Output only. The subnet's IPv6 CIDR block used by nodes and pods. "subnetworkName": "A String", # A custom subnetwork name to be used if `create_subnetwork` is true. If this field is empty, then an automatic name will be chosen for the new subnetwork. "tpuIpv4CidrBlock": "A String", # The IP address range of the Cloud TPUs in this cluster. If unspecified, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. If unspecified, the range will use the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. "useIpAliases": True or False, # Whether alias IPs will be used for pod IPs in the cluster. This is used in conjunction with use_routes. It cannot be true if use_routes is true. If both use_ip_aliases and use_routes are false, then the server picks the default IP allocation mode @@ -572,7 +572,7 @@

Method Details

"legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization mode. # Configuration for the legacy ABAC authorization mode. "enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed. "A String", ], @@ -588,7 +588,7 @@

Method Details

"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of the policy won't accidentally undo intermediate changes (and so that users of the API unaware of some fields won't accidentally remove other fields). Make a `get()` request to the cluster to get the current resource version and include it with requests to set the policy. "window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed. "dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window. - "duration": "A String", # [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "PTnHnMnS". + "duration": "A String", # Output only. Duration of the time window, automatically chosen to be smallest possible in the given scenario. Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "PTnHnMnS". "startTime": "A String", # Time within the maintenance window to start the maintenance operations. Time format should be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "HH:MM", where HH : [00-23] and MM : [00-59] GMT. }, "maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows. @@ -613,12 +613,12 @@

Method Details

}, }, "masterAuth": { # The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. # The authentication information for accessing the master endpoint. If unspecified, the defaults are used: For clusters before v1.12, if master_auth is unspecified, `username` will be set to "admin", a random password will be generated, and a client certificate will be issued. - "clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. + "clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. "clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued. "issueClientCertificate": True or False, # Issue a client certificate. }, - "clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint. - "clusterCaCertificate": "A String", # [Output only] Base64-encoded public certificate that is the root of trust for the cluster. + "clientKey": "A String", # Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint. + "clusterCaCertificate": "A String", # Output only. Base64-encoded public certificate that is the root of trust for the cluster. "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication }, @@ -840,7 +840,7 @@

Method Details

"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running on the node pool. }, }, - "nodeIpv4CidrSize": 42, # [Output only] The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode. + "nodeIpv4CidrSize": 42, # Output only. The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode. "nodePoolAutoConfig": { # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. "networkTags": { # Collection of Compute Engine network tags that can be applied to a node's underlying VM instance. # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster creation. Each tag within the list must comply with RFC1035. "tags": [ # List of network tags. @@ -1071,7 +1071,7 @@

Method Details

}, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. @@ -1081,8 +1081,8 @@

Method Details

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered. "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool. @@ -1114,7 +1114,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -1122,14 +1122,14 @@

Method Details

"tpuTopology": "A String", # Optional. TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, - "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool. + "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, - "selfLink": "A String", # [Output only] Server-defined URL for the resource. - "status": "A String", # [Output only] The status of the nodes in this pool instance. - "statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. - "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. [Output only] Update info contains relevant information during a node pool update. + "selfLink": "A String", # Output only. Server-defined URL for the resource. + "status": "A String", # Output only. The status of the nodes in this pool instance. + "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. + "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. Update info contains relevant information during a node pool update. "blueGreenInfo": { # Information relevant to blue-green upgrade. # Information of a blue-green upgrade. "blueInstanceGroupUrls": [ # The resource URLs of the [managed instance groups] (/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with blue pool. "A String", @@ -1208,22 +1208,22 @@

Method Details

"mode": "A String", # Sets which mode to use for Security Posture features. "vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning. }, - "selfLink": "A String", # [Output only] Server-defined URL for the resource. - "servicesIpv4Cidr": "A String", # [Output only] The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR. + "selfLink": "A String", # Output only. Server-defined URL for the resource. + "servicesIpv4Cidr": "A String", # Output only. The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR. "shieldedNodes": { # Configuration of Shielded Nodes feature. # Shielded Nodes configuration. "enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster. }, - "status": "A String", # [Output only] The current status of this cluster. - "statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available. + "status": "A String", # Output only. The current status of this cluster. + "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available. "subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected. - "tpuIpv4CidrBlock": "A String", # [Output only] The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). + "tpuIpv4CidrBlock": "A String", # Output only. The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). "verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it. # Cluster-level Vertical Pod Autoscaling configuration. "enabled": True or False, # Enables vertical pod autoscaling. }, "workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to. }, - "zone": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. }, "parent": "A String", # The parent (project and location) where the cluster will be created. Specified in the format `projects/*/locations/*`. "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. @@ -1246,8 +1246,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -1257,8 +1257,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -1266,8 +1266,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -1282,12 +1282,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -1316,8 +1316,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -1327,8 +1327,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -1336,8 +1336,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -1352,12 +1352,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -1451,8 +1451,8 @@

Method Details

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered. "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. @@ -1506,10 +1506,10 @@

Method Details

"costManagementConfig": { # Configuration for fine-grained cost management feature. # Configuration for the fine-grained cost management feature. "enabled": True or False, # Whether the feature is enabled or not. }, - "createTime": "A String", # [Output only] The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "currentMasterVersion": "A String", # [Output only] The current software version of the master endpoint. - "currentNodeCount": 42, # [Output only] The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. - "currentNodeVersion": "A String", # [Output only] Deprecated, use [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. + "createTime": "A String", # Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "currentMasterVersion": "A String", # Output only. The current software version of the master endpoint. + "currentNodeCount": 42, # Output only. The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. + "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. "databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption. "currentState": "A String", # Output only. The current state of etcd encryption. "decryptionKeys": [ # Output only. Keys in use by the cluster for decrypting existing objects, in addition to the key in `key_name`. Each item is a CloudKMS key resource. @@ -1536,15 +1536,15 @@

Method Details

}, "enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1alpha1) and features that may not be production ready in the kubernetes version of the master and nodes. The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are automatically deleted thirty days after creation. "enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster. - "endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. + "endpoint": "A String", # Output only. The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. "enterpriseConfig": { # EnterpriseConfig is the cluster enterprise configuration. # GKE Enterprise Configuration. - "clusterTier": "A String", # Output only. [Output only] cluster_tier specifies the premium tier of the cluster. + "clusterTier": "A String", # Output only. cluster_tier specifies the premium tier of the cluster. }, "etag": "A String", # This checksum is computed by the server based on the value of cluster fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. - "expireTime": "A String", # [Output only] The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "expireTime": "A String", # Output only. The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "fleet": { # Fleet is the fleet configuration for the cluster. # Fleet information for the cluster. - "membership": "A String", # [Output only] The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`. - "preRegistered": True or False, # [Output only] Whether the cluster has been registered through the fleet API. + "membership": "A String", # Output only. The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`. + "preRegistered": True or False, # Output only. Whether the cluster has been registered through the fleet API. "project": "A String", # The Fleet host project(project ID or project number) where this cluster will be registered to. This field cannot be changed after the cluster has been registered. }, "id": "A String", # Output only. Unique id for the cluster. @@ -1553,15 +1553,15 @@

Method Details

}, "initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "","-": picks the default Kubernetes version "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead. - "instanceGroupUrls": [ # Deprecated. Use node_pools.instance_group_urls. + "instanceGroupUrls": [ # Output only. Deprecated. Use node_pools.instance_group_urls. "A String", ], "ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the cluster. # Configuration for cluster IP allocation. - "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # Output only. [Output only] The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy. - "podRangeInfo": [ # Output only. [Output only] Information for additional pod range. + "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # Output only. The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy. + "podRangeInfo": [ # Output only. Information for additional pod range. { # RangeInfo contains the range name and the range utilization by this cluster. - "rangeName": "A String", # Output only. [Output only] Name of a range. - "utilization": 3.14, # Output only. [Output only] The utilization of the range. + "rangeName": "A String", # Output only. Name of a range. + "utilization": 3.14, # Output only. The utilization of the range. }, ], "podRangeNames": [ # Name for pod secondary ipv4 range which has the actual range defined ahead. @@ -1572,7 +1572,7 @@

Method Details

"clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then `cluster.cluster_ipv4_cidr` must be left blank. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. "clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases is true and create_subnetwork is false. "createSubnetwork": True or False, # Whether a new subnetwork will be created automatically for the cluster. This field is only applicable when `use_ip_aliases` is true. - "defaultPodIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "defaultPodIpv4RangeUtilization": 3.14, # Output only. The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "ipv6AccessType": "A String", # The ipv6 access type (internal or external) when create_subnetwork is true "nodeIpv4Cidr": "A String", # This field is deprecated, use node_ipv4_cidr_block. "nodeIpv4CidrBlock": "A String", # The IP address range of the instance IPs in this cluster. This is applicable only if `create_subnetwork` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. @@ -1581,10 +1581,10 @@

Method Details

}, "servicesIpv4Cidr": "A String", # This field is deprecated, use services_ipv4_cidr_block. "servicesIpv4CidrBlock": "A String", # The IP address range of the services IPs in this cluster. If blank, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. - "servicesIpv6CidrBlock": "A String", # Output only. [Output only] The services IPv6 CIDR block for the cluster. + "servicesIpv6CidrBlock": "A String", # Output only. The services IPv6 CIDR block for the cluster. "servicesSecondaryRangeName": "A String", # The name of the secondary range to be used as for the services CIDR block. The secondary range will be used for service ClusterIPs. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases is true and create_subnetwork is false. "stackType": "A String", # The IP stack type of the cluster - "subnetIpv6CidrBlock": "A String", # Output only. [Output only] The subnet's IPv6 CIDR block used by nodes and pods. + "subnetIpv6CidrBlock": "A String", # Output only. The subnet's IPv6 CIDR block used by nodes and pods. "subnetworkName": "A String", # A custom subnetwork name to be used if `create_subnetwork` is true. If this field is empty, then an automatic name will be chosen for the new subnetwork. "tpuIpv4CidrBlock": "A String", # The IP address range of the Cloud TPUs in this cluster. If unspecified, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. If unspecified, the range will use the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. "useIpAliases": True or False, # Whether alias IPs will be used for pod IPs in the cluster. This is used in conjunction with use_routes. It cannot be true if use_routes is true. If both use_ip_aliases and use_routes are false, then the server picks the default IP allocation mode @@ -1594,7 +1594,7 @@

Method Details

"legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization mode. # Configuration for the legacy ABAC authorization mode. "enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed. "A String", ], @@ -1610,7 +1610,7 @@

Method Details

"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of the policy won't accidentally undo intermediate changes (and so that users of the API unaware of some fields won't accidentally remove other fields). Make a `get()` request to the cluster to get the current resource version and include it with requests to set the policy. "window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed. "dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window. - "duration": "A String", # [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "PTnHnMnS". + "duration": "A String", # Output only. Duration of the time window, automatically chosen to be smallest possible in the given scenario. Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "PTnHnMnS". "startTime": "A String", # Time within the maintenance window to start the maintenance operations. Time format should be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "HH:MM", where HH : [00-23] and MM : [00-59] GMT. }, "maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows. @@ -1635,12 +1635,12 @@

Method Details

}, }, "masterAuth": { # The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. # The authentication information for accessing the master endpoint. If unspecified, the defaults are used: For clusters before v1.12, if master_auth is unspecified, `username` will be set to "admin", a random password will be generated, and a client certificate will be issued. - "clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. + "clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. "clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued. "issueClientCertificate": True or False, # Issue a client certificate. }, - "clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint. - "clusterCaCertificate": "A String", # [Output only] Base64-encoded public certificate that is the root of trust for the cluster. + "clientKey": "A String", # Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint. + "clusterCaCertificate": "A String", # Output only. Base64-encoded public certificate that is the root of trust for the cluster. "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication }, @@ -1862,7 +1862,7 @@

Method Details

"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running on the node pool. }, }, - "nodeIpv4CidrSize": 42, # [Output only] The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode. + "nodeIpv4CidrSize": 42, # Output only. The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode. "nodePoolAutoConfig": { # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. "networkTags": { # Collection of Compute Engine network tags that can be applied to a node's underlying VM instance. # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster creation. Each tag within the list must comply with RFC1035. "tags": [ # List of network tags. @@ -2093,7 +2093,7 @@

Method Details

}, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. @@ -2103,8 +2103,8 @@

Method Details

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered. "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool. @@ -2136,7 +2136,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -2144,14 +2144,14 @@

Method Details

"tpuTopology": "A String", # Optional. TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, - "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool. + "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, - "selfLink": "A String", # [Output only] Server-defined URL for the resource. - "status": "A String", # [Output only] The status of the nodes in this pool instance. - "statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. - "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. [Output only] Update info contains relevant information during a node pool update. + "selfLink": "A String", # Output only. Server-defined URL for the resource. + "status": "A String", # Output only. The status of the nodes in this pool instance. + "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. + "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. Update info contains relevant information during a node pool update. "blueGreenInfo": { # Information relevant to blue-green upgrade. # Information of a blue-green upgrade. "blueInstanceGroupUrls": [ # The resource URLs of the [managed instance groups] (/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with blue pool. "A String", @@ -2230,22 +2230,22 @@

Method Details

"mode": "A String", # Sets which mode to use for Security Posture features. "vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning. }, - "selfLink": "A String", # [Output only] Server-defined URL for the resource. - "servicesIpv4Cidr": "A String", # [Output only] The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR. + "selfLink": "A String", # Output only. Server-defined URL for the resource. + "servicesIpv4Cidr": "A String", # Output only. The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR. "shieldedNodes": { # Configuration of Shielded Nodes feature. # Shielded Nodes configuration. "enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster. }, - "status": "A String", # [Output only] The current status of this cluster. - "statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available. + "status": "A String", # Output only. The current status of this cluster. + "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available. "subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected. - "tpuIpv4CidrBlock": "A String", # [Output only] The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). + "tpuIpv4CidrBlock": "A String", # Output only. The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). "verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it. # Cluster-level Vertical Pod Autoscaling configuration. "enabled": True or False, # Enables vertical pod autoscaling. }, "workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to. }, - "zone": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. } @@ -2284,8 +2284,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -2295,8 +2295,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -2304,8 +2304,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -2320,12 +2320,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -2420,8 +2420,8 @@

Method Details

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered. "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. @@ -2475,10 +2475,10 @@

Method Details

"costManagementConfig": { # Configuration for fine-grained cost management feature. # Configuration for the fine-grained cost management feature. "enabled": True or False, # Whether the feature is enabled or not. }, - "createTime": "A String", # [Output only] The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "currentMasterVersion": "A String", # [Output only] The current software version of the master endpoint. - "currentNodeCount": 42, # [Output only] The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. - "currentNodeVersion": "A String", # [Output only] Deprecated, use [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. + "createTime": "A String", # Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "currentMasterVersion": "A String", # Output only. The current software version of the master endpoint. + "currentNodeCount": 42, # Output only. The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. + "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. "databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption. "currentState": "A String", # Output only. The current state of etcd encryption. "decryptionKeys": [ # Output only. Keys in use by the cluster for decrypting existing objects, in addition to the key in `key_name`. Each item is a CloudKMS key resource. @@ -2505,15 +2505,15 @@

Method Details

}, "enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1alpha1) and features that may not be production ready in the kubernetes version of the master and nodes. The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are automatically deleted thirty days after creation. "enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster. - "endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. + "endpoint": "A String", # Output only. The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. "enterpriseConfig": { # EnterpriseConfig is the cluster enterprise configuration. # GKE Enterprise Configuration. - "clusterTier": "A String", # Output only. [Output only] cluster_tier specifies the premium tier of the cluster. + "clusterTier": "A String", # Output only. cluster_tier specifies the premium tier of the cluster. }, "etag": "A String", # This checksum is computed by the server based on the value of cluster fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. - "expireTime": "A String", # [Output only] The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "expireTime": "A String", # Output only. The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "fleet": { # Fleet is the fleet configuration for the cluster. # Fleet information for the cluster. - "membership": "A String", # [Output only] The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`. - "preRegistered": True or False, # [Output only] Whether the cluster has been registered through the fleet API. + "membership": "A String", # Output only. The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`. + "preRegistered": True or False, # Output only. Whether the cluster has been registered through the fleet API. "project": "A String", # The Fleet host project(project ID or project number) where this cluster will be registered to. This field cannot be changed after the cluster has been registered. }, "id": "A String", # Output only. Unique id for the cluster. @@ -2522,15 +2522,15 @@

Method Details

}, "initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "","-": picks the default Kubernetes version "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead. - "instanceGroupUrls": [ # Deprecated. Use node_pools.instance_group_urls. + "instanceGroupUrls": [ # Output only. Deprecated. Use node_pools.instance_group_urls. "A String", ], "ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the cluster. # Configuration for cluster IP allocation. - "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # Output only. [Output only] The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy. - "podRangeInfo": [ # Output only. [Output only] Information for additional pod range. + "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # Output only. The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy. + "podRangeInfo": [ # Output only. Information for additional pod range. { # RangeInfo contains the range name and the range utilization by this cluster. - "rangeName": "A String", # Output only. [Output only] Name of a range. - "utilization": 3.14, # Output only. [Output only] The utilization of the range. + "rangeName": "A String", # Output only. Name of a range. + "utilization": 3.14, # Output only. The utilization of the range. }, ], "podRangeNames": [ # Name for pod secondary ipv4 range which has the actual range defined ahead. @@ -2541,7 +2541,7 @@

Method Details

"clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then `cluster.cluster_ipv4_cidr` must be left blank. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. "clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases is true and create_subnetwork is false. "createSubnetwork": True or False, # Whether a new subnetwork will be created automatically for the cluster. This field is only applicable when `use_ip_aliases` is true. - "defaultPodIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "defaultPodIpv4RangeUtilization": 3.14, # Output only. The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "ipv6AccessType": "A String", # The ipv6 access type (internal or external) when create_subnetwork is true "nodeIpv4Cidr": "A String", # This field is deprecated, use node_ipv4_cidr_block. "nodeIpv4CidrBlock": "A String", # The IP address range of the instance IPs in this cluster. This is applicable only if `create_subnetwork` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. @@ -2550,10 +2550,10 @@

Method Details

}, "servicesIpv4Cidr": "A String", # This field is deprecated, use services_ipv4_cidr_block. "servicesIpv4CidrBlock": "A String", # The IP address range of the services IPs in this cluster. If blank, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. - "servicesIpv6CidrBlock": "A String", # Output only. [Output only] The services IPv6 CIDR block for the cluster. + "servicesIpv6CidrBlock": "A String", # Output only. The services IPv6 CIDR block for the cluster. "servicesSecondaryRangeName": "A String", # The name of the secondary range to be used as for the services CIDR block. The secondary range will be used for service ClusterIPs. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases is true and create_subnetwork is false. "stackType": "A String", # The IP stack type of the cluster - "subnetIpv6CidrBlock": "A String", # Output only. [Output only] The subnet's IPv6 CIDR block used by nodes and pods. + "subnetIpv6CidrBlock": "A String", # Output only. The subnet's IPv6 CIDR block used by nodes and pods. "subnetworkName": "A String", # A custom subnetwork name to be used if `create_subnetwork` is true. If this field is empty, then an automatic name will be chosen for the new subnetwork. "tpuIpv4CidrBlock": "A String", # The IP address range of the Cloud TPUs in this cluster. If unspecified, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. If unspecified, the range will use the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. "useIpAliases": True or False, # Whether alias IPs will be used for pod IPs in the cluster. This is used in conjunction with use_routes. It cannot be true if use_routes is true. If both use_ip_aliases and use_routes are false, then the server picks the default IP allocation mode @@ -2563,7 +2563,7 @@

Method Details

"legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization mode. # Configuration for the legacy ABAC authorization mode. "enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed. "A String", ], @@ -2579,7 +2579,7 @@

Method Details

"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of the policy won't accidentally undo intermediate changes (and so that users of the API unaware of some fields won't accidentally remove other fields). Make a `get()` request to the cluster to get the current resource version and include it with requests to set the policy. "window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed. "dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window. - "duration": "A String", # [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "PTnHnMnS". + "duration": "A String", # Output only. Duration of the time window, automatically chosen to be smallest possible in the given scenario. Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "PTnHnMnS". "startTime": "A String", # Time within the maintenance window to start the maintenance operations. Time format should be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "HH:MM", where HH : [00-23] and MM : [00-59] GMT. }, "maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows. @@ -2604,12 +2604,12 @@

Method Details

}, }, "masterAuth": { # The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. # The authentication information for accessing the master endpoint. If unspecified, the defaults are used: For clusters before v1.12, if master_auth is unspecified, `username` will be set to "admin", a random password will be generated, and a client certificate will be issued. - "clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. + "clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. "clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued. "issueClientCertificate": True or False, # Issue a client certificate. }, - "clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint. - "clusterCaCertificate": "A String", # [Output only] Base64-encoded public certificate that is the root of trust for the cluster. + "clientKey": "A String", # Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint. + "clusterCaCertificate": "A String", # Output only. Base64-encoded public certificate that is the root of trust for the cluster. "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication }, @@ -2831,7 +2831,7 @@

Method Details

"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running on the node pool. }, }, - "nodeIpv4CidrSize": 42, # [Output only] The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode. + "nodeIpv4CidrSize": 42, # Output only. The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode. "nodePoolAutoConfig": { # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. "networkTags": { # Collection of Compute Engine network tags that can be applied to a node's underlying VM instance. # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster creation. Each tag within the list must comply with RFC1035. "tags": [ # List of network tags. @@ -3062,7 +3062,7 @@

Method Details

}, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. @@ -3072,8 +3072,8 @@

Method Details

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered. "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool. @@ -3105,7 +3105,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -3113,14 +3113,14 @@

Method Details

"tpuTopology": "A String", # Optional. TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, - "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool. + "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, - "selfLink": "A String", # [Output only] Server-defined URL for the resource. - "status": "A String", # [Output only] The status of the nodes in this pool instance. - "statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. - "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. [Output only] Update info contains relevant information during a node pool update. + "selfLink": "A String", # Output only. Server-defined URL for the resource. + "status": "A String", # Output only. The status of the nodes in this pool instance. + "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. + "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. Update info contains relevant information during a node pool update. "blueGreenInfo": { # Information relevant to blue-green upgrade. # Information of a blue-green upgrade. "blueInstanceGroupUrls": [ # The resource URLs of the [managed instance groups] (/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with blue pool. "A String", @@ -3199,22 +3199,22 @@

Method Details

"mode": "A String", # Sets which mode to use for Security Posture features. "vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning. }, - "selfLink": "A String", # [Output only] Server-defined URL for the resource. - "servicesIpv4Cidr": "A String", # [Output only] The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR. + "selfLink": "A String", # Output only. Server-defined URL for the resource. + "servicesIpv4Cidr": "A String", # Output only. The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR. "shieldedNodes": { # Configuration of Shielded Nodes feature. # Shielded Nodes configuration. "enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster. }, - "status": "A String", # [Output only] The current status of this cluster. - "statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available. + "status": "A String", # Output only. The current status of this cluster. + "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available. "subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected. - "tpuIpv4CidrBlock": "A String", # [Output only] The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). + "tpuIpv4CidrBlock": "A String", # Output only. The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). "verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it. # Cluster-level Vertical Pod Autoscaling configuration. "enabled": True or False, # Enables vertical pod autoscaling. }, "workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to. }, - "zone": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. }, ], "missingZones": [ # If any zones are listed here, the list of clusters returned may be missing those zones. @@ -3260,8 +3260,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -3271,8 +3271,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -3280,8 +3280,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -3296,12 +3296,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -3340,8 +3340,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -3351,8 +3351,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -3360,8 +3360,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -3376,12 +3376,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -3420,8 +3420,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -3431,8 +3431,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -3440,8 +3440,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -3456,12 +3456,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -3500,8 +3500,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -3511,8 +3511,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -3520,8 +3520,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -3536,12 +3536,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -3583,8 +3583,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -3594,8 +3594,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -3603,8 +3603,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -3619,12 +3619,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -3645,7 +3645,7 @@

Method Details

"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of the policy won't accidentally undo intermediate changes (and so that users of the API unaware of some fields won't accidentally remove other fields). Make a `get()` request to the cluster to get the current resource version and include it with requests to set the policy. "window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed. "dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window. - "duration": "A String", # [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "PTnHnMnS". + "duration": "A String", # Output only. Duration of the time window, automatically chosen to be smallest possible in the given scenario. Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "PTnHnMnS". "startTime": "A String", # Time within the maintenance window to start the maintenance operations. Time format should be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "HH:MM", where HH : [00-23] and MM : [00-59] GMT. }, "maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows. @@ -3690,8 +3690,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -3701,8 +3701,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -3710,8 +3710,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -3726,12 +3726,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -3752,12 +3752,12 @@

Method Details

"name": "A String", # The name (project, location, cluster) of the cluster to set auth. Specified in the format `projects/*/locations/*/clusters/*`. "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. "update": { # The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. # Required. A description of the update. - "clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. + "clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. "clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued. "issueClientCertificate": True or False, # Issue a client certificate. }, - "clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint. - "clusterCaCertificate": "A String", # [Output only] Base64-encoded public certificate that is the root of trust for the cluster. + "clientKey": "A String", # Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint. + "clusterCaCertificate": "A String", # Output only. Base64-encoded public certificate that is the root of trust for the cluster. "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication }, @@ -3780,8 +3780,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -3791,8 +3791,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -3800,8 +3800,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -3816,12 +3816,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -3863,8 +3863,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -3874,8 +3874,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -3883,8 +3883,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -3899,12 +3899,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -3943,8 +3943,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -3954,8 +3954,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -3963,8 +3963,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -3979,12 +3979,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -4005,10 +4005,10 @@

Method Details

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. "update": { # ClusterUpdate describes an update to the cluster. Exactly one update can be applied to a cluster with each request, so at most one field can be provided. # Required. A description of the update. "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # The additional pod ranges to be added to the cluster. These pod ranges can be used by node pools to allocate pod IPs. - "podRangeInfo": [ # Output only. [Output only] Information for additional pod range. + "podRangeInfo": [ # Output only. Information for additional pod range. { # RangeInfo contains the range name and the range utilization by this cluster. - "rangeName": "A String", # Output only. [Output only] Name of a range. - "utilization": 3.14, # Output only. [Output only] The utilization of the range. + "rangeName": "A String", # Output only. Name of a range. + "utilization": 3.14, # Output only. The utilization of the range. }, ], "podRangeNames": [ # Name for pod secondary ipv4 range which has the actual range defined ahead. @@ -4088,8 +4088,8 @@

Method Details

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered. "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. @@ -4173,8 +4173,8 @@

Method Details

"desiredEnableMultiNetworking": True or False, # Enable/Disable Multi-Networking for the cluster "desiredEnablePrivateEndpoint": True or False, # Enable/Disable private endpoint for the cluster's master. "desiredFleet": { # Fleet is the fleet configuration for the cluster. # The desired fleet configuration for the cluster. - "membership": "A String", # [Output only] The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`. - "preRegistered": True or False, # [Output only] Whether the cluster has been registered through the fleet API. + "membership": "A String", # Output only. The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`. + "preRegistered": True or False, # Output only. Whether the cluster has been registered through the fleet API. "project": "A String", # The Fleet host project(project ID or project number) where this cluster will be registered to. This field cannot be changed after the cluster has been registered. }, "desiredGatewayApiConfig": { # GatewayAPIConfig contains the desired config of Gateway API on this cluster. # The desired config of Gateway API on this cluster. @@ -4349,10 +4349,10 @@

Method Details

}, "etag": "A String", # The current etag of the cluster. If an etag is provided and does not match the current etag of the cluster, update will be blocked and an ABORTED error will be returned. "removedAdditionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # The additional pod ranges that are to be removed from the cluster. The pod ranges specified here must have been specified earlier in the 'additional_pod_ranges_config' argument. - "podRangeInfo": [ # Output only. [Output only] Information for additional pod range. + "podRangeInfo": [ # Output only. Information for additional pod range. { # RangeInfo contains the range name and the range utilization by this cluster. - "rangeName": "A String", # Output only. [Output only] Name of a range. - "utilization": 3.14, # Output only. [Output only] The utilization of the range. + "rangeName": "A String", # Output only. Name of a range. + "utilization": 3.14, # Output only. The utilization of the range. }, ], "podRangeNames": [ # Name for pod secondary ipv4 range which has the actual range defined ahead. @@ -4379,8 +4379,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -4390,8 +4390,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -4399,8 +4399,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -4415,12 +4415,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } diff --git a/docs/dyn/container_v1.projects.zones.clusters.nodePools.html b/docs/dyn/container_v1.projects.zones.clusters.nodePools.html index 228b0101ff4..f31b1d958b5 100644 --- a/docs/dyn/container_v1.projects.zones.clusters.nodePools.html +++ b/docs/dyn/container_v1.projects.zones.clusters.nodePools.html @@ -150,8 +150,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -161,8 +161,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -170,8 +170,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -186,12 +186,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -389,7 +389,7 @@

Method Details

}, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. @@ -399,8 +399,8 @@

Method Details

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered. "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool. @@ -432,7 +432,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -440,14 +440,14 @@

Method Details

"tpuTopology": "A String", # Optional. TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, - "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool. + "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, - "selfLink": "A String", # [Output only] Server-defined URL for the resource. - "status": "A String", # [Output only] The status of the nodes in this pool instance. - "statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. - "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. [Output only] Update info contains relevant information during a node pool update. + "selfLink": "A String", # Output only. Server-defined URL for the resource. + "status": "A String", # Output only. The status of the nodes in this pool instance. + "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. + "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. Update info contains relevant information during a node pool update. "blueGreenInfo": { # Information relevant to blue-green upgrade. # Information of a blue-green upgrade. "blueInstanceGroupUrls": [ # The resource URLs of the [managed instance groups] (/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with blue pool. "A String", @@ -496,8 +496,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -507,8 +507,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -516,8 +516,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -532,12 +532,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -567,8 +567,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -578,8 +578,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -587,8 +587,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -603,12 +603,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -806,7 +806,7 @@

Method Details

}, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. @@ -816,8 +816,8 @@

Method Details

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered. "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool. @@ -849,7 +849,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -857,14 +857,14 @@

Method Details

"tpuTopology": "A String", # Optional. TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, - "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool. + "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, - "selfLink": "A String", # [Output only] Server-defined URL for the resource. - "status": "A String", # [Output only] The status of the nodes in this pool instance. - "statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. - "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. [Output only] Update info contains relevant information during a node pool update. + "selfLink": "A String", # Output only. Server-defined URL for the resource. + "status": "A String", # Output only. The status of the nodes in this pool instance. + "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. + "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. Update info contains relevant information during a node pool update. "blueGreenInfo": { # Information relevant to blue-green upgrade. # Information of a blue-green upgrade. "blueInstanceGroupUrls": [ # The resource URLs of the [managed instance groups] (/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with blue pool. "A String", @@ -1089,7 +1089,7 @@

Method Details

}, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. @@ -1099,8 +1099,8 @@

Method Details

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered. "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool. @@ -1132,7 +1132,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -1140,14 +1140,14 @@

Method Details

"tpuTopology": "A String", # Optional. TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, - "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool. + "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, - "selfLink": "A String", # [Output only] Server-defined URL for the resource. - "status": "A String", # [Output only] The status of the nodes in this pool instance. - "statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. - "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. [Output only] Update info contains relevant information during a node pool update. + "selfLink": "A String", # Output only. Server-defined URL for the resource. + "status": "A String", # Output only. The status of the nodes in this pool instance. + "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. + "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. Update info contains relevant information during a node pool update. "blueGreenInfo": { # Information relevant to blue-green upgrade. # Information of a blue-green upgrade. "blueInstanceGroupUrls": [ # The resource URLs of the [managed instance groups] (/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with blue pool. "A String", @@ -1216,8 +1216,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -1227,8 +1227,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -1236,8 +1236,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -1252,12 +1252,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -1279,8 +1279,8 @@

Method Details

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered. "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "name": "A String", # The name (project, location, cluster, node pool id) of the node pool to set management properties. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. @@ -1305,8 +1305,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -1316,8 +1316,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -1325,8 +1325,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -1341,12 +1341,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -1387,8 +1387,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -1398,8 +1398,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -1407,8 +1407,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -1423,12 +1423,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -1548,7 +1548,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "nodePoolId": "A String", # Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. @@ -1619,8 +1619,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -1630,8 +1630,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -1639,8 +1639,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -1655,12 +1655,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } diff --git a/docs/dyn/container_v1.projects.zones.operations.html b/docs/dyn/container_v1.projects.zones.operations.html index da587481a06..ba1fa70d5f9 100644 --- a/docs/dyn/container_v1.projects.zones.operations.html +++ b/docs/dyn/container_v1.projects.zones.operations.html @@ -147,8 +147,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -158,8 +158,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -167,8 +167,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -183,12 +183,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -221,8 +221,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -232,8 +232,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -241,8 +241,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -257,12 +257,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }, ], } diff --git a/docs/dyn/container_v1beta1.projects.locations.clusters.html b/docs/dyn/container_v1beta1.projects.locations.clusters.html index 8330b06f737..d07e8a99e5f 100644 --- a/docs/dyn/container_v1beta1.projects.locations.clusters.html +++ b/docs/dyn/container_v1beta1.projects.locations.clusters.html @@ -213,8 +213,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -224,8 +224,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -233,8 +233,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -249,12 +249,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -351,8 +351,8 @@

Method Details

"autoRepair": True or False, # Whether the nodes will be automatically repaired. "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. @@ -424,10 +424,10 @@

Method Details

"costManagementConfig": { # Configuration for fine-grained cost management feature. # Configuration for the fine-grained cost management feature. "enabled": True or False, # Whether the feature is enabled or not. }, - "createTime": "A String", # [Output only] The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "currentMasterVersion": "A String", # [Output only] The current software version of the master endpoint. - "currentNodeCount": 42, # [Output only] The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. - "currentNodeVersion": "A String", # [Output only] Deprecated, use [NodePool.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. + "createTime": "A String", # Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "currentMasterVersion": "A String", # Output only. The current software version of the master endpoint. + "currentNodeCount": 42, # Output only. The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. + "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePool.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. "databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption. "currentState": "A String", # Output only. The current state of etcd encryption. "decryptionKeys": [ # Output only. Keys in use by the cluster for decrypting existing objects, in addition to the key in `key_name`. Each item is a CloudKMS key resource. @@ -454,15 +454,15 @@

Method Details

}, "enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1beta1) and features that may not be production ready in the kubernetes version of the master and nodes. The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are automatically deleted thirty days after creation. "enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster. This field is deprecated, use tpu_config.enabled instead. - "endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. + "endpoint": "A String", # Output only. The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. "enterpriseConfig": { # EnterpriseConfig is the cluster enterprise configuration. # GKE Enterprise Configuration. - "clusterTier": "A String", # Output only. [Output only] cluster_tier specifies the premium tier of the cluster. + "clusterTier": "A String", # Output only. cluster_tier specifies the premium tier of the cluster. }, "etag": "A String", # This checksum is computed by the server based on the value of cluster fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. - "expireTime": "A String", # [Output only] The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "expireTime": "A String", # Output only. The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "fleet": { # Fleet is the fleet configuration for the cluster. # Fleet information for the cluster. - "membership": "A String", # [Output only] The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`. - "preRegistered": True or False, # [Output only] Whether the cluster has been registered through the fleet API. + "membership": "A String", # Output only. The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`. + "preRegistered": True or False, # Output only. Whether the cluster has been registered through the fleet API. "project": "A String", # The Fleet host project(project ID or project number) where this cluster will be registered to. This field cannot be changed after the cluster has been registered. }, "id": "A String", # Output only. Unique id for the cluster. @@ -471,15 +471,15 @@

Method Details

}, "initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "","-": picks the default Kubernetes version "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead. - "instanceGroupUrls": [ # Deprecated. Use node_pools.instance_group_urls. + "instanceGroupUrls": [ # Output only. Deprecated. Use node_pools.instance_group_urls. "A String", ], "ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the cluster. # Configuration for cluster IP allocation. - "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # Output only. [Output only] The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy. - "podRangeInfo": [ # Output only. [Output only] Information for additional pod range. + "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # Output only. The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy. + "podRangeInfo": [ # Output only. Information for additional pod range. { # RangeInfo contains the range name and the range utilization by this cluster. - "rangeName": "A String", # Output only. [Output only] Name of a range. - "utilization": 3.14, # Output only. [Output only] The utilization of the range. + "rangeName": "A String", # Output only. Name of a range. + "utilization": 3.14, # Output only. The utilization of the range. }, ], "podRangeNames": [ # Name for pod secondary ipv4 range which has the actual range defined ahead. @@ -491,7 +491,7 @@

Method Details

"clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then `cluster.cluster_ipv4_cidr` must be left blank. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. "clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases and create_subnetwork is false. "createSubnetwork": True or False, # Whether a new subnetwork will be created automatically for the cluster. This field is only applicable when `use_ip_aliases` is true. - "defaultPodIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "defaultPodIpv4RangeUtilization": 3.14, # Output only. The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "ipv6AccessType": "A String", # The ipv6 access type (internal or external) when create_subnetwork is true "nodeIpv4Cidr": "A String", # This field is deprecated, use node_ipv4_cidr_block. "nodeIpv4CidrBlock": "A String", # The IP address range of the instance IPs in this cluster. This is applicable only if `create_subnetwork` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. @@ -500,10 +500,10 @@

Method Details

}, "servicesIpv4Cidr": "A String", # This field is deprecated, use services_ipv4_cidr_block. "servicesIpv4CidrBlock": "A String", # The IP address range of the services IPs in this cluster. If blank, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. - "servicesIpv6CidrBlock": "A String", # Output only. [Output only] The services IPv6 CIDR block for the cluster. + "servicesIpv6CidrBlock": "A String", # Output only. The services IPv6 CIDR block for the cluster. "servicesSecondaryRangeName": "A String", # The name of the secondary range to be used as for the services CIDR block. The secondary range will be used for service ClusterIPs. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases and create_subnetwork is false. "stackType": "A String", # IP stack type - "subnetIpv6CidrBlock": "A String", # Output only. [Output only] The subnet's IPv6 CIDR block used by nodes and pods. + "subnetIpv6CidrBlock": "A String", # Output only. The subnet's IPv6 CIDR block used by nodes and pods. "subnetworkName": "A String", # A custom subnetwork name to be used if `create_subnetwork` is true. If this field is empty, then an automatic name will be chosen for the new subnetwork. "tpuIpv4CidrBlock": "A String", # The IP address range of the Cloud TPUs in this cluster. If unspecified, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. If unspecified, the range will use the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. This field is deprecated, use cluster.tpu_config.ipv4_cidr_block instead. "useIpAliases": True or False, # Whether alias IPs will be used for pod IPs in the cluster. This is used in conjunction with use_routes. It cannot be true if use_routes is true. If both use_ip_aliases and use_routes are false, then the server picks the default IP allocation mode @@ -513,7 +513,7 @@

Method Details

"legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization mode. # Configuration for the legacy ABAC authorization mode. "enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed. "A String", ], @@ -529,7 +529,7 @@

Method Details

"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of the policy won't accidentally undo intermediate changes (and so that users of the API unaware of some fields won't accidentally remove other fields). Make a `get()` request to the cluster to get the current resource version and include it with requests to set the policy. "window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed. "dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window. - "duration": "A String", # [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. + "duration": "A String", # Output only. Duration of the time window, automatically chosen to be smallest possible in the given scenario. "startTime": "A String", # Time within the maintenance window to start the maintenance operations. It must be in format "HH:MM", where HH : [00-23] and MM : [00-59] GMT. }, "maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows. @@ -556,12 +556,12 @@

Method Details

"master": { # Master is the configuration for components on master. # Configuration for master components. }, "masterAuth": { # The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. # The authentication information for accessing the master endpoint. If unspecified, the defaults are used: For clusters before v1.12, if master_auth is unspecified, `username` will be set to "admin", a random password will be generated, and a client certificate will be issued. - "clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. + "clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. "clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued. "issueClientCertificate": True or False, # Issue a client certificate. }, - "clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint. - "clusterCaCertificate": "A String", + "clientKey": "A String", # Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint. + "clusterCaCertificate": "A String", # Output only. Base64-encoded public certificate that is the root of trust for the cluster. "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication }, @@ -798,7 +798,7 @@

Method Details

"nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the workloads running on the node. }, }, - "nodeIpv4CidrSize": 42, # [Output only] The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode. + "nodeIpv4CidrSize": 42, # Output only. The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode. "nodePoolAutoConfig": { # node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. "networkTags": { # Collection of Compute Engine network tags that can be applied to a node's underlying VM instance. (See `tags` field in [`NodeConfig`](/kubernetes-engine/docs/reference/rest/v1/NodeConfig)). # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster creation. Each tag within the list must comply with RFC1035. "tags": [ # List of network tags. @@ -1051,7 +1051,7 @@

Method Details

}, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. @@ -1061,8 +1061,8 @@

Method Details

"autoRepair": True or False, # Whether the nodes will be automatically repaired. "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool. @@ -1095,7 +1095,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -1103,14 +1103,14 @@

Method Details

"tpuTopology": "A String", # TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, - "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool. + "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, - "selfLink": "A String", # [Output only] Server-defined URL for the resource. - "status": "A String", # [Output only] The status of the nodes in this pool instance. - "statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. - "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. [Output only] Update info contains relevant information during a node pool update. + "selfLink": "A String", # Output only. Server-defined URL for the resource. + "status": "A String", # Output only. The status of the nodes in this pool instance. + "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. + "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. Update info contains relevant information during a node pool update. "blueGreenInfo": { # Information relevant to blue-green upgrade. # Information of a blue-green upgrade. "blueInstanceGroupUrls": [ # The resource URLs of the [managed instance groups] (/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with blue pool. "A String", @@ -1204,20 +1204,20 @@

Method Details

"mode": "A String", # Sets which mode to use for Security Posture features. "vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning. }, - "selfLink": "A String", # [Output only] Server-defined URL for the resource. - "servicesIpv4Cidr": "A String", # [Output only] The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR. + "selfLink": "A String", # Output only. Server-defined URL for the resource. + "servicesIpv4Cidr": "A String", # Output only. The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR. "shieldedNodes": { # Configuration of Shielded Nodes feature. # Shielded Nodes configuration. "enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster. }, - "status": "A String", # [Output only] The current status of this cluster. - "statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available. + "status": "A String", # Output only. The current status of this cluster. + "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available. "subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected. On output this shows the subnetwork ID instead of the name. "tpuConfig": { # Configuration for Cloud TPU. # Configuration for Cloud TPU support; "enabled": True or False, # Whether Cloud TPU integration is enabled or not. "ipv4CidrBlock": "A String", # IPv4 CIDR block reserved for Cloud TPU in the VPC. "useServiceNetworking": True or False, # Whether to use service networking for Cloud TPU or not. }, - "tpuIpv4CidrBlock": "A String", # [Output only] The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). + "tpuIpv4CidrBlock": "A String", # Output only. The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). "verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it. # Cluster-level Vertical Pod Autoscaling configuration. "enabled": True or False, # Enables vertical pod autoscaling. }, @@ -1232,7 +1232,7 @@

Method Details

"identityProvider": "A String", # identity provider is the third party identity provider. "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to. }, - "zone": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. }, "parent": "A String", # The parent (project and location) where the cluster will be created. Specified in the format `projects/*/locations/*`. "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. @@ -1255,8 +1255,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -1266,8 +1266,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -1275,8 +1275,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -1291,12 +1291,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -1325,8 +1325,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -1336,8 +1336,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -1345,8 +1345,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -1361,12 +1361,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -1470,8 +1470,8 @@

Method Details

"autoRepair": True or False, # Whether the nodes will be automatically repaired. "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. @@ -1543,10 +1543,10 @@

Method Details

"costManagementConfig": { # Configuration for fine-grained cost management feature. # Configuration for the fine-grained cost management feature. "enabled": True or False, # Whether the feature is enabled or not. }, - "createTime": "A String", # [Output only] The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "currentMasterVersion": "A String", # [Output only] The current software version of the master endpoint. - "currentNodeCount": 42, # [Output only] The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. - "currentNodeVersion": "A String", # [Output only] Deprecated, use [NodePool.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. + "createTime": "A String", # Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "currentMasterVersion": "A String", # Output only. The current software version of the master endpoint. + "currentNodeCount": 42, # Output only. The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. + "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePool.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. "databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption. "currentState": "A String", # Output only. The current state of etcd encryption. "decryptionKeys": [ # Output only. Keys in use by the cluster for decrypting existing objects, in addition to the key in `key_name`. Each item is a CloudKMS key resource. @@ -1573,15 +1573,15 @@

Method Details

}, "enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1beta1) and features that may not be production ready in the kubernetes version of the master and nodes. The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are automatically deleted thirty days after creation. "enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster. This field is deprecated, use tpu_config.enabled instead. - "endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. + "endpoint": "A String", # Output only. The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. "enterpriseConfig": { # EnterpriseConfig is the cluster enterprise configuration. # GKE Enterprise Configuration. - "clusterTier": "A String", # Output only. [Output only] cluster_tier specifies the premium tier of the cluster. + "clusterTier": "A String", # Output only. cluster_tier specifies the premium tier of the cluster. }, "etag": "A String", # This checksum is computed by the server based on the value of cluster fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. - "expireTime": "A String", # [Output only] The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "expireTime": "A String", # Output only. The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "fleet": { # Fleet is the fleet configuration for the cluster. # Fleet information for the cluster. - "membership": "A String", # [Output only] The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`. - "preRegistered": True or False, # [Output only] Whether the cluster has been registered through the fleet API. + "membership": "A String", # Output only. The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`. + "preRegistered": True or False, # Output only. Whether the cluster has been registered through the fleet API. "project": "A String", # The Fleet host project(project ID or project number) where this cluster will be registered to. This field cannot be changed after the cluster has been registered. }, "id": "A String", # Output only. Unique id for the cluster. @@ -1590,15 +1590,15 @@

Method Details

}, "initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "","-": picks the default Kubernetes version "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead. - "instanceGroupUrls": [ # Deprecated. Use node_pools.instance_group_urls. + "instanceGroupUrls": [ # Output only. Deprecated. Use node_pools.instance_group_urls. "A String", ], "ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the cluster. # Configuration for cluster IP allocation. - "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # Output only. [Output only] The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy. - "podRangeInfo": [ # Output only. [Output only] Information for additional pod range. + "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # Output only. The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy. + "podRangeInfo": [ # Output only. Information for additional pod range. { # RangeInfo contains the range name and the range utilization by this cluster. - "rangeName": "A String", # Output only. [Output only] Name of a range. - "utilization": 3.14, # Output only. [Output only] The utilization of the range. + "rangeName": "A String", # Output only. Name of a range. + "utilization": 3.14, # Output only. The utilization of the range. }, ], "podRangeNames": [ # Name for pod secondary ipv4 range which has the actual range defined ahead. @@ -1610,7 +1610,7 @@

Method Details

"clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then `cluster.cluster_ipv4_cidr` must be left blank. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. "clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases and create_subnetwork is false. "createSubnetwork": True or False, # Whether a new subnetwork will be created automatically for the cluster. This field is only applicable when `use_ip_aliases` is true. - "defaultPodIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "defaultPodIpv4RangeUtilization": 3.14, # Output only. The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "ipv6AccessType": "A String", # The ipv6 access type (internal or external) when create_subnetwork is true "nodeIpv4Cidr": "A String", # This field is deprecated, use node_ipv4_cidr_block. "nodeIpv4CidrBlock": "A String", # The IP address range of the instance IPs in this cluster. This is applicable only if `create_subnetwork` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. @@ -1619,10 +1619,10 @@

Method Details

}, "servicesIpv4Cidr": "A String", # This field is deprecated, use services_ipv4_cidr_block. "servicesIpv4CidrBlock": "A String", # The IP address range of the services IPs in this cluster. If blank, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. - "servicesIpv6CidrBlock": "A String", # Output only. [Output only] The services IPv6 CIDR block for the cluster. + "servicesIpv6CidrBlock": "A String", # Output only. The services IPv6 CIDR block for the cluster. "servicesSecondaryRangeName": "A String", # The name of the secondary range to be used as for the services CIDR block. The secondary range will be used for service ClusterIPs. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases and create_subnetwork is false. "stackType": "A String", # IP stack type - "subnetIpv6CidrBlock": "A String", # Output only. [Output only] The subnet's IPv6 CIDR block used by nodes and pods. + "subnetIpv6CidrBlock": "A String", # Output only. The subnet's IPv6 CIDR block used by nodes and pods. "subnetworkName": "A String", # A custom subnetwork name to be used if `create_subnetwork` is true. If this field is empty, then an automatic name will be chosen for the new subnetwork. "tpuIpv4CidrBlock": "A String", # The IP address range of the Cloud TPUs in this cluster. If unspecified, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. If unspecified, the range will use the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. This field is deprecated, use cluster.tpu_config.ipv4_cidr_block instead. "useIpAliases": True or False, # Whether alias IPs will be used for pod IPs in the cluster. This is used in conjunction with use_routes. It cannot be true if use_routes is true. If both use_ip_aliases and use_routes are false, then the server picks the default IP allocation mode @@ -1632,7 +1632,7 @@

Method Details

"legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization mode. # Configuration for the legacy ABAC authorization mode. "enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed. "A String", ], @@ -1648,7 +1648,7 @@

Method Details

"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of the policy won't accidentally undo intermediate changes (and so that users of the API unaware of some fields won't accidentally remove other fields). Make a `get()` request to the cluster to get the current resource version and include it with requests to set the policy. "window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed. "dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window. - "duration": "A String", # [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. + "duration": "A String", # Output only. Duration of the time window, automatically chosen to be smallest possible in the given scenario. "startTime": "A String", # Time within the maintenance window to start the maintenance operations. It must be in format "HH:MM", where HH : [00-23] and MM : [00-59] GMT. }, "maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows. @@ -1675,12 +1675,12 @@

Method Details

"master": { # Master is the configuration for components on master. # Configuration for master components. }, "masterAuth": { # The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. # The authentication information for accessing the master endpoint. If unspecified, the defaults are used: For clusters before v1.12, if master_auth is unspecified, `username` will be set to "admin", a random password will be generated, and a client certificate will be issued. - "clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. + "clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. "clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued. "issueClientCertificate": True or False, # Issue a client certificate. }, - "clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint. - "clusterCaCertificate": "A String", + "clientKey": "A String", # Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint. + "clusterCaCertificate": "A String", # Output only. Base64-encoded public certificate that is the root of trust for the cluster. "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication }, @@ -1917,7 +1917,7 @@

Method Details

"nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the workloads running on the node. }, }, - "nodeIpv4CidrSize": 42, # [Output only] The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode. + "nodeIpv4CidrSize": 42, # Output only. The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode. "nodePoolAutoConfig": { # node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. "networkTags": { # Collection of Compute Engine network tags that can be applied to a node's underlying VM instance. (See `tags` field in [`NodeConfig`](/kubernetes-engine/docs/reference/rest/v1/NodeConfig)). # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster creation. Each tag within the list must comply with RFC1035. "tags": [ # List of network tags. @@ -2170,7 +2170,7 @@

Method Details

}, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. @@ -2180,8 +2180,8 @@

Method Details

"autoRepair": True or False, # Whether the nodes will be automatically repaired. "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool. @@ -2214,7 +2214,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -2222,14 +2222,14 @@

Method Details

"tpuTopology": "A String", # TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, - "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool. + "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, - "selfLink": "A String", # [Output only] Server-defined URL for the resource. - "status": "A String", # [Output only] The status of the nodes in this pool instance. - "statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. - "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. [Output only] Update info contains relevant information during a node pool update. + "selfLink": "A String", # Output only. Server-defined URL for the resource. + "status": "A String", # Output only. The status of the nodes in this pool instance. + "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. + "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. Update info contains relevant information during a node pool update. "blueGreenInfo": { # Information relevant to blue-green upgrade. # Information of a blue-green upgrade. "blueInstanceGroupUrls": [ # The resource URLs of the [managed instance groups] (/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with blue pool. "A String", @@ -2323,20 +2323,20 @@

Method Details

"mode": "A String", # Sets which mode to use for Security Posture features. "vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning. }, - "selfLink": "A String", # [Output only] Server-defined URL for the resource. - "servicesIpv4Cidr": "A String", # [Output only] The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR. + "selfLink": "A String", # Output only. Server-defined URL for the resource. + "servicesIpv4Cidr": "A String", # Output only. The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR. "shieldedNodes": { # Configuration of Shielded Nodes feature. # Shielded Nodes configuration. "enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster. }, - "status": "A String", # [Output only] The current status of this cluster. - "statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available. + "status": "A String", # Output only. The current status of this cluster. + "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available. "subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected. On output this shows the subnetwork ID instead of the name. "tpuConfig": { # Configuration for Cloud TPU. # Configuration for Cloud TPU support; "enabled": True or False, # Whether Cloud TPU integration is enabled or not. "ipv4CidrBlock": "A String", # IPv4 CIDR block reserved for Cloud TPU in the VPC. "useServiceNetworking": True or False, # Whether to use service networking for Cloud TPU or not. }, - "tpuIpv4CidrBlock": "A String", # [Output only] The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). + "tpuIpv4CidrBlock": "A String", # Output only. The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). "verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it. # Cluster-level Vertical Pod Autoscaling configuration. "enabled": True or False, # Enables vertical pod autoscaling. }, @@ -2351,7 +2351,7 @@

Method Details

"identityProvider": "A String", # identity provider is the third party identity provider. "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to. }, - "zone": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. } @@ -2492,8 +2492,8 @@

Method Details

"autoRepair": True or False, # Whether the nodes will be automatically repaired. "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. @@ -2565,10 +2565,10 @@

Method Details

"costManagementConfig": { # Configuration for fine-grained cost management feature. # Configuration for the fine-grained cost management feature. "enabled": True or False, # Whether the feature is enabled or not. }, - "createTime": "A String", # [Output only] The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "currentMasterVersion": "A String", # [Output only] The current software version of the master endpoint. - "currentNodeCount": 42, # [Output only] The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. - "currentNodeVersion": "A String", # [Output only] Deprecated, use [NodePool.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. + "createTime": "A String", # Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "currentMasterVersion": "A String", # Output only. The current software version of the master endpoint. + "currentNodeCount": 42, # Output only. The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. + "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePool.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. "databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption. "currentState": "A String", # Output only. The current state of etcd encryption. "decryptionKeys": [ # Output only. Keys in use by the cluster for decrypting existing objects, in addition to the key in `key_name`. Each item is a CloudKMS key resource. @@ -2595,15 +2595,15 @@

Method Details

}, "enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1beta1) and features that may not be production ready in the kubernetes version of the master and nodes. The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are automatically deleted thirty days after creation. "enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster. This field is deprecated, use tpu_config.enabled instead. - "endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. + "endpoint": "A String", # Output only. The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. "enterpriseConfig": { # EnterpriseConfig is the cluster enterprise configuration. # GKE Enterprise Configuration. - "clusterTier": "A String", # Output only. [Output only] cluster_tier specifies the premium tier of the cluster. + "clusterTier": "A String", # Output only. cluster_tier specifies the premium tier of the cluster. }, "etag": "A String", # This checksum is computed by the server based on the value of cluster fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. - "expireTime": "A String", # [Output only] The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "expireTime": "A String", # Output only. The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "fleet": { # Fleet is the fleet configuration for the cluster. # Fleet information for the cluster. - "membership": "A String", # [Output only] The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`. - "preRegistered": True or False, # [Output only] Whether the cluster has been registered through the fleet API. + "membership": "A String", # Output only. The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`. + "preRegistered": True or False, # Output only. Whether the cluster has been registered through the fleet API. "project": "A String", # The Fleet host project(project ID or project number) where this cluster will be registered to. This field cannot be changed after the cluster has been registered. }, "id": "A String", # Output only. Unique id for the cluster. @@ -2612,15 +2612,15 @@

Method Details

}, "initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "","-": picks the default Kubernetes version "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead. - "instanceGroupUrls": [ # Deprecated. Use node_pools.instance_group_urls. + "instanceGroupUrls": [ # Output only. Deprecated. Use node_pools.instance_group_urls. "A String", ], "ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the cluster. # Configuration for cluster IP allocation. - "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # Output only. [Output only] The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy. - "podRangeInfo": [ # Output only. [Output only] Information for additional pod range. + "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # Output only. The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy. + "podRangeInfo": [ # Output only. Information for additional pod range. { # RangeInfo contains the range name and the range utilization by this cluster. - "rangeName": "A String", # Output only. [Output only] Name of a range. - "utilization": 3.14, # Output only. [Output only] The utilization of the range. + "rangeName": "A String", # Output only. Name of a range. + "utilization": 3.14, # Output only. The utilization of the range. }, ], "podRangeNames": [ # Name for pod secondary ipv4 range which has the actual range defined ahead. @@ -2632,7 +2632,7 @@

Method Details

"clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then `cluster.cluster_ipv4_cidr` must be left blank. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. "clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases and create_subnetwork is false. "createSubnetwork": True or False, # Whether a new subnetwork will be created automatically for the cluster. This field is only applicable when `use_ip_aliases` is true. - "defaultPodIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "defaultPodIpv4RangeUtilization": 3.14, # Output only. The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "ipv6AccessType": "A String", # The ipv6 access type (internal or external) when create_subnetwork is true "nodeIpv4Cidr": "A String", # This field is deprecated, use node_ipv4_cidr_block. "nodeIpv4CidrBlock": "A String", # The IP address range of the instance IPs in this cluster. This is applicable only if `create_subnetwork` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. @@ -2641,10 +2641,10 @@

Method Details

}, "servicesIpv4Cidr": "A String", # This field is deprecated, use services_ipv4_cidr_block. "servicesIpv4CidrBlock": "A String", # The IP address range of the services IPs in this cluster. If blank, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. - "servicesIpv6CidrBlock": "A String", # Output only. [Output only] The services IPv6 CIDR block for the cluster. + "servicesIpv6CidrBlock": "A String", # Output only. The services IPv6 CIDR block for the cluster. "servicesSecondaryRangeName": "A String", # The name of the secondary range to be used as for the services CIDR block. The secondary range will be used for service ClusterIPs. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases and create_subnetwork is false. "stackType": "A String", # IP stack type - "subnetIpv6CidrBlock": "A String", # Output only. [Output only] The subnet's IPv6 CIDR block used by nodes and pods. + "subnetIpv6CidrBlock": "A String", # Output only. The subnet's IPv6 CIDR block used by nodes and pods. "subnetworkName": "A String", # A custom subnetwork name to be used if `create_subnetwork` is true. If this field is empty, then an automatic name will be chosen for the new subnetwork. "tpuIpv4CidrBlock": "A String", # The IP address range of the Cloud TPUs in this cluster. If unspecified, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. If unspecified, the range will use the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. This field is deprecated, use cluster.tpu_config.ipv4_cidr_block instead. "useIpAliases": True or False, # Whether alias IPs will be used for pod IPs in the cluster. This is used in conjunction with use_routes. It cannot be true if use_routes is true. If both use_ip_aliases and use_routes are false, then the server picks the default IP allocation mode @@ -2654,7 +2654,7 @@

Method Details

"legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization mode. # Configuration for the legacy ABAC authorization mode. "enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed. "A String", ], @@ -2670,7 +2670,7 @@

Method Details

"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of the policy won't accidentally undo intermediate changes (and so that users of the API unaware of some fields won't accidentally remove other fields). Make a `get()` request to the cluster to get the current resource version and include it with requests to set the policy. "window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed. "dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window. - "duration": "A String", # [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. + "duration": "A String", # Output only. Duration of the time window, automatically chosen to be smallest possible in the given scenario. "startTime": "A String", # Time within the maintenance window to start the maintenance operations. It must be in format "HH:MM", where HH : [00-23] and MM : [00-59] GMT. }, "maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows. @@ -2697,12 +2697,12 @@

Method Details

"master": { # Master is the configuration for components on master. # Configuration for master components. }, "masterAuth": { # The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. # The authentication information for accessing the master endpoint. If unspecified, the defaults are used: For clusters before v1.12, if master_auth is unspecified, `username` will be set to "admin", a random password will be generated, and a client certificate will be issued. - "clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. + "clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. "clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued. "issueClientCertificate": True or False, # Issue a client certificate. }, - "clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint. - "clusterCaCertificate": "A String", + "clientKey": "A String", # Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint. + "clusterCaCertificate": "A String", # Output only. Base64-encoded public certificate that is the root of trust for the cluster. "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication }, @@ -2939,7 +2939,7 @@

Method Details

"nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the workloads running on the node. }, }, - "nodeIpv4CidrSize": 42, # [Output only] The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode. + "nodeIpv4CidrSize": 42, # Output only. The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode. "nodePoolAutoConfig": { # node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. "networkTags": { # Collection of Compute Engine network tags that can be applied to a node's underlying VM instance. (See `tags` field in [`NodeConfig`](/kubernetes-engine/docs/reference/rest/v1/NodeConfig)). # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster creation. Each tag within the list must comply with RFC1035. "tags": [ # List of network tags. @@ -3192,7 +3192,7 @@

Method Details

}, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. @@ -3202,8 +3202,8 @@

Method Details

"autoRepair": True or False, # Whether the nodes will be automatically repaired. "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool. @@ -3236,7 +3236,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -3244,14 +3244,14 @@

Method Details

"tpuTopology": "A String", # TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, - "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool. + "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, - "selfLink": "A String", # [Output only] Server-defined URL for the resource. - "status": "A String", # [Output only] The status of the nodes in this pool instance. - "statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. - "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. [Output only] Update info contains relevant information during a node pool update. + "selfLink": "A String", # Output only. Server-defined URL for the resource. + "status": "A String", # Output only. The status of the nodes in this pool instance. + "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. + "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. Update info contains relevant information during a node pool update. "blueGreenInfo": { # Information relevant to blue-green upgrade. # Information of a blue-green upgrade. "blueInstanceGroupUrls": [ # The resource URLs of the [managed instance groups] (/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with blue pool. "A String", @@ -3345,20 +3345,20 @@

Method Details

"mode": "A String", # Sets which mode to use for Security Posture features. "vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning. }, - "selfLink": "A String", # [Output only] Server-defined URL for the resource. - "servicesIpv4Cidr": "A String", # [Output only] The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR. + "selfLink": "A String", # Output only. Server-defined URL for the resource. + "servicesIpv4Cidr": "A String", # Output only. The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR. "shieldedNodes": { # Configuration of Shielded Nodes feature. # Shielded Nodes configuration. "enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster. }, - "status": "A String", # [Output only] The current status of this cluster. - "statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available. + "status": "A String", # Output only. The current status of this cluster. + "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available. "subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected. On output this shows the subnetwork ID instead of the name. "tpuConfig": { # Configuration for Cloud TPU. # Configuration for Cloud TPU support; "enabled": True or False, # Whether Cloud TPU integration is enabled or not. "ipv4CidrBlock": "A String", # IPv4 CIDR block reserved for Cloud TPU in the VPC. "useServiceNetworking": True or False, # Whether to use service networking for Cloud TPU or not. }, - "tpuIpv4CidrBlock": "A String", # [Output only] The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). + "tpuIpv4CidrBlock": "A String", # Output only. The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). "verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it. # Cluster-level Vertical Pod Autoscaling configuration. "enabled": True or False, # Enables vertical pod autoscaling. }, @@ -3373,7 +3373,7 @@

Method Details

"identityProvider": "A String", # identity provider is the third party identity provider. "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to. }, - "zone": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. }, ], "missingZones": [ # If any zones are listed here, the list of clusters returned may be missing those zones. @@ -3469,8 +3469,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -3480,8 +3480,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -3489,8 +3489,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -3505,12 +3505,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -3547,8 +3547,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -3558,8 +3558,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -3567,8 +3567,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -3583,12 +3583,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -3627,8 +3627,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -3638,8 +3638,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -3647,8 +3647,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -3663,12 +3663,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -3705,8 +3705,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -3716,8 +3716,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -3725,8 +3725,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -3741,12 +3741,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -3765,7 +3765,7 @@

Method Details

"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of the policy won't accidentally undo intermediate changes (and so that users of the API unaware of some fields won't accidentally remove other fields). Make a `get()` request to the cluster to get the current resource version and include it with requests to set the policy. "window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed. "dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window. - "duration": "A String", # [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. + "duration": "A String", # Output only. Duration of the time window, automatically chosen to be smallest possible in the given scenario. "startTime": "A String", # Time within the maintenance window to start the maintenance operations. It must be in format "HH:MM", where HH : [00-23] and MM : [00-59] GMT. }, "maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows. @@ -3810,8 +3810,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -3821,8 +3821,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -3830,8 +3830,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -3846,12 +3846,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -3870,12 +3870,12 @@

Method Details

"name": "A String", # The name (project, location, cluster) of the cluster to set auth. Specified in the format `projects/*/locations/*/clusters/*`. "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. "update": { # The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. # Required. A description of the update. - "clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. + "clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. "clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued. "issueClientCertificate": True or False, # Issue a client certificate. }, - "clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint. - "clusterCaCertificate": "A String", + "clientKey": "A String", # Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint. + "clusterCaCertificate": "A String", # Output only. Base64-encoded public certificate that is the root of trust for the cluster. "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication }, @@ -3898,8 +3898,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -3909,8 +3909,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -3918,8 +3918,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -3934,12 +3934,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -3976,8 +3976,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -3987,8 +3987,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -3996,8 +3996,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -4012,12 +4012,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -4057,8 +4057,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -4068,8 +4068,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -4077,8 +4077,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -4093,12 +4093,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -4138,8 +4138,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -4149,8 +4149,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -4158,8 +4158,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -4174,12 +4174,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -4216,8 +4216,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -4227,8 +4227,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -4236,8 +4236,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -4252,12 +4252,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -4276,10 +4276,10 @@

Method Details

"projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. "update": { # ClusterUpdate describes an update to the cluster. Exactly one update can be applied to a cluster with each request, so at most one field can be provided. # Required. A description of the update. "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # The additional pod ranges to be added to the cluster. These pod ranges can be used by node pools to allocate pod IPs. - "podRangeInfo": [ # Output only. [Output only] Information for additional pod range. + "podRangeInfo": [ # Output only. Information for additional pod range. { # RangeInfo contains the range name and the range utilization by this cluster. - "rangeName": "A String", # Output only. [Output only] Name of a range. - "utilization": 3.14, # Output only. [Output only] The utilization of the range. + "rangeName": "A String", # Output only. Name of a range. + "utilization": 3.14, # Output only. The utilization of the range. }, ], "podRangeNames": [ # Name for pod secondary ipv4 range which has the actual range defined ahead. @@ -4371,8 +4371,8 @@

Method Details

"autoRepair": True or False, # Whether the nodes will be automatically repaired. "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. @@ -4461,8 +4461,8 @@

Method Details

"desiredEnableMultiNetworking": True or False, # Enable/Disable Multi-Networking for the cluster "desiredEnablePrivateEndpoint": True or False, # Enable/Disable private endpoint for the cluster's master. "desiredFleet": { # Fleet is the fleet configuration for the cluster. # The desired fleet configuration for the cluster. - "membership": "A String", # [Output only] The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`. - "preRegistered": True or False, # [Output only] Whether the cluster has been registered through the fleet API. + "membership": "A String", # Output only. The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`. + "preRegistered": True or False, # Output only. Whether the cluster has been registered through the fleet API. "project": "A String", # The Fleet host project(project ID or project number) where this cluster will be registered to. This field cannot be changed after the cluster has been registered. }, "desiredGatewayApiConfig": { # GatewayAPIConfig contains the desired config of Gateway API on this cluster. # The desired config of Gateway API on this cluster. @@ -4684,10 +4684,10 @@

Method Details

"publicEndpoint": "A String", # Output only. The external IP address of this cluster's master endpoint. }, "removedAdditionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # The additional pod ranges that are to be removed from the cluster. The pod ranges specified here must have been specified earlier in the 'additional_pod_ranges_config' argument. - "podRangeInfo": [ # Output only. [Output only] Information for additional pod range. + "podRangeInfo": [ # Output only. Information for additional pod range. { # RangeInfo contains the range name and the range utilization by this cluster. - "rangeName": "A String", # Output only. [Output only] Name of a range. - "utilization": 3.14, # Output only. [Output only] The utilization of the range. + "rangeName": "A String", # Output only. Name of a range. + "utilization": 3.14, # Output only. The utilization of the range. }, ], "podRangeNames": [ # Name for pod secondary ipv4 range which has the actual range defined ahead. @@ -4714,8 +4714,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -4725,8 +4725,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -4734,8 +4734,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -4750,12 +4750,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -4792,8 +4792,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -4803,8 +4803,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -4812,8 +4812,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -4828,12 +4828,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } diff --git a/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html b/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html index 0889533a1cb..d84299fdb5b 100644 --- a/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html +++ b/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html @@ -338,7 +338,7 @@

Method Details

}, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. @@ -348,8 +348,8 @@

Method Details

"autoRepair": True or False, # Whether the nodes will be automatically repaired. "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool. @@ -382,7 +382,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -390,14 +390,14 @@

Method Details

"tpuTopology": "A String", # TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, - "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool. + "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, - "selfLink": "A String", # [Output only] Server-defined URL for the resource. - "status": "A String", # [Output only] The status of the nodes in this pool instance. - "statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. - "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. [Output only] Update info contains relevant information during a node pool update. + "selfLink": "A String", # Output only. Server-defined URL for the resource. + "status": "A String", # Output only. The status of the nodes in this pool instance. + "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. + "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. Update info contains relevant information during a node pool update. "blueGreenInfo": { # Information relevant to blue-green upgrade. # Information of a blue-green upgrade. "blueInstanceGroupUrls": [ # The resource URLs of the [managed instance groups] (/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with blue pool. "A String", @@ -448,8 +448,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -459,8 +459,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -468,8 +468,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -484,12 +484,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -519,8 +519,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -530,8 +530,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -539,8 +539,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -555,12 +555,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -772,7 +772,7 @@

Method Details

}, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. @@ -782,8 +782,8 @@

Method Details

"autoRepair": True or False, # Whether the nodes will be automatically repaired. "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool. @@ -816,7 +816,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -824,14 +824,14 @@

Method Details

"tpuTopology": "A String", # TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, - "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool. + "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, - "selfLink": "A String", # [Output only] Server-defined URL for the resource. - "status": "A String", # [Output only] The status of the nodes in this pool instance. - "statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. - "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. [Output only] Update info contains relevant information during a node pool update. + "selfLink": "A String", # Output only. Server-defined URL for the resource. + "status": "A String", # Output only. The status of the nodes in this pool instance. + "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. + "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. Update info contains relevant information during a node pool update. "blueGreenInfo": { # Information relevant to blue-green upgrade. # Information of a blue-green upgrade. "blueInstanceGroupUrls": [ # The resource URLs of the [managed instance groups] (/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with blue pool. "A String", @@ -1072,7 +1072,7 @@

Method Details

}, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. @@ -1082,8 +1082,8 @@

Method Details

"autoRepair": True or False, # Whether the nodes will be automatically repaired. "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool. @@ -1116,7 +1116,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -1124,14 +1124,14 @@

Method Details

"tpuTopology": "A String", # TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, - "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool. + "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, - "selfLink": "A String", # [Output only] Server-defined URL for the resource. - "status": "A String", # [Output only] The status of the nodes in this pool instance. - "statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. - "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. [Output only] Update info contains relevant information during a node pool update. + "selfLink": "A String", # Output only. Server-defined URL for the resource. + "status": "A String", # Output only. The status of the nodes in this pool instance. + "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. + "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. Update info contains relevant information during a node pool update. "blueGreenInfo": { # Information relevant to blue-green upgrade. # Information of a blue-green upgrade. "blueInstanceGroupUrls": [ # The resource URLs of the [managed instance groups] (/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with blue pool. "A String", @@ -1199,8 +1199,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -1210,8 +1210,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -1219,8 +1219,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -1235,12 +1235,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -1286,8 +1286,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -1297,8 +1297,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -1306,8 +1306,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -1322,12 +1322,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -1346,8 +1346,8 @@

Method Details

"autoRepair": True or False, # Whether the nodes will be automatically repaired. "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "name": "A String", # The name (project, location, cluster, node pool id) of the node pool to set management properties. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. @@ -1372,8 +1372,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -1383,8 +1383,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -1392,8 +1392,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -1408,12 +1408,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -1451,8 +1451,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -1462,8 +1462,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -1471,8 +1471,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -1487,12 +1487,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -1611,7 +1611,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "nodePoolId": "A String", # Required. Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. @@ -1685,8 +1685,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -1696,8 +1696,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -1705,8 +1705,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -1721,12 +1721,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } diff --git a/docs/dyn/container_v1beta1.projects.locations.operations.html b/docs/dyn/container_v1beta1.projects.locations.operations.html index c1fbe846fab..3aff4a47316 100644 --- a/docs/dyn/container_v1beta1.projects.locations.operations.html +++ b/docs/dyn/container_v1beta1.projects.locations.operations.html @@ -145,8 +145,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -156,8 +156,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -165,8 +165,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -181,12 +181,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -219,8 +219,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -230,8 +230,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -239,8 +239,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -255,12 +255,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }, ], } diff --git a/docs/dyn/container_v1beta1.projects.zones.clusters.html b/docs/dyn/container_v1beta1.projects.zones.clusters.html index 04e76c331ee..3fe4f478c1d 100644 --- a/docs/dyn/container_v1beta1.projects.zones.clusters.html +++ b/docs/dyn/container_v1beta1.projects.zones.clusters.html @@ -223,8 +223,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -234,8 +234,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -243,8 +243,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -259,12 +259,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -307,8 +307,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -318,8 +318,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -327,8 +327,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -343,12 +343,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -446,8 +446,8 @@

Method Details

"autoRepair": True or False, # Whether the nodes will be automatically repaired. "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. @@ -519,10 +519,10 @@

Method Details

"costManagementConfig": { # Configuration for fine-grained cost management feature. # Configuration for the fine-grained cost management feature. "enabled": True or False, # Whether the feature is enabled or not. }, - "createTime": "A String", # [Output only] The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "currentMasterVersion": "A String", # [Output only] The current software version of the master endpoint. - "currentNodeCount": 42, # [Output only] The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. - "currentNodeVersion": "A String", # [Output only] Deprecated, use [NodePool.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. + "createTime": "A String", # Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "currentMasterVersion": "A String", # Output only. The current software version of the master endpoint. + "currentNodeCount": 42, # Output only. The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. + "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePool.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. "databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption. "currentState": "A String", # Output only. The current state of etcd encryption. "decryptionKeys": [ # Output only. Keys in use by the cluster for decrypting existing objects, in addition to the key in `key_name`. Each item is a CloudKMS key resource. @@ -549,15 +549,15 @@

Method Details

}, "enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1beta1) and features that may not be production ready in the kubernetes version of the master and nodes. The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are automatically deleted thirty days after creation. "enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster. This field is deprecated, use tpu_config.enabled instead. - "endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. + "endpoint": "A String", # Output only. The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. "enterpriseConfig": { # EnterpriseConfig is the cluster enterprise configuration. # GKE Enterprise Configuration. - "clusterTier": "A String", # Output only. [Output only] cluster_tier specifies the premium tier of the cluster. + "clusterTier": "A String", # Output only. cluster_tier specifies the premium tier of the cluster. }, "etag": "A String", # This checksum is computed by the server based on the value of cluster fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. - "expireTime": "A String", # [Output only] The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "expireTime": "A String", # Output only. The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "fleet": { # Fleet is the fleet configuration for the cluster. # Fleet information for the cluster. - "membership": "A String", # [Output only] The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`. - "preRegistered": True or False, # [Output only] Whether the cluster has been registered through the fleet API. + "membership": "A String", # Output only. The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`. + "preRegistered": True or False, # Output only. Whether the cluster has been registered through the fleet API. "project": "A String", # The Fleet host project(project ID or project number) where this cluster will be registered to. This field cannot be changed after the cluster has been registered. }, "id": "A String", # Output only. Unique id for the cluster. @@ -566,15 +566,15 @@

Method Details

}, "initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "","-": picks the default Kubernetes version "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead. - "instanceGroupUrls": [ # Deprecated. Use node_pools.instance_group_urls. + "instanceGroupUrls": [ # Output only. Deprecated. Use node_pools.instance_group_urls. "A String", ], "ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the cluster. # Configuration for cluster IP allocation. - "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # Output only. [Output only] The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy. - "podRangeInfo": [ # Output only. [Output only] Information for additional pod range. + "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # Output only. The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy. + "podRangeInfo": [ # Output only. Information for additional pod range. { # RangeInfo contains the range name and the range utilization by this cluster. - "rangeName": "A String", # Output only. [Output only] Name of a range. - "utilization": 3.14, # Output only. [Output only] The utilization of the range. + "rangeName": "A String", # Output only. Name of a range. + "utilization": 3.14, # Output only. The utilization of the range. }, ], "podRangeNames": [ # Name for pod secondary ipv4 range which has the actual range defined ahead. @@ -586,7 +586,7 @@

Method Details

"clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then `cluster.cluster_ipv4_cidr` must be left blank. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. "clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases and create_subnetwork is false. "createSubnetwork": True or False, # Whether a new subnetwork will be created automatically for the cluster. This field is only applicable when `use_ip_aliases` is true. - "defaultPodIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "defaultPodIpv4RangeUtilization": 3.14, # Output only. The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "ipv6AccessType": "A String", # The ipv6 access type (internal or external) when create_subnetwork is true "nodeIpv4Cidr": "A String", # This field is deprecated, use node_ipv4_cidr_block. "nodeIpv4CidrBlock": "A String", # The IP address range of the instance IPs in this cluster. This is applicable only if `create_subnetwork` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. @@ -595,10 +595,10 @@

Method Details

}, "servicesIpv4Cidr": "A String", # This field is deprecated, use services_ipv4_cidr_block. "servicesIpv4CidrBlock": "A String", # The IP address range of the services IPs in this cluster. If blank, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. - "servicesIpv6CidrBlock": "A String", # Output only. [Output only] The services IPv6 CIDR block for the cluster. + "servicesIpv6CidrBlock": "A String", # Output only. The services IPv6 CIDR block for the cluster. "servicesSecondaryRangeName": "A String", # The name of the secondary range to be used as for the services CIDR block. The secondary range will be used for service ClusterIPs. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases and create_subnetwork is false. "stackType": "A String", # IP stack type - "subnetIpv6CidrBlock": "A String", # Output only. [Output only] The subnet's IPv6 CIDR block used by nodes and pods. + "subnetIpv6CidrBlock": "A String", # Output only. The subnet's IPv6 CIDR block used by nodes and pods. "subnetworkName": "A String", # A custom subnetwork name to be used if `create_subnetwork` is true. If this field is empty, then an automatic name will be chosen for the new subnetwork. "tpuIpv4CidrBlock": "A String", # The IP address range of the Cloud TPUs in this cluster. If unspecified, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. If unspecified, the range will use the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. This field is deprecated, use cluster.tpu_config.ipv4_cidr_block instead. "useIpAliases": True or False, # Whether alias IPs will be used for pod IPs in the cluster. This is used in conjunction with use_routes. It cannot be true if use_routes is true. If both use_ip_aliases and use_routes are false, then the server picks the default IP allocation mode @@ -608,7 +608,7 @@

Method Details

"legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization mode. # Configuration for the legacy ABAC authorization mode. "enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed. "A String", ], @@ -624,7 +624,7 @@

Method Details

"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of the policy won't accidentally undo intermediate changes (and so that users of the API unaware of some fields won't accidentally remove other fields). Make a `get()` request to the cluster to get the current resource version and include it with requests to set the policy. "window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed. "dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window. - "duration": "A String", # [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. + "duration": "A String", # Output only. Duration of the time window, automatically chosen to be smallest possible in the given scenario. "startTime": "A String", # Time within the maintenance window to start the maintenance operations. It must be in format "HH:MM", where HH : [00-23] and MM : [00-59] GMT. }, "maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows. @@ -651,12 +651,12 @@

Method Details

"master": { # Master is the configuration for components on master. # Configuration for master components. }, "masterAuth": { # The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. # The authentication information for accessing the master endpoint. If unspecified, the defaults are used: For clusters before v1.12, if master_auth is unspecified, `username` will be set to "admin", a random password will be generated, and a client certificate will be issued. - "clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. + "clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. "clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued. "issueClientCertificate": True or False, # Issue a client certificate. }, - "clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint. - "clusterCaCertificate": "A String", + "clientKey": "A String", # Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint. + "clusterCaCertificate": "A String", # Output only. Base64-encoded public certificate that is the root of trust for the cluster. "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication }, @@ -893,7 +893,7 @@

Method Details

"nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the workloads running on the node. }, }, - "nodeIpv4CidrSize": 42, # [Output only] The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode. + "nodeIpv4CidrSize": 42, # Output only. The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode. "nodePoolAutoConfig": { # node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. "networkTags": { # Collection of Compute Engine network tags that can be applied to a node's underlying VM instance. (See `tags` field in [`NodeConfig`](/kubernetes-engine/docs/reference/rest/v1/NodeConfig)). # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster creation. Each tag within the list must comply with RFC1035. "tags": [ # List of network tags. @@ -1146,7 +1146,7 @@

Method Details

}, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. @@ -1156,8 +1156,8 @@

Method Details

"autoRepair": True or False, # Whether the nodes will be automatically repaired. "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool. @@ -1190,7 +1190,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -1198,14 +1198,14 @@

Method Details

"tpuTopology": "A String", # TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, - "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool. + "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, - "selfLink": "A String", # [Output only] Server-defined URL for the resource. - "status": "A String", # [Output only] The status of the nodes in this pool instance. - "statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. - "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. [Output only] Update info contains relevant information during a node pool update. + "selfLink": "A String", # Output only. Server-defined URL for the resource. + "status": "A String", # Output only. The status of the nodes in this pool instance. + "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. + "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. Update info contains relevant information during a node pool update. "blueGreenInfo": { # Information relevant to blue-green upgrade. # Information of a blue-green upgrade. "blueInstanceGroupUrls": [ # The resource URLs of the [managed instance groups] (/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with blue pool. "A String", @@ -1299,20 +1299,20 @@

Method Details

"mode": "A String", # Sets which mode to use for Security Posture features. "vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning. }, - "selfLink": "A String", # [Output only] Server-defined URL for the resource. - "servicesIpv4Cidr": "A String", # [Output only] The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR. + "selfLink": "A String", # Output only. Server-defined URL for the resource. + "servicesIpv4Cidr": "A String", # Output only. The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR. "shieldedNodes": { # Configuration of Shielded Nodes feature. # Shielded Nodes configuration. "enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster. }, - "status": "A String", # [Output only] The current status of this cluster. - "statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available. + "status": "A String", # Output only. The current status of this cluster. + "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available. "subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected. On output this shows the subnetwork ID instead of the name. "tpuConfig": { # Configuration for Cloud TPU. # Configuration for Cloud TPU support; "enabled": True or False, # Whether Cloud TPU integration is enabled or not. "ipv4CidrBlock": "A String", # IPv4 CIDR block reserved for Cloud TPU in the VPC. "useServiceNetworking": True or False, # Whether to use service networking for Cloud TPU or not. }, - "tpuIpv4CidrBlock": "A String", # [Output only] The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). + "tpuIpv4CidrBlock": "A String", # Output only. The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). "verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it. # Cluster-level Vertical Pod Autoscaling configuration. "enabled": True or False, # Enables vertical pod autoscaling. }, @@ -1327,7 +1327,7 @@

Method Details

"identityProvider": "A String", # identity provider is the third party identity provider. "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to. }, - "zone": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. }, "parent": "A String", # The parent (project and location) where the cluster will be created. Specified in the format `projects/*/locations/*`. "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. @@ -1350,8 +1350,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -1361,8 +1361,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -1370,8 +1370,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -1386,12 +1386,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -1420,8 +1420,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -1431,8 +1431,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -1440,8 +1440,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -1456,12 +1456,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -1565,8 +1565,8 @@

Method Details

"autoRepair": True or False, # Whether the nodes will be automatically repaired. "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. @@ -1638,10 +1638,10 @@

Method Details

"costManagementConfig": { # Configuration for fine-grained cost management feature. # Configuration for the fine-grained cost management feature. "enabled": True or False, # Whether the feature is enabled or not. }, - "createTime": "A String", # [Output only] The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "currentMasterVersion": "A String", # [Output only] The current software version of the master endpoint. - "currentNodeCount": 42, # [Output only] The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. - "currentNodeVersion": "A String", # [Output only] Deprecated, use [NodePool.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. + "createTime": "A String", # Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "currentMasterVersion": "A String", # Output only. The current software version of the master endpoint. + "currentNodeCount": 42, # Output only. The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. + "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePool.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. "databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption. "currentState": "A String", # Output only. The current state of etcd encryption. "decryptionKeys": [ # Output only. Keys in use by the cluster for decrypting existing objects, in addition to the key in `key_name`. Each item is a CloudKMS key resource. @@ -1668,15 +1668,15 @@

Method Details

}, "enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1beta1) and features that may not be production ready in the kubernetes version of the master and nodes. The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are automatically deleted thirty days after creation. "enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster. This field is deprecated, use tpu_config.enabled instead. - "endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. + "endpoint": "A String", # Output only. The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. "enterpriseConfig": { # EnterpriseConfig is the cluster enterprise configuration. # GKE Enterprise Configuration. - "clusterTier": "A String", # Output only. [Output only] cluster_tier specifies the premium tier of the cluster. + "clusterTier": "A String", # Output only. cluster_tier specifies the premium tier of the cluster. }, "etag": "A String", # This checksum is computed by the server based on the value of cluster fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. - "expireTime": "A String", # [Output only] The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "expireTime": "A String", # Output only. The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "fleet": { # Fleet is the fleet configuration for the cluster. # Fleet information for the cluster. - "membership": "A String", # [Output only] The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`. - "preRegistered": True or False, # [Output only] Whether the cluster has been registered through the fleet API. + "membership": "A String", # Output only. The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`. + "preRegistered": True or False, # Output only. Whether the cluster has been registered through the fleet API. "project": "A String", # The Fleet host project(project ID or project number) where this cluster will be registered to. This field cannot be changed after the cluster has been registered. }, "id": "A String", # Output only. Unique id for the cluster. @@ -1685,15 +1685,15 @@

Method Details

}, "initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "","-": picks the default Kubernetes version "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead. - "instanceGroupUrls": [ # Deprecated. Use node_pools.instance_group_urls. + "instanceGroupUrls": [ # Output only. Deprecated. Use node_pools.instance_group_urls. "A String", ], "ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the cluster. # Configuration for cluster IP allocation. - "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # Output only. [Output only] The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy. - "podRangeInfo": [ # Output only. [Output only] Information for additional pod range. + "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # Output only. The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy. + "podRangeInfo": [ # Output only. Information for additional pod range. { # RangeInfo contains the range name and the range utilization by this cluster. - "rangeName": "A String", # Output only. [Output only] Name of a range. - "utilization": 3.14, # Output only. [Output only] The utilization of the range. + "rangeName": "A String", # Output only. Name of a range. + "utilization": 3.14, # Output only. The utilization of the range. }, ], "podRangeNames": [ # Name for pod secondary ipv4 range which has the actual range defined ahead. @@ -1705,7 +1705,7 @@

Method Details

"clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then `cluster.cluster_ipv4_cidr` must be left blank. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. "clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases and create_subnetwork is false. "createSubnetwork": True or False, # Whether a new subnetwork will be created automatically for the cluster. This field is only applicable when `use_ip_aliases` is true. - "defaultPodIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "defaultPodIpv4RangeUtilization": 3.14, # Output only. The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "ipv6AccessType": "A String", # The ipv6 access type (internal or external) when create_subnetwork is true "nodeIpv4Cidr": "A String", # This field is deprecated, use node_ipv4_cidr_block. "nodeIpv4CidrBlock": "A String", # The IP address range of the instance IPs in this cluster. This is applicable only if `create_subnetwork` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. @@ -1714,10 +1714,10 @@

Method Details

}, "servicesIpv4Cidr": "A String", # This field is deprecated, use services_ipv4_cidr_block. "servicesIpv4CidrBlock": "A String", # The IP address range of the services IPs in this cluster. If blank, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. - "servicesIpv6CidrBlock": "A String", # Output only. [Output only] The services IPv6 CIDR block for the cluster. + "servicesIpv6CidrBlock": "A String", # Output only. The services IPv6 CIDR block for the cluster. "servicesSecondaryRangeName": "A String", # The name of the secondary range to be used as for the services CIDR block. The secondary range will be used for service ClusterIPs. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases and create_subnetwork is false. "stackType": "A String", # IP stack type - "subnetIpv6CidrBlock": "A String", # Output only. [Output only] The subnet's IPv6 CIDR block used by nodes and pods. + "subnetIpv6CidrBlock": "A String", # Output only. The subnet's IPv6 CIDR block used by nodes and pods. "subnetworkName": "A String", # A custom subnetwork name to be used if `create_subnetwork` is true. If this field is empty, then an automatic name will be chosen for the new subnetwork. "tpuIpv4CidrBlock": "A String", # The IP address range of the Cloud TPUs in this cluster. If unspecified, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. If unspecified, the range will use the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. This field is deprecated, use cluster.tpu_config.ipv4_cidr_block instead. "useIpAliases": True or False, # Whether alias IPs will be used for pod IPs in the cluster. This is used in conjunction with use_routes. It cannot be true if use_routes is true. If both use_ip_aliases and use_routes are false, then the server picks the default IP allocation mode @@ -1727,7 +1727,7 @@

Method Details

"legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization mode. # Configuration for the legacy ABAC authorization mode. "enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed. "A String", ], @@ -1743,7 +1743,7 @@

Method Details

"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of the policy won't accidentally undo intermediate changes (and so that users of the API unaware of some fields won't accidentally remove other fields). Make a `get()` request to the cluster to get the current resource version and include it with requests to set the policy. "window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed. "dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window. - "duration": "A String", # [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. + "duration": "A String", # Output only. Duration of the time window, automatically chosen to be smallest possible in the given scenario. "startTime": "A String", # Time within the maintenance window to start the maintenance operations. It must be in format "HH:MM", where HH : [00-23] and MM : [00-59] GMT. }, "maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows. @@ -1770,12 +1770,12 @@

Method Details

"master": { # Master is the configuration for components on master. # Configuration for master components. }, "masterAuth": { # The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. # The authentication information for accessing the master endpoint. If unspecified, the defaults are used: For clusters before v1.12, if master_auth is unspecified, `username` will be set to "admin", a random password will be generated, and a client certificate will be issued. - "clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. + "clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. "clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued. "issueClientCertificate": True or False, # Issue a client certificate. }, - "clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint. - "clusterCaCertificate": "A String", + "clientKey": "A String", # Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint. + "clusterCaCertificate": "A String", # Output only. Base64-encoded public certificate that is the root of trust for the cluster. "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication }, @@ -2012,7 +2012,7 @@

Method Details

"nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the workloads running on the node. }, }, - "nodeIpv4CidrSize": 42, # [Output only] The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode. + "nodeIpv4CidrSize": 42, # Output only. The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode. "nodePoolAutoConfig": { # node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. "networkTags": { # Collection of Compute Engine network tags that can be applied to a node's underlying VM instance. (See `tags` field in [`NodeConfig`](/kubernetes-engine/docs/reference/rest/v1/NodeConfig)). # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster creation. Each tag within the list must comply with RFC1035. "tags": [ # List of network tags. @@ -2265,7 +2265,7 @@

Method Details

}, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. @@ -2275,8 +2275,8 @@

Method Details

"autoRepair": True or False, # Whether the nodes will be automatically repaired. "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool. @@ -2309,7 +2309,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -2317,14 +2317,14 @@

Method Details

"tpuTopology": "A String", # TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, - "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool. + "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, - "selfLink": "A String", # [Output only] Server-defined URL for the resource. - "status": "A String", # [Output only] The status of the nodes in this pool instance. - "statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. - "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. [Output only] Update info contains relevant information during a node pool update. + "selfLink": "A String", # Output only. Server-defined URL for the resource. + "status": "A String", # Output only. The status of the nodes in this pool instance. + "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. + "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. Update info contains relevant information during a node pool update. "blueGreenInfo": { # Information relevant to blue-green upgrade. # Information of a blue-green upgrade. "blueInstanceGroupUrls": [ # The resource URLs of the [managed instance groups] (/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with blue pool. "A String", @@ -2418,20 +2418,20 @@

Method Details

"mode": "A String", # Sets which mode to use for Security Posture features. "vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning. }, - "selfLink": "A String", # [Output only] Server-defined URL for the resource. - "servicesIpv4Cidr": "A String", # [Output only] The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR. + "selfLink": "A String", # Output only. Server-defined URL for the resource. + "servicesIpv4Cidr": "A String", # Output only. The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR. "shieldedNodes": { # Configuration of Shielded Nodes feature. # Shielded Nodes configuration. "enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster. }, - "status": "A String", # [Output only] The current status of this cluster. - "statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available. + "status": "A String", # Output only. The current status of this cluster. + "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available. "subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected. On output this shows the subnetwork ID instead of the name. "tpuConfig": { # Configuration for Cloud TPU. # Configuration for Cloud TPU support; "enabled": True or False, # Whether Cloud TPU integration is enabled or not. "ipv4CidrBlock": "A String", # IPv4 CIDR block reserved for Cloud TPU in the VPC. "useServiceNetworking": True or False, # Whether to use service networking for Cloud TPU or not. }, - "tpuIpv4CidrBlock": "A String", # [Output only] The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). + "tpuIpv4CidrBlock": "A String", # Output only. The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). "verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it. # Cluster-level Vertical Pod Autoscaling configuration. "enabled": True or False, # Enables vertical pod autoscaling. }, @@ -2446,7 +2446,7 @@

Method Details

"identityProvider": "A String", # identity provider is the third party identity provider. "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to. }, - "zone": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. } @@ -2485,8 +2485,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -2496,8 +2496,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -2505,8 +2505,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -2521,12 +2521,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -2631,8 +2631,8 @@

Method Details

"autoRepair": True or False, # Whether the nodes will be automatically repaired. "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. @@ -2704,10 +2704,10 @@

Method Details

"costManagementConfig": { # Configuration for fine-grained cost management feature. # Configuration for the fine-grained cost management feature. "enabled": True or False, # Whether the feature is enabled or not. }, - "createTime": "A String", # [Output only] The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "currentMasterVersion": "A String", # [Output only] The current software version of the master endpoint. - "currentNodeCount": 42, # [Output only] The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. - "currentNodeVersion": "A String", # [Output only] Deprecated, use [NodePool.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. + "createTime": "A String", # Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "currentMasterVersion": "A String", # Output only. The current software version of the master endpoint. + "currentNodeCount": 42, # Output only. The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. + "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePool.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. "databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption. "currentState": "A String", # Output only. The current state of etcd encryption. "decryptionKeys": [ # Output only. Keys in use by the cluster for decrypting existing objects, in addition to the key in `key_name`. Each item is a CloudKMS key resource. @@ -2734,15 +2734,15 @@

Method Details

}, "enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1beta1) and features that may not be production ready in the kubernetes version of the master and nodes. The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are automatically deleted thirty days after creation. "enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster. This field is deprecated, use tpu_config.enabled instead. - "endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. + "endpoint": "A String", # Output only. The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. "enterpriseConfig": { # EnterpriseConfig is the cluster enterprise configuration. # GKE Enterprise Configuration. - "clusterTier": "A String", # Output only. [Output only] cluster_tier specifies the premium tier of the cluster. + "clusterTier": "A String", # Output only. cluster_tier specifies the premium tier of the cluster. }, "etag": "A String", # This checksum is computed by the server based on the value of cluster fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. - "expireTime": "A String", # [Output only] The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "expireTime": "A String", # Output only. The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "fleet": { # Fleet is the fleet configuration for the cluster. # Fleet information for the cluster. - "membership": "A String", # [Output only] The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`. - "preRegistered": True or False, # [Output only] Whether the cluster has been registered through the fleet API. + "membership": "A String", # Output only. The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`. + "preRegistered": True or False, # Output only. Whether the cluster has been registered through the fleet API. "project": "A String", # The Fleet host project(project ID or project number) where this cluster will be registered to. This field cannot be changed after the cluster has been registered. }, "id": "A String", # Output only. Unique id for the cluster. @@ -2751,15 +2751,15 @@

Method Details

}, "initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "","-": picks the default Kubernetes version "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead. - "instanceGroupUrls": [ # Deprecated. Use node_pools.instance_group_urls. + "instanceGroupUrls": [ # Output only. Deprecated. Use node_pools.instance_group_urls. "A String", ], "ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the cluster. # Configuration for cluster IP allocation. - "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # Output only. [Output only] The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy. - "podRangeInfo": [ # Output only. [Output only] Information for additional pod range. + "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # Output only. The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy. + "podRangeInfo": [ # Output only. Information for additional pod range. { # RangeInfo contains the range name and the range utilization by this cluster. - "rangeName": "A String", # Output only. [Output only] Name of a range. - "utilization": 3.14, # Output only. [Output only] The utilization of the range. + "rangeName": "A String", # Output only. Name of a range. + "utilization": 3.14, # Output only. The utilization of the range. }, ], "podRangeNames": [ # Name for pod secondary ipv4 range which has the actual range defined ahead. @@ -2771,7 +2771,7 @@

Method Details

"clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then `cluster.cluster_ipv4_cidr` must be left blank. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. "clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases and create_subnetwork is false. "createSubnetwork": True or False, # Whether a new subnetwork will be created automatically for the cluster. This field is only applicable when `use_ip_aliases` is true. - "defaultPodIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "defaultPodIpv4RangeUtilization": 3.14, # Output only. The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "ipv6AccessType": "A String", # The ipv6 access type (internal or external) when create_subnetwork is true "nodeIpv4Cidr": "A String", # This field is deprecated, use node_ipv4_cidr_block. "nodeIpv4CidrBlock": "A String", # The IP address range of the instance IPs in this cluster. This is applicable only if `create_subnetwork` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. @@ -2780,10 +2780,10 @@

Method Details

}, "servicesIpv4Cidr": "A String", # This field is deprecated, use services_ipv4_cidr_block. "servicesIpv4CidrBlock": "A String", # The IP address range of the services IPs in this cluster. If blank, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. - "servicesIpv6CidrBlock": "A String", # Output only. [Output only] The services IPv6 CIDR block for the cluster. + "servicesIpv6CidrBlock": "A String", # Output only. The services IPv6 CIDR block for the cluster. "servicesSecondaryRangeName": "A String", # The name of the secondary range to be used as for the services CIDR block. The secondary range will be used for service ClusterIPs. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases and create_subnetwork is false. "stackType": "A String", # IP stack type - "subnetIpv6CidrBlock": "A String", # Output only. [Output only] The subnet's IPv6 CIDR block used by nodes and pods. + "subnetIpv6CidrBlock": "A String", # Output only. The subnet's IPv6 CIDR block used by nodes and pods. "subnetworkName": "A String", # A custom subnetwork name to be used if `create_subnetwork` is true. If this field is empty, then an automatic name will be chosen for the new subnetwork. "tpuIpv4CidrBlock": "A String", # The IP address range of the Cloud TPUs in this cluster. If unspecified, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. If unspecified, the range will use the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. This field is deprecated, use cluster.tpu_config.ipv4_cidr_block instead. "useIpAliases": True or False, # Whether alias IPs will be used for pod IPs in the cluster. This is used in conjunction with use_routes. It cannot be true if use_routes is true. If both use_ip_aliases and use_routes are false, then the server picks the default IP allocation mode @@ -2793,7 +2793,7 @@

Method Details

"legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization mode. # Configuration for the legacy ABAC authorization mode. "enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed. "A String", ], @@ -2809,7 +2809,7 @@

Method Details

"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of the policy won't accidentally undo intermediate changes (and so that users of the API unaware of some fields won't accidentally remove other fields). Make a `get()` request to the cluster to get the current resource version and include it with requests to set the policy. "window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed. "dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window. - "duration": "A String", # [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. + "duration": "A String", # Output only. Duration of the time window, automatically chosen to be smallest possible in the given scenario. "startTime": "A String", # Time within the maintenance window to start the maintenance operations. It must be in format "HH:MM", where HH : [00-23] and MM : [00-59] GMT. }, "maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows. @@ -2836,12 +2836,12 @@

Method Details

"master": { # Master is the configuration for components on master. # Configuration for master components. }, "masterAuth": { # The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. # The authentication information for accessing the master endpoint. If unspecified, the defaults are used: For clusters before v1.12, if master_auth is unspecified, `username` will be set to "admin", a random password will be generated, and a client certificate will be issued. - "clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. + "clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. "clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued. "issueClientCertificate": True or False, # Issue a client certificate. }, - "clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint. - "clusterCaCertificate": "A String", + "clientKey": "A String", # Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint. + "clusterCaCertificate": "A String", # Output only. Base64-encoded public certificate that is the root of trust for the cluster. "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication }, @@ -3078,7 +3078,7 @@

Method Details

"nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the workloads running on the node. }, }, - "nodeIpv4CidrSize": 42, # [Output only] The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode. + "nodeIpv4CidrSize": 42, # Output only. The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode. "nodePoolAutoConfig": { # node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. "networkTags": { # Collection of Compute Engine network tags that can be applied to a node's underlying VM instance. (See `tags` field in [`NodeConfig`](/kubernetes-engine/docs/reference/rest/v1/NodeConfig)). # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster creation. Each tag within the list must comply with RFC1035. "tags": [ # List of network tags. @@ -3331,7 +3331,7 @@

Method Details

}, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. @@ -3341,8 +3341,8 @@

Method Details

"autoRepair": True or False, # Whether the nodes will be automatically repaired. "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool. @@ -3375,7 +3375,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -3383,14 +3383,14 @@

Method Details

"tpuTopology": "A String", # TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, - "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool. + "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, - "selfLink": "A String", # [Output only] Server-defined URL for the resource. - "status": "A String", # [Output only] The status of the nodes in this pool instance. - "statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. - "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. [Output only] Update info contains relevant information during a node pool update. + "selfLink": "A String", # Output only. Server-defined URL for the resource. + "status": "A String", # Output only. The status of the nodes in this pool instance. + "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. + "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. Update info contains relevant information during a node pool update. "blueGreenInfo": { # Information relevant to blue-green upgrade. # Information of a blue-green upgrade. "blueInstanceGroupUrls": [ # The resource URLs of the [managed instance groups] (/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with blue pool. "A String", @@ -3484,20 +3484,20 @@

Method Details

"mode": "A String", # Sets which mode to use for Security Posture features. "vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning. }, - "selfLink": "A String", # [Output only] Server-defined URL for the resource. - "servicesIpv4Cidr": "A String", # [Output only] The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR. + "selfLink": "A String", # Output only. Server-defined URL for the resource. + "servicesIpv4Cidr": "A String", # Output only. The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR. "shieldedNodes": { # Configuration of Shielded Nodes feature. # Shielded Nodes configuration. "enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster. }, - "status": "A String", # [Output only] The current status of this cluster. - "statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available. + "status": "A String", # Output only. The current status of this cluster. + "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available. "subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected. On output this shows the subnetwork ID instead of the name. "tpuConfig": { # Configuration for Cloud TPU. # Configuration for Cloud TPU support; "enabled": True or False, # Whether Cloud TPU integration is enabled or not. "ipv4CidrBlock": "A String", # IPv4 CIDR block reserved for Cloud TPU in the VPC. "useServiceNetworking": True or False, # Whether to use service networking for Cloud TPU or not. }, - "tpuIpv4CidrBlock": "A String", # [Output only] The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). + "tpuIpv4CidrBlock": "A String", # Output only. The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). "verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it. # Cluster-level Vertical Pod Autoscaling configuration. "enabled": True or False, # Enables vertical pod autoscaling. }, @@ -3512,7 +3512,7 @@

Method Details

"identityProvider": "A String", # identity provider is the third party identity provider. "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to. }, - "zone": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. }, ], "missingZones": [ # If any zones are listed here, the list of clusters returned may be missing those zones. @@ -3558,8 +3558,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -3569,8 +3569,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -3578,8 +3578,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -3594,12 +3594,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -3638,8 +3638,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -3649,8 +3649,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -3658,8 +3658,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -3674,12 +3674,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -3718,8 +3718,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -3729,8 +3729,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -3738,8 +3738,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -3754,12 +3754,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -3798,8 +3798,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -3809,8 +3809,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -3818,8 +3818,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -3834,12 +3834,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -3881,8 +3881,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -3892,8 +3892,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -3901,8 +3901,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -3917,12 +3917,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -3943,7 +3943,7 @@

Method Details

"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of the policy won't accidentally undo intermediate changes (and so that users of the API unaware of some fields won't accidentally remove other fields). Make a `get()` request to the cluster to get the current resource version and include it with requests to set the policy. "window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed. "dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window. - "duration": "A String", # [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. + "duration": "A String", # Output only. Duration of the time window, automatically chosen to be smallest possible in the given scenario. "startTime": "A String", # Time within the maintenance window to start the maintenance operations. It must be in format "HH:MM", where HH : [00-23] and MM : [00-59] GMT. }, "maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows. @@ -3988,8 +3988,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -3999,8 +3999,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -4008,8 +4008,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -4024,12 +4024,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -4050,12 +4050,12 @@

Method Details

"name": "A String", # The name (project, location, cluster) of the cluster to set auth. Specified in the format `projects/*/locations/*/clusters/*`. "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. "update": { # The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. # Required. A description of the update. - "clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. + "clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. "clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued. "issueClientCertificate": True or False, # Issue a client certificate. }, - "clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint. - "clusterCaCertificate": "A String", + "clientKey": "A String", # Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint. + "clusterCaCertificate": "A String", # Output only. Base64-encoded public certificate that is the root of trust for the cluster. "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication }, @@ -4078,8 +4078,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -4089,8 +4089,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -4098,8 +4098,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -4114,12 +4114,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -4161,8 +4161,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -4172,8 +4172,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -4181,8 +4181,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -4197,12 +4197,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -4241,8 +4241,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -4252,8 +4252,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -4261,8 +4261,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -4277,12 +4277,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -4303,10 +4303,10 @@

Method Details

"projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. "update": { # ClusterUpdate describes an update to the cluster. Exactly one update can be applied to a cluster with each request, so at most one field can be provided. # Required. A description of the update. "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # The additional pod ranges to be added to the cluster. These pod ranges can be used by node pools to allocate pod IPs. - "podRangeInfo": [ # Output only. [Output only] Information for additional pod range. + "podRangeInfo": [ # Output only. Information for additional pod range. { # RangeInfo contains the range name and the range utilization by this cluster. - "rangeName": "A String", # Output only. [Output only] Name of a range. - "utilization": 3.14, # Output only. [Output only] The utilization of the range. + "rangeName": "A String", # Output only. Name of a range. + "utilization": 3.14, # Output only. The utilization of the range. }, ], "podRangeNames": [ # Name for pod secondary ipv4 range which has the actual range defined ahead. @@ -4398,8 +4398,8 @@

Method Details

"autoRepair": True or False, # Whether the nodes will be automatically repaired. "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. @@ -4488,8 +4488,8 @@

Method Details

"desiredEnableMultiNetworking": True or False, # Enable/Disable Multi-Networking for the cluster "desiredEnablePrivateEndpoint": True or False, # Enable/Disable private endpoint for the cluster's master. "desiredFleet": { # Fleet is the fleet configuration for the cluster. # The desired fleet configuration for the cluster. - "membership": "A String", # [Output only] The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`. - "preRegistered": True or False, # [Output only] Whether the cluster has been registered through the fleet API. + "membership": "A String", # Output only. The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`. + "preRegistered": True or False, # Output only. Whether the cluster has been registered through the fleet API. "project": "A String", # The Fleet host project(project ID or project number) where this cluster will be registered to. This field cannot be changed after the cluster has been registered. }, "desiredGatewayApiConfig": { # GatewayAPIConfig contains the desired config of Gateway API on this cluster. # The desired config of Gateway API on this cluster. @@ -4711,10 +4711,10 @@

Method Details

"publicEndpoint": "A String", # Output only. The external IP address of this cluster's master endpoint. }, "removedAdditionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # The additional pod ranges that are to be removed from the cluster. The pod ranges specified here must have been specified earlier in the 'additional_pod_ranges_config' argument. - "podRangeInfo": [ # Output only. [Output only] Information for additional pod range. + "podRangeInfo": [ # Output only. Information for additional pod range. { # RangeInfo contains the range name and the range utilization by this cluster. - "rangeName": "A String", # Output only. [Output only] Name of a range. - "utilization": 3.14, # Output only. [Output only] The utilization of the range. + "rangeName": "A String", # Output only. Name of a range. + "utilization": 3.14, # Output only. The utilization of the range. }, ], "podRangeNames": [ # Name for pod secondary ipv4 range which has the actual range defined ahead. @@ -4741,8 +4741,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -4752,8 +4752,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -4761,8 +4761,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -4777,12 +4777,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } diff --git a/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html b/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html index ad25f5b6d22..f4436a1ca2c 100644 --- a/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html +++ b/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html @@ -150,8 +150,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -161,8 +161,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -170,8 +170,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -186,12 +186,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -403,7 +403,7 @@

Method Details

}, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. @@ -413,8 +413,8 @@

Method Details

"autoRepair": True or False, # Whether the nodes will be automatically repaired. "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool. @@ -447,7 +447,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -455,14 +455,14 @@

Method Details

"tpuTopology": "A String", # TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, - "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool. + "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, - "selfLink": "A String", # [Output only] Server-defined URL for the resource. - "status": "A String", # [Output only] The status of the nodes in this pool instance. - "statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. - "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. [Output only] Update info contains relevant information during a node pool update. + "selfLink": "A String", # Output only. Server-defined URL for the resource. + "status": "A String", # Output only. The status of the nodes in this pool instance. + "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. + "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. Update info contains relevant information during a node pool update. "blueGreenInfo": { # Information relevant to blue-green upgrade. # Information of a blue-green upgrade. "blueInstanceGroupUrls": [ # The resource URLs of the [managed instance groups] (/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with blue pool. "A String", @@ -513,8 +513,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -524,8 +524,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -533,8 +533,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -549,12 +549,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -584,8 +584,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -595,8 +595,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -604,8 +604,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -620,12 +620,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -837,7 +837,7 @@

Method Details

}, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. @@ -847,8 +847,8 @@

Method Details

"autoRepair": True or False, # Whether the nodes will be automatically repaired. "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool. @@ -881,7 +881,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -889,14 +889,14 @@

Method Details

"tpuTopology": "A String", # TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, - "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool. + "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, - "selfLink": "A String", # [Output only] Server-defined URL for the resource. - "status": "A String", # [Output only] The status of the nodes in this pool instance. - "statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. - "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. [Output only] Update info contains relevant information during a node pool update. + "selfLink": "A String", # Output only. Server-defined URL for the resource. + "status": "A String", # Output only. The status of the nodes in this pool instance. + "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. + "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. Update info contains relevant information during a node pool update. "blueGreenInfo": { # Information relevant to blue-green upgrade. # Information of a blue-green upgrade. "blueInstanceGroupUrls": [ # The resource URLs of the [managed instance groups] (/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with blue pool. "A String", @@ -1137,7 +1137,7 @@

Method Details

}, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. @@ -1147,8 +1147,8 @@

Method Details

"autoRepair": True or False, # Whether the nodes will be automatically repaired. "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool. @@ -1181,7 +1181,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -1189,14 +1189,14 @@

Method Details

"tpuTopology": "A String", # TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, - "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool. + "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, - "selfLink": "A String", # [Output only] Server-defined URL for the resource. - "status": "A String", # [Output only] The status of the nodes in this pool instance. - "statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. - "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. [Output only] Update info contains relevant information during a node pool update. + "selfLink": "A String", # Output only. Server-defined URL for the resource. + "status": "A String", # Output only. The status of the nodes in this pool instance. + "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. + "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. Update info contains relevant information during a node pool update. "blueGreenInfo": { # Information relevant to blue-green upgrade. # Information of a blue-green upgrade. "blueInstanceGroupUrls": [ # The resource URLs of the [managed instance groups] (/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with blue pool. "A String", @@ -1267,8 +1267,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -1278,8 +1278,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -1287,8 +1287,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -1303,12 +1303,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -1330,8 +1330,8 @@

Method Details

"autoRepair": True or False, # Whether the nodes will be automatically repaired. "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "name": "A String", # The name (project, location, cluster, node pool id) of the node pool to set management properties. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. @@ -1356,8 +1356,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -1367,8 +1367,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -1376,8 +1376,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -1392,12 +1392,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -1438,8 +1438,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -1449,8 +1449,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -1458,8 +1458,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -1474,12 +1474,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -1601,7 +1601,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "nodePoolId": "A String", # Required. Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. @@ -1675,8 +1675,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -1686,8 +1686,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -1695,8 +1695,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -1711,12 +1711,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } diff --git a/docs/dyn/container_v1beta1.projects.zones.operations.html b/docs/dyn/container_v1beta1.projects.zones.operations.html index d5197b70b4f..15b6c861abb 100644 --- a/docs/dyn/container_v1beta1.projects.zones.operations.html +++ b/docs/dyn/container_v1beta1.projects.zones.operations.html @@ -147,8 +147,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -158,8 +158,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -167,8 +167,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -183,12 +183,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -221,8 +221,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -232,8 +232,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -241,8 +241,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -257,12 +257,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }, ], } diff --git a/docs/dyn/content_v2_1.products.html b/docs/dyn/content_v2_1.products.html index 8a6d0ad90d6..4da57c62e1d 100644 --- a/docs/dyn/content_v2_1.products.html +++ b/docs/dyn/content_v2_1.products.html @@ -247,6 +247,7 @@

Method Details

"value": "A String", # The price represented as a number. }, "loyaltyPoints": "A String", # Optional. The amount of loyalty points earned on a purchase. + "memberPriceEffectiveDate": "A String", # Optional. A date range during which the item is eligible for member price. If not specified, the member price is always applicable. The date range is represented by a pair of ISO 8601 dates separated by a space, comma, or slash. "price": { # Optional. The price for members of the given tier (instant discount price). Must be smaller or equal to the regular price. "currency": "A String", # The currency of the price. "value": "A String", # The price represented as a number. @@ -261,6 +262,7 @@

Method Details

"value": "A String", # The price represented as a number. }, "loyaltyPoints": "A String", # Optional. The amount of loyalty points earned on a purchase. + "memberPriceEffectiveDate": "A String", # Optional. A date range during which the item is eligible for member price. If not specified, the member price is always applicable. The date range is represented by a pair of ISO 8601 dates separated by a space, comma, or slash. "price": { # Optional. The price for members of the given tier (instant discount price). Must be smaller or equal to the regular price. "currency": "A String", # The currency of the price. "value": "A String", # The price represented as a number. @@ -368,7 +370,7 @@

Method Details

"sizes": [ # Size of the item. Only one value is allowed. For variants with different sizes, insert a separate product for each size with the same `itemGroupId` value (see size definition). "A String", ], - "source": "A String", # The source of the offer, that is, how the offer was created. Acceptable values are: - "`api`" - "`crawl`" - "`feed`" + "source": "A String", # Output only. The source of the offer, that is, how the offer was created. Acceptable values are: - "`api`" - "`crawl`" - "`feed`" "structuredDescription": { # Structured description, for algorithmically (AI)-generated descriptions. See [description](https://support.google.com/merchants/answer/6324468#When_to_use) for more information. # Structured description, for algorithmically (AI)-generated descriptions. "content": "A String", # Required. The description text. Maximum length is 5000 characters. "digitalSourceType": "A String", # Optional. The digital source type. Acceptable values are: - "`trained_algorithmic_media`" - "`default`" @@ -567,6 +569,7 @@

Method Details

"value": "A String", # The price represented as a number. }, "loyaltyPoints": "A String", # Optional. The amount of loyalty points earned on a purchase. + "memberPriceEffectiveDate": "A String", # Optional. A date range during which the item is eligible for member price. If not specified, the member price is always applicable. The date range is represented by a pair of ISO 8601 dates separated by a space, comma, or slash. "price": { # Optional. The price for members of the given tier (instant discount price). Must be smaller or equal to the regular price. "currency": "A String", # The currency of the price. "value": "A String", # The price represented as a number. @@ -581,6 +584,7 @@

Method Details

"value": "A String", # The price represented as a number. }, "loyaltyPoints": "A String", # Optional. The amount of loyalty points earned on a purchase. + "memberPriceEffectiveDate": "A String", # Optional. A date range during which the item is eligible for member price. If not specified, the member price is always applicable. The date range is represented by a pair of ISO 8601 dates separated by a space, comma, or slash. "price": { # Optional. The price for members of the given tier (instant discount price). Must be smaller or equal to the regular price. "currency": "A String", # The currency of the price. "value": "A String", # The price represented as a number. @@ -688,7 +692,7 @@

Method Details

"sizes": [ # Size of the item. Only one value is allowed. For variants with different sizes, insert a separate product for each size with the same `itemGroupId` value (see size definition). "A String", ], - "source": "A String", # The source of the offer, that is, how the offer was created. Acceptable values are: - "`api`" - "`crawl`" - "`feed`" + "source": "A String", # Output only. The source of the offer, that is, how the offer was created. Acceptable values are: - "`api`" - "`crawl`" - "`feed`" "structuredDescription": { # Structured description, for algorithmically (AI)-generated descriptions. See [description](https://support.google.com/merchants/answer/6324468#When_to_use) for more information. # Structured description, for algorithmically (AI)-generated descriptions. "content": "A String", # Required. The description text. Maximum length is 5000 characters. "digitalSourceType": "A String", # Optional. The digital source type. Acceptable values are: - "`trained_algorithmic_media`" - "`default`" @@ -893,6 +897,7 @@

Method Details

"value": "A String", # The price represented as a number. }, "loyaltyPoints": "A String", # Optional. The amount of loyalty points earned on a purchase. + "memberPriceEffectiveDate": "A String", # Optional. A date range during which the item is eligible for member price. If not specified, the member price is always applicable. The date range is represented by a pair of ISO 8601 dates separated by a space, comma, or slash. "price": { # Optional. The price for members of the given tier (instant discount price). Must be smaller or equal to the regular price. "currency": "A String", # The currency of the price. "value": "A String", # The price represented as a number. @@ -907,6 +912,7 @@

Method Details

"value": "A String", # The price represented as a number. }, "loyaltyPoints": "A String", # Optional. The amount of loyalty points earned on a purchase. + "memberPriceEffectiveDate": "A String", # Optional. A date range during which the item is eligible for member price. If not specified, the member price is always applicable. The date range is represented by a pair of ISO 8601 dates separated by a space, comma, or slash. "price": { # Optional. The price for members of the given tier (instant discount price). Must be smaller or equal to the regular price. "currency": "A String", # The currency of the price. "value": "A String", # The price represented as a number. @@ -1014,7 +1020,7 @@

Method Details

"sizes": [ # Size of the item. Only one value is allowed. For variants with different sizes, insert a separate product for each size with the same `itemGroupId` value (see size definition). "A String", ], - "source": "A String", # The source of the offer, that is, how the offer was created. Acceptable values are: - "`api`" - "`crawl`" - "`feed`" + "source": "A String", # Output only. The source of the offer, that is, how the offer was created. Acceptable values are: - "`api`" - "`crawl`" - "`feed`" "structuredDescription": { # Structured description, for algorithmically (AI)-generated descriptions. See [description](https://support.google.com/merchants/answer/6324468#When_to_use) for more information. # Structured description, for algorithmically (AI)-generated descriptions. "content": "A String", # Required. The description text. Maximum length is 5000 characters. "digitalSourceType": "A String", # Optional. The digital source type. Acceptable values are: - "`trained_algorithmic_media`" - "`default`" @@ -1194,6 +1200,7 @@

Method Details

"value": "A String", # The price represented as a number. }, "loyaltyPoints": "A String", # Optional. The amount of loyalty points earned on a purchase. + "memberPriceEffectiveDate": "A String", # Optional. A date range during which the item is eligible for member price. If not specified, the member price is always applicable. The date range is represented by a pair of ISO 8601 dates separated by a space, comma, or slash. "price": { # Optional. The price for members of the given tier (instant discount price). Must be smaller or equal to the regular price. "currency": "A String", # The currency of the price. "value": "A String", # The price represented as a number. @@ -1208,6 +1215,7 @@

Method Details

"value": "A String", # The price represented as a number. }, "loyaltyPoints": "A String", # Optional. The amount of loyalty points earned on a purchase. + "memberPriceEffectiveDate": "A String", # Optional. A date range during which the item is eligible for member price. If not specified, the member price is always applicable. The date range is represented by a pair of ISO 8601 dates separated by a space, comma, or slash. "price": { # Optional. The price for members of the given tier (instant discount price). Must be smaller or equal to the regular price. "currency": "A String", # The currency of the price. "value": "A String", # The price represented as a number. @@ -1315,7 +1323,7 @@

Method Details

"sizes": [ # Size of the item. Only one value is allowed. For variants with different sizes, insert a separate product for each size with the same `itemGroupId` value (see size definition). "A String", ], - "source": "A String", # The source of the offer, that is, how the offer was created. Acceptable values are: - "`api`" - "`crawl`" - "`feed`" + "source": "A String", # Output only. The source of the offer, that is, how the offer was created. Acceptable values are: - "`api`" - "`crawl`" - "`feed`" "structuredDescription": { # Structured description, for algorithmically (AI)-generated descriptions. See [description](https://support.google.com/merchants/answer/6324468#When_to_use) for more information. # Structured description, for algorithmically (AI)-generated descriptions. "content": "A String", # Required. The description text. Maximum length is 5000 characters. "digitalSourceType": "A String", # Optional. The digital source type. Acceptable values are: - "`trained_algorithmic_media`" - "`default`" @@ -1494,6 +1502,7 @@

Method Details

"value": "A String", # The price represented as a number. }, "loyaltyPoints": "A String", # Optional. The amount of loyalty points earned on a purchase. + "memberPriceEffectiveDate": "A String", # Optional. A date range during which the item is eligible for member price. If not specified, the member price is always applicable. The date range is represented by a pair of ISO 8601 dates separated by a space, comma, or slash. "price": { # Optional. The price for members of the given tier (instant discount price). Must be smaller or equal to the regular price. "currency": "A String", # The currency of the price. "value": "A String", # The price represented as a number. @@ -1508,6 +1517,7 @@

Method Details

"value": "A String", # The price represented as a number. }, "loyaltyPoints": "A String", # Optional. The amount of loyalty points earned on a purchase. + "memberPriceEffectiveDate": "A String", # Optional. A date range during which the item is eligible for member price. If not specified, the member price is always applicable. The date range is represented by a pair of ISO 8601 dates separated by a space, comma, or slash. "price": { # Optional. The price for members of the given tier (instant discount price). Must be smaller or equal to the regular price. "currency": "A String", # The currency of the price. "value": "A String", # The price represented as a number. @@ -1615,7 +1625,7 @@

Method Details

"sizes": [ # Size of the item. Only one value is allowed. For variants with different sizes, insert a separate product for each size with the same `itemGroupId` value (see size definition). "A String", ], - "source": "A String", # The source of the offer, that is, how the offer was created. Acceptable values are: - "`api`" - "`crawl`" - "`feed`" + "source": "A String", # Output only. The source of the offer, that is, how the offer was created. Acceptable values are: - "`api`" - "`crawl`" - "`feed`" "structuredDescription": { # Structured description, for algorithmically (AI)-generated descriptions. See [description](https://support.google.com/merchants/answer/6324468#When_to_use) for more information. # Structured description, for algorithmically (AI)-generated descriptions. "content": "A String", # Required. The description text. Maximum length is 5000 characters. "digitalSourceType": "A String", # Optional. The digital source type. Acceptable values are: - "`trained_algorithmic_media`" - "`default`" @@ -1806,6 +1816,7 @@

Method Details

"value": "A String", # The price represented as a number. }, "loyaltyPoints": "A String", # Optional. The amount of loyalty points earned on a purchase. + "memberPriceEffectiveDate": "A String", # Optional. A date range during which the item is eligible for member price. If not specified, the member price is always applicable. The date range is represented by a pair of ISO 8601 dates separated by a space, comma, or slash. "price": { # Optional. The price for members of the given tier (instant discount price). Must be smaller or equal to the regular price. "currency": "A String", # The currency of the price. "value": "A String", # The price represented as a number. @@ -1820,6 +1831,7 @@

Method Details

"value": "A String", # The price represented as a number. }, "loyaltyPoints": "A String", # Optional. The amount of loyalty points earned on a purchase. + "memberPriceEffectiveDate": "A String", # Optional. A date range during which the item is eligible for member price. If not specified, the member price is always applicable. The date range is represented by a pair of ISO 8601 dates separated by a space, comma, or slash. "price": { # Optional. The price for members of the given tier (instant discount price). Must be smaller or equal to the regular price. "currency": "A String", # The currency of the price. "value": "A String", # The price represented as a number. @@ -1927,7 +1939,7 @@

Method Details

"sizes": [ # Size of the item. Only one value is allowed. For variants with different sizes, insert a separate product for each size with the same `itemGroupId` value (see size definition). "A String", ], - "source": "A String", # The source of the offer, that is, how the offer was created. Acceptable values are: - "`api`" - "`crawl`" - "`feed`" + "source": "A String", # Output only. The source of the offer, that is, how the offer was created. Acceptable values are: - "`api`" - "`crawl`" - "`feed`" "structuredDescription": { # Structured description, for algorithmically (AI)-generated descriptions. See [description](https://support.google.com/merchants/answer/6324468#When_to_use) for more information. # Structured description, for algorithmically (AI)-generated descriptions. "content": "A String", # Required. The description text. Maximum length is 5000 characters. "digitalSourceType": "A String", # Optional. The digital source type. Acceptable values are: - "`trained_algorithmic_media`" - "`default`" @@ -2124,6 +2136,7 @@

Method Details

"value": "A String", # The price represented as a number. }, "loyaltyPoints": "A String", # Optional. The amount of loyalty points earned on a purchase. + "memberPriceEffectiveDate": "A String", # Optional. A date range during which the item is eligible for member price. If not specified, the member price is always applicable. The date range is represented by a pair of ISO 8601 dates separated by a space, comma, or slash. "price": { # Optional. The price for members of the given tier (instant discount price). Must be smaller or equal to the regular price. "currency": "A String", # The currency of the price. "value": "A String", # The price represented as a number. @@ -2138,6 +2151,7 @@

Method Details

"value": "A String", # The price represented as a number. }, "loyaltyPoints": "A String", # Optional. The amount of loyalty points earned on a purchase. + "memberPriceEffectiveDate": "A String", # Optional. A date range during which the item is eligible for member price. If not specified, the member price is always applicable. The date range is represented by a pair of ISO 8601 dates separated by a space, comma, or slash. "price": { # Optional. The price for members of the given tier (instant discount price). Must be smaller or equal to the regular price. "currency": "A String", # The currency of the price. "value": "A String", # The price represented as a number. @@ -2245,7 +2259,7 @@

Method Details

"sizes": [ # Size of the item. Only one value is allowed. For variants with different sizes, insert a separate product for each size with the same `itemGroupId` value (see size definition). "A String", ], - "source": "A String", # The source of the offer, that is, how the offer was created. Acceptable values are: - "`api`" - "`crawl`" - "`feed`" + "source": "A String", # Output only. The source of the offer, that is, how the offer was created. Acceptable values are: - "`api`" - "`crawl`" - "`feed`" "structuredDescription": { # Structured description, for algorithmically (AI)-generated descriptions. See [description](https://support.google.com/merchants/answer/6324468#When_to_use) for more information. # Structured description, for algorithmically (AI)-generated descriptions. "content": "A String", # Required. The description text. Maximum length is 5000 characters. "digitalSourceType": "A String", # Optional. The digital source type. Acceptable values are: - "`trained_algorithmic_media`" - "`default`" @@ -2424,6 +2438,7 @@

Method Details

"value": "A String", # The price represented as a number. }, "loyaltyPoints": "A String", # Optional. The amount of loyalty points earned on a purchase. + "memberPriceEffectiveDate": "A String", # Optional. A date range during which the item is eligible for member price. If not specified, the member price is always applicable. The date range is represented by a pair of ISO 8601 dates separated by a space, comma, or slash. "price": { # Optional. The price for members of the given tier (instant discount price). Must be smaller or equal to the regular price. "currency": "A String", # The currency of the price. "value": "A String", # The price represented as a number. @@ -2438,6 +2453,7 @@

Method Details

"value": "A String", # The price represented as a number. }, "loyaltyPoints": "A String", # Optional. The amount of loyalty points earned on a purchase. + "memberPriceEffectiveDate": "A String", # Optional. A date range during which the item is eligible for member price. If not specified, the member price is always applicable. The date range is represented by a pair of ISO 8601 dates separated by a space, comma, or slash. "price": { # Optional. The price for members of the given tier (instant discount price). Must be smaller or equal to the regular price. "currency": "A String", # The currency of the price. "value": "A String", # The price represented as a number. @@ -2545,7 +2561,7 @@

Method Details

"sizes": [ # Size of the item. Only one value is allowed. For variants with different sizes, insert a separate product for each size with the same `itemGroupId` value (see size definition). "A String", ], - "source": "A String", # The source of the offer, that is, how the offer was created. Acceptable values are: - "`api`" - "`crawl`" - "`feed`" + "source": "A String", # Output only. The source of the offer, that is, how the offer was created. Acceptable values are: - "`api`" - "`crawl`" - "`feed`" "structuredDescription": { # Structured description, for algorithmically (AI)-generated descriptions. See [description](https://support.google.com/merchants/answer/6324468#When_to_use) for more information. # Structured description, for algorithmically (AI)-generated descriptions. "content": "A String", # Required. The description text. Maximum length is 5000 characters. "digitalSourceType": "A String", # Optional. The digital source type. Acceptable values are: - "`trained_algorithmic_media`" - "`default`" diff --git a/docs/dyn/css_v1.accounts.cssProductInputs.html b/docs/dyn/css_v1.accounts.cssProductInputs.html index a4eb2da60a5..0135c320fd3 100644 --- a/docs/dyn/css_v1.accounts.cssProductInputs.html +++ b/docs/dyn/css_v1.accounts.cssProductInputs.html @@ -126,10 +126,10 @@

Method Details

"ageGroup": "A String", # Target age group of the item. "brand": "A String", # Product Related Attributes.[14-36] Brand of the item. "certifications": [ # A list of certificates claimed by the CSS for the given product. - { # The certification for the product. - "authority": "A String", # Name of the certification body. - "code": "A String", # A unique code to identify the certification. - "name": "A String", # Name of the certification. + { # The certification for the product. Use the this attribute to describe certifications, such as energy efficiency ratings, associated with a product. + "authority": "A String", # The authority or certification body responsible for issuing the certification. At this time, the most common value is "EC" or “European_Commission” for energy labels in the EU. + "code": "A String", # The code of the certification. For example, for the EPREL certificate with the link https://eprel.ec.europa.eu/screen/product/dishwashers2019/123456 the code is 123456. The code is required for European Energy Labels. + "name": "A String", # The name of the certification. At this time, the most common value is "EPREL", which represents energy efficiency certifications in the EU European Registry for Energy Labeling (EPREL) database. }, ], "color": "A String", # Color of the item. @@ -251,10 +251,10 @@

Method Details

"ageGroup": "A String", # Target age group of the item. "brand": "A String", # Product Related Attributes.[14-36] Brand of the item. "certifications": [ # A list of certificates claimed by the CSS for the given product. - { # The certification for the product. - "authority": "A String", # Name of the certification body. - "code": "A String", # A unique code to identify the certification. - "name": "A String", # Name of the certification. + { # The certification for the product. Use the this attribute to describe certifications, such as energy efficiency ratings, associated with a product. + "authority": "A String", # The authority or certification body responsible for issuing the certification. At this time, the most common value is "EC" or “European_Commission” for energy labels in the EU. + "code": "A String", # The code of the certification. For example, for the EPREL certificate with the link https://eprel.ec.europa.eu/screen/product/dishwashers2019/123456 the code is 123456. The code is required for European Energy Labels. + "name": "A String", # The name of the certification. At this time, the most common value is "EPREL", which represents energy efficiency certifications in the EU European Registry for Energy Labeling (EPREL) database. }, ], "color": "A String", # Color of the item. diff --git a/docs/dyn/css_v1.accounts.cssProducts.html b/docs/dyn/css_v1.accounts.cssProducts.html index a6a59944490..261fb3bad69 100644 --- a/docs/dyn/css_v1.accounts.cssProducts.html +++ b/docs/dyn/css_v1.accounts.cssProducts.html @@ -115,10 +115,10 @@

Method Details

"ageGroup": "A String", # Target age group of the item. "brand": "A String", # Product Related Attributes.[14-36] Brand of the item. "certifications": [ # A list of certificates claimed by the CSS for the given product. - { # The certification for the product. - "authority": "A String", # Name of the certification body. - "code": "A String", # A unique code to identify the certification. - "name": "A String", # Name of the certification. + { # The certification for the product. Use the this attribute to describe certifications, such as energy efficiency ratings, associated with a product. + "authority": "A String", # The authority or certification body responsible for issuing the certification. At this time, the most common value is "EC" or “European_Commission” for energy labels in the EU. + "code": "A String", # The code of the certification. For example, for the EPREL certificate with the link https://eprel.ec.europa.eu/screen/product/dishwashers2019/123456 the code is 123456. The code is required for European Energy Labels. + "name": "A String", # The name of the certification. At this time, the most common value is "EPREL", which represents energy efficiency certifications in the EU European Registry for Energy Labeling (EPREL) database. }, ], "color": "A String", # Color of the item. @@ -282,10 +282,10 @@

Method Details

"ageGroup": "A String", # Target age group of the item. "brand": "A String", # Product Related Attributes.[14-36] Brand of the item. "certifications": [ # A list of certificates claimed by the CSS for the given product. - { # The certification for the product. - "authority": "A String", # Name of the certification body. - "code": "A String", # A unique code to identify the certification. - "name": "A String", # Name of the certification. + { # The certification for the product. Use the this attribute to describe certifications, such as energy efficiency ratings, associated with a product. + "authority": "A String", # The authority or certification body responsible for issuing the certification. At this time, the most common value is "EC" or “European_Commission” for energy labels in the EU. + "code": "A String", # The code of the certification. For example, for the EPREL certificate with the link https://eprel.ec.europa.eu/screen/product/dishwashers2019/123456 the code is 123456. The code is required for European Energy Labels. + "name": "A String", # The name of the certification. At this time, the most common value is "EPREL", which represents energy efficiency certifications in the EU European Registry for Energy Labeling (EPREL) database. }, ], "color": "A String", # Color of the item. diff --git a/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.html b/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.html index 26259690bbb..ebd80c14a4d 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.html +++ b/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.html @@ -117,7 +117,7 @@

Method Details

}, }, "audioInput": { # Represents the natural language speech audio to be processed. # The natural language speech audio to be processed. - "audio": "A String", # Required. The natural language speech audio to be processed. A single request can contain up to 1 minute of speech audio data. The transcribed text cannot contain more than 256 bytes for virtual agent interactions. + "audio": "A String", # Required. The natural language speech audio to be processed. A single request can contain up to 2 minutes of speech audio data. The transcribed text cannot contain more than 256 bytes for virtual agent interactions. "config": { # Instructs the speech recognizer on how to process the audio content. # Required. Instructs the speech recognizer how to process the speech audio. "audioEncoding": "A String", # Required. Audio encoding of the audio content to process. "bargeInConfig": { # Configuration of the barge-in behavior. Barge-in instructs the API to return a detected utterance at a proper time while the client is playing back the response audio from a previous request. When the client sees the utterance, it should stop the playback and immediately get ready for receiving the responses for the current request. The barge-in handling requires the client to start streaming audio input as soon as it starts playing back the audio from the previous response. The playback is modeled into two phases: * No barge-in phase: which goes first and during which speech detection should not be carried out. * Barge-in phase: which follows the no barge-in phase and during which the API starts speech detection and may inform the client that an utterance has been detected. Note that no-speech event is not expected in this phase. The client provides this configuration in terms of the durations of those two phases. The durations are measured in terms of the audio length from the start of the input audio. The flow goes like below: ``` --> Time without speech detection | utterance only | utterance or no-speech event | | +-------------+ | +------------+ | +---------------+ ----------+ no barge-in +-|-+ barge-in +-|-+ normal period +----------- +-------------+ | +------------+ | +---------------+ ``` No-speech event is a response with END_OF_UTTERANCE without any transcript following up. # Configuration of barge-in behavior during the streaming of input audio. diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.html b/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.html index e8bec902700..df5b76d5f57 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.html @@ -117,7 +117,7 @@

Method Details

}, }, "audioInput": { # Represents the natural language speech audio to be processed. # The natural language speech audio to be processed. - "audio": "A String", # Required. The natural language speech audio to be processed. A single request can contain up to 1 minute of speech audio data. The transcribed text cannot contain more than 256 bytes for virtual agent interactions. + "audio": "A String", # Required. The natural language speech audio to be processed. A single request can contain up to 2 minutes of speech audio data. The transcribed text cannot contain more than 256 bytes for virtual agent interactions. "config": { # Instructs the speech recognizer on how to process the audio content. # Required. Instructs the speech recognizer how to process the speech audio. "audioEncoding": "A String", # Required. Audio encoding of the audio content to process. "bargeInConfig": { # Configuration of the barge-in behavior. Barge-in instructs the API to return a detected utterance at a proper time while the client is playing back the response audio from a previous request. When the client sees the utterance, it should stop the playback and immediately get ready for receiving the responses for the current request. The barge-in handling requires the client to start streaming audio input as soon as it starts playing back the audio from the previous response. The playback is modeled into two phases: * No barge-in phase: which goes first and during which speech detection should not be carried out. * Barge-in phase: which follows the no barge-in phase and during which the API starts speech detection and may inform the client that an utterance has been detected. Note that no-speech event is not expected in this phase. The client provides this configuration in terms of the durations of those two phases. The durations are measured in terms of the audio length from the start of the input audio. The flow goes like below: ``` --> Time without speech detection | utterance only | utterance or no-speech event | | +-------------+ | +------------+ | +---------------+ ----------+ no barge-in +-|-+ barge-in +-|-+ normal period +----------- +-------------+ | +------------+ | +---------------+ ``` No-speech event is a response with END_OF_UTTERANCE without any transcript following up. # Configuration of barge-in behavior during the streaming of input audio. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html index 1902cb81a80..c6a82e54163 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html @@ -153,7 +153,7 @@

Method Details

"filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the Answer response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customers might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) "maxReturnResults": 42, # Number of search results to return. The default value is 10. "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents) + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents) }, "searchResultList": { # Search result list. # Search result list. "searchResults": [ # Search results. @@ -205,7 +205,7 @@

Method Details

An object of the form: { # Response message for ConversationalSearchService.AnswerQuery method. - "answer": { # Defines an answer. # Answer resource object. If AnswerQueryRequest.StepSpec.max_step_count is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API. + "answer": { # Defines an answer. # Answer resource object. If AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.max_rephrase_steps is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", ], @@ -289,7 +289,7 @@

Method Details

"snippetStatus": "A String", # Status of the snippet defined by the search team. }, ], - "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document (code pointer: http://shortn/_objzAfIiHq), or the Chunk in search result (code pointer: http://shortn/_Ipo6KFFGBL). + "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document , or the Chunk in search result . "a_key": "", # Properties of the object. }, "title": "A String", # Title. @@ -505,7 +505,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.sessions.answers.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.sessions.answers.html index dee378f44c7..a89732a9410 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.sessions.answers.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.sessions.answers.html @@ -184,7 +184,7 @@

Method Details

"snippetStatus": "A String", # Status of the snippet defined by the search team. }, ], - "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document (code pointer: http://shortn/_objzAfIiHq), or the Chunk in search result (code pointer: http://shortn/_Ipo6KFFGBL). + "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document , or the Chunk in search result . "a_key": "", # Properties of the object. }, "title": "A String", # Title. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html index c1e3772091c..dc6f44acd26 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html @@ -153,7 +153,7 @@

Method Details

"filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the Answer response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customers might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) "maxReturnResults": 42, # Number of search results to return. The default value is 10. "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents) + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents) }, "searchResultList": { # Search result list. # Search result list. "searchResults": [ # Search results. @@ -205,7 +205,7 @@

Method Details

An object of the form: { # Response message for ConversationalSearchService.AnswerQuery method. - "answer": { # Defines an answer. # Answer resource object. If AnswerQueryRequest.StepSpec.max_step_count is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API. + "answer": { # Defines an answer. # Answer resource object. If AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.max_rephrase_steps is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", ], @@ -289,7 +289,7 @@

Method Details

"snippetStatus": "A String", # Status of the snippet defined by the search team. }, ], - "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document (code pointer: http://shortn/_objzAfIiHq), or the Chunk in search result (code pointer: http://shortn/_Ipo6KFFGBL). + "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document , or the Chunk in search result . "a_key": "", # Properties of the object. }, "title": "A String", # Title. @@ -505,7 +505,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.sessions.answers.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.sessions.answers.html index ed3327f930e..3759f97e32e 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.sessions.answers.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.sessions.answers.html @@ -184,7 +184,7 @@

Method Details

"snippetStatus": "A String", # Status of the snippet defined by the search team. }, ], - "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document (code pointer: http://shortn/_objzAfIiHq), or the Chunk in search result (code pointer: http://shortn/_Ipo6KFFGBL). + "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document , or the Chunk in search result . "a_key": "", # Properties of the object. }, "title": "A String", # Title. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html index 26cdb02fa76..170838df867 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html @@ -153,7 +153,7 @@

Method Details

"filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the Answer response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customers might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) "maxReturnResults": 42, # Number of search results to return. The default value is 10. "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents) + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents) }, "searchResultList": { # Search result list. # Search result list. "searchResults": [ # Search results. @@ -205,7 +205,7 @@

Method Details

An object of the form: { # Response message for ConversationalSearchService.AnswerQuery method. - "answer": { # Defines an answer. # Answer resource object. If AnswerQueryRequest.StepSpec.max_step_count is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API. + "answer": { # Defines an answer. # Answer resource object. If AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.max_rephrase_steps is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", ], @@ -289,7 +289,7 @@

Method Details

"snippetStatus": "A String", # Status of the snippet defined by the search team. }, ], - "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document (code pointer: http://shortn/_objzAfIiHq), or the Chunk in search result (code pointer: http://shortn/_Ipo6KFFGBL). + "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document , or the Chunk in search result . "a_key": "", # Properties of the object. }, "title": "A String", # Title. @@ -505,7 +505,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.sessions.answers.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.sessions.answers.html index 1a446a88b92..0e4661a208d 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.sessions.answers.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.sessions.answers.html @@ -184,7 +184,7 @@

Method Details

"snippetStatus": "A String", # Status of the snippet defined by the search team. }, ], - "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document (code pointer: http://shortn/_objzAfIiHq), or the Chunk in search result (code pointer: http://shortn/_Ipo6KFFGBL). + "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document , or the Chunk in search result . "a_key": "", # Properties of the object. }, "title": "A String", # Title. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.html b/docs/dyn/discoveryengine_v1.projects.locations.html index 8396d5bdb2a..4631def3024 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.html @@ -89,6 +89,11 @@

Instance Methods

Returns the groundingConfigs Resource.

+

+ identity_mapping_stores() +

+

Returns the identity_mapping_stores Resource.

+

operations()

diff --git a/docs/dyn/discoveryengine_v1.projects.locations.identity_mapping_stores.html b/docs/dyn/discoveryengine_v1.projects.locations.identity_mapping_stores.html new file mode 100644 index 00000000000..2aebaab5a22 --- /dev/null +++ b/docs/dyn/discoveryengine_v1.projects.locations.identity_mapping_stores.html @@ -0,0 +1,91 @@ + + + +

Discovery Engine API . projects . locations . identity_mapping_stores

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html index cf6235dad8b..07787261a60 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html @@ -179,7 +179,7 @@

Method Details

"filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the Answer response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customers might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) "maxReturnResults": 42, # Number of search results to return. The default value is 10. "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents) + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents) }, "searchResultList": { # Search result list. # Search result list. "searchResults": [ # Search results. @@ -231,7 +231,7 @@

Method Details

An object of the form: { # Response message for ConversationalSearchService.AnswerQuery method. - "answer": { # Defines an answer. # Answer resource object. If AnswerQueryRequest.StepSpec.max_step_count is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API. + "answer": { # Defines an answer. # Answer resource object. If AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.max_rephrase_steps is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", ], @@ -315,7 +315,7 @@

Method Details

"snippetStatus": "A String", # Status of the snippet defined by the search team. }, ], - "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document (code pointer: http://shortn/_objzAfIiHq), or the Chunk in search result (code pointer: http://shortn/_Ipo6KFFGBL). + "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document , or the Chunk in search result . "a_key": "", # Properties of the object. }, "title": "A String", # Title. @@ -405,7 +405,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -512,7 +512,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -625,7 +625,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -721,7 +721,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -972,7 +972,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -1049,7 +1049,7 @@

Method Details

"languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate. "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Default to Condition.DISABLED. - "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in Servingconfig.geo_search_query_detection_field_names. + "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names. "A String", ], }, @@ -1072,6 +1072,7 @@

Method Details

"searchAsYouTypeSpec": { # Specification for search as you type in search requests. # Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical. "condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED. }, + "servingConfig": "A String", # Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.sessions.answers.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.sessions.answers.html index 9c715ecdad6..cb0e428c6c8 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.sessions.answers.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.sessions.answers.html @@ -184,7 +184,7 @@

Method Details

"snippetStatus": "A String", # Status of the snippet defined by the search team. }, ], - "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document (code pointer: http://shortn/_objzAfIiHq), or the Chunk in search result (code pointer: http://shortn/_Ipo6KFFGBL). + "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document , or the Chunk in search result . "a_key": "", # Properties of the object. }, "title": "A String", # Title. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.siteSearchEngine.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.siteSearchEngine.html index 92717248ea3..e19dee476ac 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.siteSearchEngine.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.siteSearchEngine.html @@ -102,9 +102,15 @@

Instance Methods

fetchDomainVerificationStatus_next()

Retrieves the next page of results.

+

+ getUriPatternDocumentData(siteSearchEngine, x__xgafv=None)

+

Gets the URI Pattern to Document data mapping for an Advanced Site Search DataStore.

recrawlUris(siteSearchEngine, body=None, x__xgafv=None)

Request on-demand recrawl for a list of URIs.

+

+ setUriPatternDocumentData(siteSearchEngine, body=None, x__xgafv=None)

+

Sets the URI Pattern to Document data mapping for an Advanced Site Search DataStore.

Method Details

batchVerifyTargetSites(parent, body=None, x__xgafv=None) @@ -291,6 +297,29 @@

Method Details

+
+ getUriPatternDocumentData(siteSearchEngine, x__xgafv=None) +
Gets the URI Pattern to Document data mapping for an Advanced Site Search DataStore.
+
+Args:
+  siteSearchEngine: string, Required. Full resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`. (required)
+  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 SiteSearchEngineService.GetUriPatternDocumentData method.
+  "documentDataMap": { # Document data keyed by URI pattern. For example: document_data_map = { "www.url1.com/*": { "Categories": ["category1", "category2"] }, "www.url2.com/*": { "Categories": ["category3"] } }
+    "a_key": {
+      "a_key": "", # Properties of the object.
+    },
+  },
+}
+
+
recrawlUris(siteSearchEngine, body=None, x__xgafv=None)
Request on-demand recrawl for a list of URIs.
@@ -335,4 +364,54 @@ 

Method Details

}
+
+ setUriPatternDocumentData(siteSearchEngine, body=None, x__xgafv=None) +
Sets the URI Pattern to Document data mapping for an Advanced Site Search DataStore.
+
+Args:
+  siteSearchEngine: string, Required. Full resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for SiteSearchEngineService.SetUriPatternDocumentData method.
+  "documentDataMap": { # Document data keyed by URI pattern. Each entry must be consistent with the Schema. For example: Schema = { "type": "object", "properties": { "Categories": { "type": "array", "items": { "retrievable": true, "type": "string" } } } document_data_map = { "www.url1.com/*": { "Categories": ["category1", "category2"] }, "www.url2.com/*": { "Categories": ["category3"] } }
+    "a_key": {
+      "a_key": "", # Properties of the object.
+    },
+  },
+  "emptyDocumentDataMap": True or False, # If true, clears the document data map. If true, SetUriPatternDocumentDataRequest.document_data_map must be empty.
+  "schema": { # Optional. If not provided, the current Schema is used. If provided, validates and updates the Schema. If validation fails, an error is returned.
+    "a_key": "", # Properties of the object.
+  },
+}
+
+  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/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html index fca18948394..3106e8aca61 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html @@ -179,7 +179,7 @@

Method Details

"filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the Answer response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customers might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) "maxReturnResults": 42, # Number of search results to return. The default value is 10. "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents) + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents) }, "searchResultList": { # Search result list. # Search result list. "searchResults": [ # Search results. @@ -231,7 +231,7 @@

Method Details

An object of the form: { # Response message for ConversationalSearchService.AnswerQuery method. - "answer": { # Defines an answer. # Answer resource object. If AnswerQueryRequest.StepSpec.max_step_count is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API. + "answer": { # Defines an answer. # Answer resource object. If AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.max_rephrase_steps is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", ], @@ -315,7 +315,7 @@

Method Details

"snippetStatus": "A String", # Status of the snippet defined by the search team. }, ], - "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document (code pointer: http://shortn/_objzAfIiHq), or the Chunk in search result (code pointer: http://shortn/_Ipo6KFFGBL). + "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document , or the Chunk in search result . "a_key": "", # Properties of the object. }, "title": "A String", # Title. @@ -405,7 +405,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -512,7 +512,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -625,7 +625,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -721,7 +721,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -972,7 +972,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -1049,7 +1049,7 @@

Method Details

"languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate. "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Default to Condition.DISABLED. - "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in Servingconfig.geo_search_query_detection_field_names. + "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names. "A String", ], }, @@ -1072,6 +1072,7 @@

Method Details

"searchAsYouTypeSpec": { # Specification for search as you type in search requests. # Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical. "condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED. }, + "servingConfig": "A String", # Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.answers.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.answers.html index 19d73e2fc45..7a4c93028cd 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.answers.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.answers.html @@ -184,7 +184,7 @@

Method Details

"snippetStatus": "A String", # Status of the snippet defined by the search team. }, ], - "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document (code pointer: http://shortn/_objzAfIiHq), or the Chunk in search result (code pointer: http://shortn/_Ipo6KFFGBL). + "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document , or the Chunk in search result . "a_key": "", # Properties of the object. }, "title": "A String", # Title. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html index c321c594903..b71e82b412e 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html @@ -179,7 +179,7 @@

Method Details

"filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the Answer response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customers might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) "maxReturnResults": 42, # Number of search results to return. The default value is 10. "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents) + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents) }, "searchResultList": { # Search result list. # Search result list. "searchResults": [ # Search results. @@ -231,7 +231,7 @@

Method Details

An object of the form: { # Response message for ConversationalSearchService.AnswerQuery method. - "answer": { # Defines an answer. # Answer resource object. If AnswerQueryRequest.StepSpec.max_step_count is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API. + "answer": { # Defines an answer. # Answer resource object. If AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.max_rephrase_steps is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", ], @@ -315,7 +315,7 @@

Method Details

"snippetStatus": "A String", # Status of the snippet defined by the search team. }, ], - "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document (code pointer: http://shortn/_objzAfIiHq), or the Chunk in search result (code pointer: http://shortn/_Ipo6KFFGBL). + "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document , or the Chunk in search result . "a_key": "", # Properties of the object. }, "title": "A String", # Title. @@ -405,7 +405,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -512,7 +512,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -625,7 +625,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -721,7 +721,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -972,7 +972,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -1049,7 +1049,7 @@

Method Details

"languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate. "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Default to Condition.DISABLED. - "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in Servingconfig.geo_search_query_detection_field_names. + "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names. "A String", ], }, @@ -1072,6 +1072,7 @@

Method Details

"searchAsYouTypeSpec": { # Specification for search as you type in search requests. # Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical. "condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED. }, + "servingConfig": "A String", # Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.sessions.answers.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.sessions.answers.html index 8e9fe4835bc..5bdbc0a1587 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.sessions.answers.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.sessions.answers.html @@ -184,7 +184,7 @@

Method Details

"snippetStatus": "A String", # Status of the snippet defined by the search team. }, ], - "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document (code pointer: http://shortn/_objzAfIiHq), or the Chunk in search result (code pointer: http://shortn/_Ipo6KFFGBL). + "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document , or the Chunk in search result . "a_key": "", # Properties of the object. }, "title": "A String", # Title. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.evaluations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.evaluations.html index 4fd237b35d4..d3f9e0c86f9 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.evaluations.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.evaluations.html @@ -82,10 +82,852 @@

Instance Methods

close()

Close httplib2 connections.

+

+ create(parent, body=None, x__xgafv=None)

+

Creates a Evaluation. Upon creation, the evaluation will be automatically triggered and begin execution.

+

+ get(name, x__xgafv=None)

+

Gets a Evaluation.

+

+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)

+

Gets a list of Evaluations.

+

+ listResults(evaluation, pageSize=None, pageToken=None, x__xgafv=None)

+

Gets a list of results for a given a Evaluation.

+

+ listResults_next()

+

Retrieves the next page of results.

+

+ list_next()

+

Retrieves the next page of results.

Method Details

close()
Close httplib2 connections.
+
+ create(parent, body=None, x__xgafv=None) +
Creates a Evaluation. Upon creation, the evaluation will be automatically triggered and begin execution.
+
+Args:
+  parent: string, Required. The parent resource name, such as `projects/{project}/locations/{location}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data.
+  "createTime": "A String", # Output only. Timestamp the Evaluation was created at.
+  "endTime": "A String", # Output only. Timestamp the Evaluation was completed at.
+  "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). # Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED.
+    "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.
+  },
+  "errorSamples": [ # Output only. A sample of errors encountered while processing the request.
+    { # 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).
+      "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.
+    },
+  ],
+  "evaluationSpec": { # Describes the specification of the evaluation. # Required. The specification of the evaluation.
+    "querySetSpec": { # Describes the specification of the query set. # Required. The specification of the query set.
+      "sampleQuerySet": "A String", # Required. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.
+    },
+    "searchRequest": { # Request message for SearchService.Search method. # Required. The search request that is used to perform the evaluation. Only the following fields within SearchRequest are supported; if any other fields are provided, an UNSUPPORTED error will be returned: * SearchRequest.serving_config * SearchRequest.branch * SearchRequest.canonical_filter * SearchRequest.query_expansion_spec * SearchRequest.spell_correction_spec * SearchRequest.content_search_spec * SearchRequest.user_pseudo_id
+      "boostSpec": { # Boost specification to boost certain documents. # Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)
+        "conditionBoostSpecs": [ # Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.
+          { # Boost applies to documents which match a condition.
+            "boost": 3.14, # Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied.
+            "boostControlSpec": { # Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. # Complex specification for custom ranking based on customer defined attribute value.
+              "attributeType": "A String", # The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).
+              "controlPoints": [ # The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.
+                { # The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).
+                  "attributeValue": "A String", # Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.
+                  "boostAmount": 3.14, # The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.
+                },
+              ],
+              "fieldName": "A String", # The name of the field whose value will be used to determine the boost amount.
+              "interpolationType": "A String", # The interpolation type to be applied to connect the control points listed below.
+            },
+            "condition": "A String", # An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": `(document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))`
+          },
+        ],
+      },
+      "branch": "A String", # The branch resource name, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Use `default_branch` as the branch ID or leave this field empty, to search documents under the default branch.
+      "canonicalFilter": "A String", # The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about filter syntax, see SearchRequest.filter.
+      "contentSearchSpec": { # A specification for configuring the behavior of content search. # A specification for configuring the behavior of content search.
+        "chunkSpec": { # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS
+          "numNextChunks": 42, # The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned.
+          "numPreviousChunks": 42, # The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned.
+        },
+        "extractiveContentSpec": { # A specification for configuring the extractive content in a search response. # If there is no extractive_content_spec provided, there will be no extractive answer in the search response.
+          "maxExtractiveAnswerCount": 42, # The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult.
+          "maxExtractiveSegmentCount": 42, # The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`.
+          "numNextSegments": 42, # Return at most `num_next_segments` segments after each selected segments.
+          "numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.
+          "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`.
+        },
+        "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.
+        "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response.
+          "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0.
+          "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet.
+          "returnSnippet": True or False, # If `true`, then return snippet. If no snippet can be generated, we return "No snippet is available for this page." A `snippet_status` with `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned.
+        },
+        "summarySpec": { # A specification for configuring a summary returned in a search response. # If `summarySpec` is not specified, summaries are not included in the search response.
+          "ignoreAdversarialQuery": True or False, # Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead.
+          "ignoreNonSummarySeekingQuery": True or False, # Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead.
+          "includeCitations": True or False, # Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results.
+          "languageCode": "A String", # Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.
+          "modelPromptSpec": { # Specification of the prompt to use with the model. # If specified, the spec will be used to modify the prompt provided to the LLM.
+            "preamble": "A String", # Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide.
+          },
+          "modelSpec": { # Specification of the model. # If specified, the spec will be used to modify the model specification provided to the LLM.
+            "version": "A String", # The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). * `preview`: string. (Public preview) Uses a preview model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).
+          },
+          "summaryResultCount": 42, # The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.
+          "useSemanticChunks": True or False, # If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list.
+        },
+      },
+      "customFineTuningSpec": { # Defines custom fine tuning spec. # Custom fine tuning configs. If set, it has higher priority than the configs set in ServingConfig.custom_fine_tuning_spec.
+        "enableSearchAdaptor": True or False, # Whether or not to enable and include custom fine tuned search adaptor model.
+      },
+      "dataStoreSpecs": [ # Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.
+        { # A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned.
+          "dataStore": "A String", # Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
+        },
+      ],
+      "embeddingSpec": { # The specification that uses customized query embedding vector to do semantic document retrieval. # Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path.
+        "embeddingVectors": [ # The embedding vector used for retrieval. Limit to 1.
+          { # Embedding vector.
+            "fieldPath": "A String", # Embedding field path in schema.
+            "vector": [ # Query embedding vector.
+              3.14,
+            ],
+          },
+        ],
+      },
+      "facetSpecs": [ # Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.
+        { # A facet specification to perform faceted search.
+          "enableDynamicPosition": True or False, # Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false * "brands", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how API orders "gender" and "rating" facets. However, notice that "price" and "brands" are always ranked at first and second position because their enable_dynamic_position is false.
+          "excludedFilterKeys": [ # List of keys to exclude when faceting. By default, FacetKey.key is not excluded from the filter unless it is listed in this field. Listing a facet key in this field allows its values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned. For example, suppose there are 100 documents with the color facet "Red" and 200 documents with the color facet "Blue". A query containing the filter "color:ANY("Red")" and having "color" as FacetKey.key would by default return only "Red" documents in the search results, and also return "Red" with count 100 as the only color facet. Although there are also blue documents available, "Blue" would not be shown as an available facet value. If "color" is listed in "excludedFilterKeys", then the query returns the facet values "Red" with count 100 and "Blue" with count 200, because the "color" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly filtered to return only "Red" documents. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.
+            "A String",
+          ],
+          "facetKey": { # Specifies how a facet is computed. # Required. The facet key specification.
+            "caseInsensitive": True or False, # True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.
+            "contains": [ # Only get facet values that contain the given strings. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "contains" to "2022", the "category" facet only contains "Action > 2022" and "Sci-Fi > 2022". Only supported on textual fields. Maximum is 10.
+              "A String",
+            ],
+            "intervals": [ # Set only if values should be bucketed into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30.
+              { # A floating point interval.
+                "exclusiveMaximum": 3.14, # Exclusive upper bound.
+                "exclusiveMinimum": 3.14, # Exclusive lower bound.
+                "maximum": 3.14, # Inclusive upper bound.
+                "minimum": 3.14, # Inclusive lower bound.
+              },
+            ],
+            "key": "A String", # Required. Supported textual and numerical facet keys in Document object, over which the facet values are computed. Facet key is case-sensitive.
+            "orderBy": "A String", # The order in which documents are returned. Allowed values are: * "count desc", which means order by SearchResponse.Facet.values.count descending. * "value desc", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets. If not set, textual values are sorted in [natural order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals.
+            "prefixes": [ # Only get facet values that start with the given string prefix. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "prefixes" to "Action", the "category" facet only contains "Action > 2022" and "Action > 2021". Only supported on textual fields. Maximum is 10.
+              "A String",
+            ],
+            "restrictedValues": [ # Only get facet for the given restricted values. Only supported on textual fields. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "restricted_values" to "Action > 2022", the "category" facet only contains "Action > 2022". Only supported on textual fields. Maximum is 10.
+              "A String",
+            ],
+          },
+          "limit": 42, # Maximum facet values that are returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. For aggregation in healthcare search, when the [FacetKey.key] is "healthcare_aggregation_key", the limit will be overridden to 10,000 internally, regardless of the value set here. If this field is negative, an `INVALID_ARGUMENT` is returned.
+        },
+      ],
+      "filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
+      "imageQuery": { # Specifies the image query input. # Raw image query.
+        "imageBytes": "A String", # Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP.
+      },
+      "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.
+      "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done.
+        "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Default to Condition.DISABLED.
+        "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.
+          "A String",
+        ],
+      },
+      "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.
+      "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering for retail search, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
+      "pageSize": 42, # Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.
+      "pageToken": "A String", # A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.
+      "params": { # Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. For example, `user_country_code: "au"` For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example, `search_type: 1`
+        "a_key": "",
+      },
+      "query": "A String", # Raw search query.
+      "queryExpansionSpec": { # Specification to determine under which conditions query expansion should occur. # The query expansion specification that specifies the conditions under which query expansion occurs.
+        "condition": "A String", # The condition under which query expansion should occur. Default to Condition.DISABLED.
+        "pinUnexpandedResults": True or False, # Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results.
+      },
+      "rankingExpression": "A String", # The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The ranking expression is a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.
+      "regionCode": "A String", # The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.
+      "relevanceThreshold": "A String", # The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information.
+      "safeSearch": True or False, # Whether to turn on safe search. This is only supported for website search.
+      "searchAsYouTypeSpec": { # Specification for search as you type in search requests. # Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical.
+        "condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED.
+      },
+      "servingConfig": "A String", # Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.
+      "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.
+      "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set.
+        "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID.
+        "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is simliar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode.
+      },
+      "spellCorrectionSpec": { # The specification for query spell correction. # The spell correction specification that specifies the mode under which spell correction takes effect.
+        "mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO.
+      },
+      "userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics.
+        "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set.
+        "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+      },
+      "userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * 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. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.
+        "a_key": "A String",
+      },
+      "userPseudoId": "A String", # A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+    },
+  },
+  "name": "A String", # Immutable. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+  "qualityMetrics": { # Describes the metrics produced by the evaluation. # Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet. Only populated when the evaluation's state is SUCCEEDED.
+    "docNdcg": { # Stores the metric values at specific top-k levels. # Normalized discounted cumulative gain (NDCG) per document, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved documents (D1, D2, D3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [D3 (0), D1 (1), D2 (1)] Ideal: [D1 (1), D2 (1), D3 (0)] Calculate NDCG@3 for each SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693
+      "top1": 3.14, # The top-1 value.
+      "top10": 3.14, # The top-10 value.
+      "top3": 3.14, # The top-3 value.
+      "top5": 3.14, # The top-5 value.
+    },
+    "docPrecision": { # Stores the metric values at specific top-k levels. # Precision per document, at various top-k cutoff levels. Precision is the fraction of retrieved documents that are relevant. Example (top-5): * For a single SampleQuery, If 4 out of 5 retrieved documents in the top-5 are relevant, precision@5 = 4/5 = 0.8
+      "top1": 3.14, # The top-1 value.
+      "top10": 3.14, # The top-10 value.
+      "top3": 3.14, # The top-3 value.
+      "top5": 3.14, # The top-5 value.
+    },
+    "docRecall": { # Stores the metric values at specific top-k levels. # Recall per document, at various top-k cutoff levels. Recall is the fraction of relevant documents retrieved out of all relevant documents. Example (top-5): * For a single SampleQuery, If 3 out of 5 relevant documents are retrieved in the top-5, recall@5 = 3/5 = 0.6
+      "top1": 3.14, # The top-1 value.
+      "top10": 3.14, # The top-10 value.
+      "top3": 3.14, # The top-3 value.
+      "top5": 3.14, # The top-5 value.
+    },
+    "pageNdcg": { # Stores the metric values at specific top-k levels. # Normalized discounted cumulative gain (NDCG) per page, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved pages (P1, P2, P3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [P3 (0), P1 (1), P2 (1)] Ideal: [P1 (1), P2 (1), P3 (0)] Calculate NDCG@3 for SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693
+      "top1": 3.14, # The top-1 value.
+      "top10": 3.14, # The top-10 value.
+      "top3": 3.14, # The top-3 value.
+      "top5": 3.14, # The top-5 value.
+    },
+    "pageRecall": { # Stores the metric values at specific top-k levels. # Recall per page, at various top-k cutoff levels. Recall is the fraction of relevant pages retrieved out of all relevant pages. Example (top-5): * For a single SampleQuery, if 3 out of 5 relevant pages are retrieved in the top-5, recall@5 = 3/5 = 0.6
+      "top1": 3.14, # The top-1 value.
+      "top10": 3.14, # The top-10 value.
+      "top3": 3.14, # The top-3 value.
+      "top5": 3.14, # The top-5 value.
+    },
+  },
+  "state": "A String", # Output only. The state of the evaluation.
+}
+
+  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 a Evaluation.
+
+Args:
+  name: string, Required. Full resource name of Evaluation, such as `projects/{project}/locations/{location}/evaluations/{evaluation}`. If the caller does not have permission to access the Evaluation, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Evaluation does not exist, a NOT_FOUND error is returned. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data.
+  "createTime": "A String", # Output only. Timestamp the Evaluation was created at.
+  "endTime": "A String", # Output only. Timestamp the Evaluation was completed at.
+  "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). # Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED.
+    "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.
+  },
+  "errorSamples": [ # Output only. A sample of errors encountered while processing the request.
+    { # 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).
+      "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.
+    },
+  ],
+  "evaluationSpec": { # Describes the specification of the evaluation. # Required. The specification of the evaluation.
+    "querySetSpec": { # Describes the specification of the query set. # Required. The specification of the query set.
+      "sampleQuerySet": "A String", # Required. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.
+    },
+    "searchRequest": { # Request message for SearchService.Search method. # Required. The search request that is used to perform the evaluation. Only the following fields within SearchRequest are supported; if any other fields are provided, an UNSUPPORTED error will be returned: * SearchRequest.serving_config * SearchRequest.branch * SearchRequest.canonical_filter * SearchRequest.query_expansion_spec * SearchRequest.spell_correction_spec * SearchRequest.content_search_spec * SearchRequest.user_pseudo_id
+      "boostSpec": { # Boost specification to boost certain documents. # Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)
+        "conditionBoostSpecs": [ # Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.
+          { # Boost applies to documents which match a condition.
+            "boost": 3.14, # Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied.
+            "boostControlSpec": { # Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. # Complex specification for custom ranking based on customer defined attribute value.
+              "attributeType": "A String", # The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).
+              "controlPoints": [ # The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.
+                { # The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).
+                  "attributeValue": "A String", # Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.
+                  "boostAmount": 3.14, # The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.
+                },
+              ],
+              "fieldName": "A String", # The name of the field whose value will be used to determine the boost amount.
+              "interpolationType": "A String", # The interpolation type to be applied to connect the control points listed below.
+            },
+            "condition": "A String", # An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": `(document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))`
+          },
+        ],
+      },
+      "branch": "A String", # The branch resource name, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Use `default_branch` as the branch ID or leave this field empty, to search documents under the default branch.
+      "canonicalFilter": "A String", # The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about filter syntax, see SearchRequest.filter.
+      "contentSearchSpec": { # A specification for configuring the behavior of content search. # A specification for configuring the behavior of content search.
+        "chunkSpec": { # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS
+          "numNextChunks": 42, # The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned.
+          "numPreviousChunks": 42, # The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned.
+        },
+        "extractiveContentSpec": { # A specification for configuring the extractive content in a search response. # If there is no extractive_content_spec provided, there will be no extractive answer in the search response.
+          "maxExtractiveAnswerCount": 42, # The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult.
+          "maxExtractiveSegmentCount": 42, # The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`.
+          "numNextSegments": 42, # Return at most `num_next_segments` segments after each selected segments.
+          "numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.
+          "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`.
+        },
+        "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.
+        "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response.
+          "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0.
+          "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet.
+          "returnSnippet": True or False, # If `true`, then return snippet. If no snippet can be generated, we return "No snippet is available for this page." A `snippet_status` with `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned.
+        },
+        "summarySpec": { # A specification for configuring a summary returned in a search response. # If `summarySpec` is not specified, summaries are not included in the search response.
+          "ignoreAdversarialQuery": True or False, # Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead.
+          "ignoreNonSummarySeekingQuery": True or False, # Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead.
+          "includeCitations": True or False, # Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results.
+          "languageCode": "A String", # Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.
+          "modelPromptSpec": { # Specification of the prompt to use with the model. # If specified, the spec will be used to modify the prompt provided to the LLM.
+            "preamble": "A String", # Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide.
+          },
+          "modelSpec": { # Specification of the model. # If specified, the spec will be used to modify the model specification provided to the LLM.
+            "version": "A String", # The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). * `preview`: string. (Public preview) Uses a preview model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).
+          },
+          "summaryResultCount": 42, # The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.
+          "useSemanticChunks": True or False, # If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list.
+        },
+      },
+      "customFineTuningSpec": { # Defines custom fine tuning spec. # Custom fine tuning configs. If set, it has higher priority than the configs set in ServingConfig.custom_fine_tuning_spec.
+        "enableSearchAdaptor": True or False, # Whether or not to enable and include custom fine tuned search adaptor model.
+      },
+      "dataStoreSpecs": [ # Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.
+        { # A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned.
+          "dataStore": "A String", # Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
+        },
+      ],
+      "embeddingSpec": { # The specification that uses customized query embedding vector to do semantic document retrieval. # Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path.
+        "embeddingVectors": [ # The embedding vector used for retrieval. Limit to 1.
+          { # Embedding vector.
+            "fieldPath": "A String", # Embedding field path in schema.
+            "vector": [ # Query embedding vector.
+              3.14,
+            ],
+          },
+        ],
+      },
+      "facetSpecs": [ # Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.
+        { # A facet specification to perform faceted search.
+          "enableDynamicPosition": True or False, # Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false * "brands", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how API orders "gender" and "rating" facets. However, notice that "price" and "brands" are always ranked at first and second position because their enable_dynamic_position is false.
+          "excludedFilterKeys": [ # List of keys to exclude when faceting. By default, FacetKey.key is not excluded from the filter unless it is listed in this field. Listing a facet key in this field allows its values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned. For example, suppose there are 100 documents with the color facet "Red" and 200 documents with the color facet "Blue". A query containing the filter "color:ANY("Red")" and having "color" as FacetKey.key would by default return only "Red" documents in the search results, and also return "Red" with count 100 as the only color facet. Although there are also blue documents available, "Blue" would not be shown as an available facet value. If "color" is listed in "excludedFilterKeys", then the query returns the facet values "Red" with count 100 and "Blue" with count 200, because the "color" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly filtered to return only "Red" documents. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.
+            "A String",
+          ],
+          "facetKey": { # Specifies how a facet is computed. # Required. The facet key specification.
+            "caseInsensitive": True or False, # True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.
+            "contains": [ # Only get facet values that contain the given strings. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "contains" to "2022", the "category" facet only contains "Action > 2022" and "Sci-Fi > 2022". Only supported on textual fields. Maximum is 10.
+              "A String",
+            ],
+            "intervals": [ # Set only if values should be bucketed into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30.
+              { # A floating point interval.
+                "exclusiveMaximum": 3.14, # Exclusive upper bound.
+                "exclusiveMinimum": 3.14, # Exclusive lower bound.
+                "maximum": 3.14, # Inclusive upper bound.
+                "minimum": 3.14, # Inclusive lower bound.
+              },
+            ],
+            "key": "A String", # Required. Supported textual and numerical facet keys in Document object, over which the facet values are computed. Facet key is case-sensitive.
+            "orderBy": "A String", # The order in which documents are returned. Allowed values are: * "count desc", which means order by SearchResponse.Facet.values.count descending. * "value desc", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets. If not set, textual values are sorted in [natural order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals.
+            "prefixes": [ # Only get facet values that start with the given string prefix. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "prefixes" to "Action", the "category" facet only contains "Action > 2022" and "Action > 2021". Only supported on textual fields. Maximum is 10.
+              "A String",
+            ],
+            "restrictedValues": [ # Only get facet for the given restricted values. Only supported on textual fields. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "restricted_values" to "Action > 2022", the "category" facet only contains "Action > 2022". Only supported on textual fields. Maximum is 10.
+              "A String",
+            ],
+          },
+          "limit": 42, # Maximum facet values that are returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. For aggregation in healthcare search, when the [FacetKey.key] is "healthcare_aggregation_key", the limit will be overridden to 10,000 internally, regardless of the value set here. If this field is negative, an `INVALID_ARGUMENT` is returned.
+        },
+      ],
+      "filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
+      "imageQuery": { # Specifies the image query input. # Raw image query.
+        "imageBytes": "A String", # Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP.
+      },
+      "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.
+      "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done.
+        "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Default to Condition.DISABLED.
+        "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.
+          "A String",
+        ],
+      },
+      "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.
+      "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering for retail search, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
+      "pageSize": 42, # Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.
+      "pageToken": "A String", # A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.
+      "params": { # Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. For example, `user_country_code: "au"` For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example, `search_type: 1`
+        "a_key": "",
+      },
+      "query": "A String", # Raw search query.
+      "queryExpansionSpec": { # Specification to determine under which conditions query expansion should occur. # The query expansion specification that specifies the conditions under which query expansion occurs.
+        "condition": "A String", # The condition under which query expansion should occur. Default to Condition.DISABLED.
+        "pinUnexpandedResults": True or False, # Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results.
+      },
+      "rankingExpression": "A String", # The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The ranking expression is a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.
+      "regionCode": "A String", # The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.
+      "relevanceThreshold": "A String", # The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information.
+      "safeSearch": True or False, # Whether to turn on safe search. This is only supported for website search.
+      "searchAsYouTypeSpec": { # Specification for search as you type in search requests. # Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical.
+        "condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED.
+      },
+      "servingConfig": "A String", # Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.
+      "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.
+      "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set.
+        "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID.
+        "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is simliar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode.
+      },
+      "spellCorrectionSpec": { # The specification for query spell correction. # The spell correction specification that specifies the mode under which spell correction takes effect.
+        "mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO.
+      },
+      "userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics.
+        "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set.
+        "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+      },
+      "userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * 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. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.
+        "a_key": "A String",
+      },
+      "userPseudoId": "A String", # A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+    },
+  },
+  "name": "A String", # Immutable. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+  "qualityMetrics": { # Describes the metrics produced by the evaluation. # Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet. Only populated when the evaluation's state is SUCCEEDED.
+    "docNdcg": { # Stores the metric values at specific top-k levels. # Normalized discounted cumulative gain (NDCG) per document, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved documents (D1, D2, D3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [D3 (0), D1 (1), D2 (1)] Ideal: [D1 (1), D2 (1), D3 (0)] Calculate NDCG@3 for each SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693
+      "top1": 3.14, # The top-1 value.
+      "top10": 3.14, # The top-10 value.
+      "top3": 3.14, # The top-3 value.
+      "top5": 3.14, # The top-5 value.
+    },
+    "docPrecision": { # Stores the metric values at specific top-k levels. # Precision per document, at various top-k cutoff levels. Precision is the fraction of retrieved documents that are relevant. Example (top-5): * For a single SampleQuery, If 4 out of 5 retrieved documents in the top-5 are relevant, precision@5 = 4/5 = 0.8
+      "top1": 3.14, # The top-1 value.
+      "top10": 3.14, # The top-10 value.
+      "top3": 3.14, # The top-3 value.
+      "top5": 3.14, # The top-5 value.
+    },
+    "docRecall": { # Stores the metric values at specific top-k levels. # Recall per document, at various top-k cutoff levels. Recall is the fraction of relevant documents retrieved out of all relevant documents. Example (top-5): * For a single SampleQuery, If 3 out of 5 relevant documents are retrieved in the top-5, recall@5 = 3/5 = 0.6
+      "top1": 3.14, # The top-1 value.
+      "top10": 3.14, # The top-10 value.
+      "top3": 3.14, # The top-3 value.
+      "top5": 3.14, # The top-5 value.
+    },
+    "pageNdcg": { # Stores the metric values at specific top-k levels. # Normalized discounted cumulative gain (NDCG) per page, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved pages (P1, P2, P3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [P3 (0), P1 (1), P2 (1)] Ideal: [P1 (1), P2 (1), P3 (0)] Calculate NDCG@3 for SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693
+      "top1": 3.14, # The top-1 value.
+      "top10": 3.14, # The top-10 value.
+      "top3": 3.14, # The top-3 value.
+      "top5": 3.14, # The top-5 value.
+    },
+    "pageRecall": { # Stores the metric values at specific top-k levels. # Recall per page, at various top-k cutoff levels. Recall is the fraction of relevant pages retrieved out of all relevant pages. Example (top-5): * For a single SampleQuery, if 3 out of 5 relevant pages are retrieved in the top-5, recall@5 = 3/5 = 0.6
+      "top1": 3.14, # The top-1 value.
+      "top10": 3.14, # The top-10 value.
+      "top3": 3.14, # The top-3 value.
+      "top5": 3.14, # The top-5 value.
+    },
+  },
+  "state": "A String", # Output only. The state of the evaluation.
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Gets a list of Evaluations.
+
+Args:
+  parent: string, Required. The parent location resource name, such as `projects/{project}/locations/{location}`. If the caller does not have permission to list Evaluations under this location, regardless of whether or not this location exists, a `PERMISSION_DENIED` error is returned. (required)
+  pageSize: integer, Maximum number of Evaluations to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.
+  pageToken: string, A page token ListEvaluationsResponse.next_page_token, received from a previous EvaluationService.ListEvaluations call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to EvaluationService.ListEvaluations must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error 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 EvaluationService.ListEvaluations method.
+  "evaluations": [ # The Evaluations.
+    { # An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data.
+      "createTime": "A String", # Output only. Timestamp the Evaluation was created at.
+      "endTime": "A String", # Output only. Timestamp the Evaluation was completed at.
+      "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). # Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED.
+        "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.
+      },
+      "errorSamples": [ # Output only. A sample of errors encountered while processing the request.
+        { # 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).
+          "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.
+        },
+      ],
+      "evaluationSpec": { # Describes the specification of the evaluation. # Required. The specification of the evaluation.
+        "querySetSpec": { # Describes the specification of the query set. # Required. The specification of the query set.
+          "sampleQuerySet": "A String", # Required. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.
+        },
+        "searchRequest": { # Request message for SearchService.Search method. # Required. The search request that is used to perform the evaluation. Only the following fields within SearchRequest are supported; if any other fields are provided, an UNSUPPORTED error will be returned: * SearchRequest.serving_config * SearchRequest.branch * SearchRequest.canonical_filter * SearchRequest.query_expansion_spec * SearchRequest.spell_correction_spec * SearchRequest.content_search_spec * SearchRequest.user_pseudo_id
+          "boostSpec": { # Boost specification to boost certain documents. # Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)
+            "conditionBoostSpecs": [ # Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.
+              { # Boost applies to documents which match a condition.
+                "boost": 3.14, # Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied.
+                "boostControlSpec": { # Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. # Complex specification for custom ranking based on customer defined attribute value.
+                  "attributeType": "A String", # The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).
+                  "controlPoints": [ # The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.
+                    { # The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).
+                      "attributeValue": "A String", # Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.
+                      "boostAmount": 3.14, # The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.
+                    },
+                  ],
+                  "fieldName": "A String", # The name of the field whose value will be used to determine the boost amount.
+                  "interpolationType": "A String", # The interpolation type to be applied to connect the control points listed below.
+                },
+                "condition": "A String", # An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": `(document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))`
+              },
+            ],
+          },
+          "branch": "A String", # The branch resource name, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Use `default_branch` as the branch ID or leave this field empty, to search documents under the default branch.
+          "canonicalFilter": "A String", # The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about filter syntax, see SearchRequest.filter.
+          "contentSearchSpec": { # A specification for configuring the behavior of content search. # A specification for configuring the behavior of content search.
+            "chunkSpec": { # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS
+              "numNextChunks": 42, # The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned.
+              "numPreviousChunks": 42, # The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned.
+            },
+            "extractiveContentSpec": { # A specification for configuring the extractive content in a search response. # If there is no extractive_content_spec provided, there will be no extractive answer in the search response.
+              "maxExtractiveAnswerCount": 42, # The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult.
+              "maxExtractiveSegmentCount": 42, # The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`.
+              "numNextSegments": 42, # Return at most `num_next_segments` segments after each selected segments.
+              "numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.
+              "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`.
+            },
+            "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.
+            "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response.
+              "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0.
+              "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet.
+              "returnSnippet": True or False, # If `true`, then return snippet. If no snippet can be generated, we return "No snippet is available for this page." A `snippet_status` with `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned.
+            },
+            "summarySpec": { # A specification for configuring a summary returned in a search response. # If `summarySpec` is not specified, summaries are not included in the search response.
+              "ignoreAdversarialQuery": True or False, # Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead.
+              "ignoreNonSummarySeekingQuery": True or False, # Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead.
+              "includeCitations": True or False, # Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results.
+              "languageCode": "A String", # Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.
+              "modelPromptSpec": { # Specification of the prompt to use with the model. # If specified, the spec will be used to modify the prompt provided to the LLM.
+                "preamble": "A String", # Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide.
+              },
+              "modelSpec": { # Specification of the model. # If specified, the spec will be used to modify the model specification provided to the LLM.
+                "version": "A String", # The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). * `preview`: string. (Public preview) Uses a preview model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).
+              },
+              "summaryResultCount": 42, # The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.
+              "useSemanticChunks": True or False, # If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list.
+            },
+          },
+          "customFineTuningSpec": { # Defines custom fine tuning spec. # Custom fine tuning configs. If set, it has higher priority than the configs set in ServingConfig.custom_fine_tuning_spec.
+            "enableSearchAdaptor": True or False, # Whether or not to enable and include custom fine tuned search adaptor model.
+          },
+          "dataStoreSpecs": [ # Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.
+            { # A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned.
+              "dataStore": "A String", # Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
+            },
+          ],
+          "embeddingSpec": { # The specification that uses customized query embedding vector to do semantic document retrieval. # Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path.
+            "embeddingVectors": [ # The embedding vector used for retrieval. Limit to 1.
+              { # Embedding vector.
+                "fieldPath": "A String", # Embedding field path in schema.
+                "vector": [ # Query embedding vector.
+                  3.14,
+                ],
+              },
+            ],
+          },
+          "facetSpecs": [ # Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.
+            { # A facet specification to perform faceted search.
+              "enableDynamicPosition": True or False, # Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false * "brands", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how API orders "gender" and "rating" facets. However, notice that "price" and "brands" are always ranked at first and second position because their enable_dynamic_position is false.
+              "excludedFilterKeys": [ # List of keys to exclude when faceting. By default, FacetKey.key is not excluded from the filter unless it is listed in this field. Listing a facet key in this field allows its values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned. For example, suppose there are 100 documents with the color facet "Red" and 200 documents with the color facet "Blue". A query containing the filter "color:ANY("Red")" and having "color" as FacetKey.key would by default return only "Red" documents in the search results, and also return "Red" with count 100 as the only color facet. Although there are also blue documents available, "Blue" would not be shown as an available facet value. If "color" is listed in "excludedFilterKeys", then the query returns the facet values "Red" with count 100 and "Blue" with count 200, because the "color" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly filtered to return only "Red" documents. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.
+                "A String",
+              ],
+              "facetKey": { # Specifies how a facet is computed. # Required. The facet key specification.
+                "caseInsensitive": True or False, # True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.
+                "contains": [ # Only get facet values that contain the given strings. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "contains" to "2022", the "category" facet only contains "Action > 2022" and "Sci-Fi > 2022". Only supported on textual fields. Maximum is 10.
+                  "A String",
+                ],
+                "intervals": [ # Set only if values should be bucketed into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30.
+                  { # A floating point interval.
+                    "exclusiveMaximum": 3.14, # Exclusive upper bound.
+                    "exclusiveMinimum": 3.14, # Exclusive lower bound.
+                    "maximum": 3.14, # Inclusive upper bound.
+                    "minimum": 3.14, # Inclusive lower bound.
+                  },
+                ],
+                "key": "A String", # Required. Supported textual and numerical facet keys in Document object, over which the facet values are computed. Facet key is case-sensitive.
+                "orderBy": "A String", # The order in which documents are returned. Allowed values are: * "count desc", which means order by SearchResponse.Facet.values.count descending. * "value desc", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets. If not set, textual values are sorted in [natural order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals.
+                "prefixes": [ # Only get facet values that start with the given string prefix. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "prefixes" to "Action", the "category" facet only contains "Action > 2022" and "Action > 2021". Only supported on textual fields. Maximum is 10.
+                  "A String",
+                ],
+                "restrictedValues": [ # Only get facet for the given restricted values. Only supported on textual fields. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "restricted_values" to "Action > 2022", the "category" facet only contains "Action > 2022". Only supported on textual fields. Maximum is 10.
+                  "A String",
+                ],
+              },
+              "limit": 42, # Maximum facet values that are returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. For aggregation in healthcare search, when the [FacetKey.key] is "healthcare_aggregation_key", the limit will be overridden to 10,000 internally, regardless of the value set here. If this field is negative, an `INVALID_ARGUMENT` is returned.
+            },
+          ],
+          "filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
+          "imageQuery": { # Specifies the image query input. # Raw image query.
+            "imageBytes": "A String", # Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP.
+          },
+          "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.
+          "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done.
+            "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Default to Condition.DISABLED.
+            "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.
+              "A String",
+            ],
+          },
+          "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.
+          "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering for retail search, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
+          "pageSize": 42, # Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.
+          "pageToken": "A String", # A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.
+          "params": { # Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. For example, `user_country_code: "au"` For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example, `search_type: 1`
+            "a_key": "",
+          },
+          "query": "A String", # Raw search query.
+          "queryExpansionSpec": { # Specification to determine under which conditions query expansion should occur. # The query expansion specification that specifies the conditions under which query expansion occurs.
+            "condition": "A String", # The condition under which query expansion should occur. Default to Condition.DISABLED.
+            "pinUnexpandedResults": True or False, # Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results.
+          },
+          "rankingExpression": "A String", # The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The ranking expression is a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.
+          "regionCode": "A String", # The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.
+          "relevanceThreshold": "A String", # The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information.
+          "safeSearch": True or False, # Whether to turn on safe search. This is only supported for website search.
+          "searchAsYouTypeSpec": { # Specification for search as you type in search requests. # Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical.
+            "condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED.
+          },
+          "servingConfig": "A String", # Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.
+          "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.
+          "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set.
+            "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID.
+            "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is simliar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode.
+          },
+          "spellCorrectionSpec": { # The specification for query spell correction. # The spell correction specification that specifies the mode under which spell correction takes effect.
+            "mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO.
+          },
+          "userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics.
+            "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set.
+            "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+          },
+          "userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * 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. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.
+            "a_key": "A String",
+          },
+          "userPseudoId": "A String", # A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+        },
+      },
+      "name": "A String", # Immutable. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+      "qualityMetrics": { # Describes the metrics produced by the evaluation. # Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet. Only populated when the evaluation's state is SUCCEEDED.
+        "docNdcg": { # Stores the metric values at specific top-k levels. # Normalized discounted cumulative gain (NDCG) per document, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved documents (D1, D2, D3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [D3 (0), D1 (1), D2 (1)] Ideal: [D1 (1), D2 (1), D3 (0)] Calculate NDCG@3 for each SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693
+          "top1": 3.14, # The top-1 value.
+          "top10": 3.14, # The top-10 value.
+          "top3": 3.14, # The top-3 value.
+          "top5": 3.14, # The top-5 value.
+        },
+        "docPrecision": { # Stores the metric values at specific top-k levels. # Precision per document, at various top-k cutoff levels. Precision is the fraction of retrieved documents that are relevant. Example (top-5): * For a single SampleQuery, If 4 out of 5 retrieved documents in the top-5 are relevant, precision@5 = 4/5 = 0.8
+          "top1": 3.14, # The top-1 value.
+          "top10": 3.14, # The top-10 value.
+          "top3": 3.14, # The top-3 value.
+          "top5": 3.14, # The top-5 value.
+        },
+        "docRecall": { # Stores the metric values at specific top-k levels. # Recall per document, at various top-k cutoff levels. Recall is the fraction of relevant documents retrieved out of all relevant documents. Example (top-5): * For a single SampleQuery, If 3 out of 5 relevant documents are retrieved in the top-5, recall@5 = 3/5 = 0.6
+          "top1": 3.14, # The top-1 value.
+          "top10": 3.14, # The top-10 value.
+          "top3": 3.14, # The top-3 value.
+          "top5": 3.14, # The top-5 value.
+        },
+        "pageNdcg": { # Stores the metric values at specific top-k levels. # Normalized discounted cumulative gain (NDCG) per page, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved pages (P1, P2, P3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [P3 (0), P1 (1), P2 (1)] Ideal: [P1 (1), P2 (1), P3 (0)] Calculate NDCG@3 for SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693
+          "top1": 3.14, # The top-1 value.
+          "top10": 3.14, # The top-10 value.
+          "top3": 3.14, # The top-3 value.
+          "top5": 3.14, # The top-5 value.
+        },
+        "pageRecall": { # Stores the metric values at specific top-k levels. # Recall per page, at various top-k cutoff levels. Recall is the fraction of relevant pages retrieved out of all relevant pages. Example (top-5): * For a single SampleQuery, if 3 out of 5 relevant pages are retrieved in the top-5, recall@5 = 3/5 = 0.6
+          "top1": 3.14, # The top-1 value.
+          "top10": 3.14, # The top-10 value.
+          "top3": 3.14, # The top-3 value.
+          "top5": 3.14, # The top-5 value.
+        },
+      },
+      "state": "A String", # Output only. The state of the evaluation.
+    },
+  ],
+  "nextPageToken": "A String", # A token that can be sent as ListEvaluationsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
+}
+
+ +
+ listResults(evaluation, pageSize=None, pageToken=None, x__xgafv=None) +
Gets a list of results for a given a Evaluation.
+
+Args:
+  evaluation: string, Required. The evaluation resource name, such as `projects/{project}/locations/{location}/evaluations/{evaluation}`. If the caller does not have permission to list EvaluationResult under this evaluation, regardless of whether or not this evaluation set exists, a `PERMISSION_DENIED` error is returned. (required)
+  pageSize: integer, Maximum number of EvaluationResult to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.
+  pageToken: string, A page token ListEvaluationResultsResponse.next_page_token, received from a previous EvaluationService.ListEvaluationResults call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to EvaluationService.ListEvaluationResults must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error 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 EvaluationService.ListEvaluationResults method.
+  "evaluationResults": [ # The EvaluationResults.
+    { # Represents the results of an evaluation for a single SampleQuery.
+      "qualityMetrics": { # Describes the metrics produced by the evaluation. # Output only. The metrics produced by the evaluation, for a given SampleQuery.
+        "docNdcg": { # Stores the metric values at specific top-k levels. # Normalized discounted cumulative gain (NDCG) per document, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved documents (D1, D2, D3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [D3 (0), D1 (1), D2 (1)] Ideal: [D1 (1), D2 (1), D3 (0)] Calculate NDCG@3 for each SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693
+          "top1": 3.14, # The top-1 value.
+          "top10": 3.14, # The top-10 value.
+          "top3": 3.14, # The top-3 value.
+          "top5": 3.14, # The top-5 value.
+        },
+        "docPrecision": { # Stores the metric values at specific top-k levels. # Precision per document, at various top-k cutoff levels. Precision is the fraction of retrieved documents that are relevant. Example (top-5): * For a single SampleQuery, If 4 out of 5 retrieved documents in the top-5 are relevant, precision@5 = 4/5 = 0.8
+          "top1": 3.14, # The top-1 value.
+          "top10": 3.14, # The top-10 value.
+          "top3": 3.14, # The top-3 value.
+          "top5": 3.14, # The top-5 value.
+        },
+        "docRecall": { # Stores the metric values at specific top-k levels. # Recall per document, at various top-k cutoff levels. Recall is the fraction of relevant documents retrieved out of all relevant documents. Example (top-5): * For a single SampleQuery, If 3 out of 5 relevant documents are retrieved in the top-5, recall@5 = 3/5 = 0.6
+          "top1": 3.14, # The top-1 value.
+          "top10": 3.14, # The top-10 value.
+          "top3": 3.14, # The top-3 value.
+          "top5": 3.14, # The top-5 value.
+        },
+        "pageNdcg": { # Stores the metric values at specific top-k levels. # Normalized discounted cumulative gain (NDCG) per page, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved pages (P1, P2, P3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [P3 (0), P1 (1), P2 (1)] Ideal: [P1 (1), P2 (1), P3 (0)] Calculate NDCG@3 for SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693
+          "top1": 3.14, # The top-1 value.
+          "top10": 3.14, # The top-10 value.
+          "top3": 3.14, # The top-3 value.
+          "top5": 3.14, # The top-5 value.
+        },
+        "pageRecall": { # Stores the metric values at specific top-k levels. # Recall per page, at various top-k cutoff levels. Recall is the fraction of relevant pages retrieved out of all relevant pages. Example (top-5): * For a single SampleQuery, if 3 out of 5 relevant pages are retrieved in the top-5, recall@5 = 3/5 = 0.6
+          "top1": 3.14, # The top-1 value.
+          "top10": 3.14, # The top-10 value.
+          "top3": 3.14, # The top-3 value.
+          "top5": 3.14, # The top-5 value.
+        },
+      },
+      "sampleQuery": { # Sample Query captures metadata to be used for evaluation. # Output only. The SampleQuery that was evaluated.
+        "createTime": "A String", # Output only. Timestamp the SampleQuery was created at.
+        "name": "A String", # Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+        "queryEntry": { # Query Entry captures metadata to be used for search evaluation. # The query entry.
+          "query": "A String", # Required. The query.
+          "targets": [ # List of targets for the query.
+            { # Defines the parameters of the query's expected outcome.
+              "pageNumbers": [ # Expected page numbers of the target. Each page number must be non negative.
+                42,
+              ],
+              "score": 3.14, # Relevance score of the target.
+              "uri": "A String", # Expected uri of the target. This field must be a UTF-8 encoded string with a length limit of 2048 characters. Example of valid uris: `https://example.com/abc`, `gcs://example/example.pdf`.
+            },
+          ],
+        },
+      },
+    },
+  ],
+  "nextPageToken": "A String", # A token that can be sent as ListEvaluationResultsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
+}
+
+ +
+ listResults_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.
+        
+
+ +
+ 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/discoveryengine_v1alpha.projects.locations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.html index 7631051a91a..c07864082b1 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.html @@ -94,6 +94,11 @@

Instance Methods

Returns the groundingConfigs Resource.

+

+ identity_mapping_stores() +

+

Returns the identity_mapping_stores Resource.

+

operations()

diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.identity_mapping_stores.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.identity_mapping_stores.html new file mode 100644 index 00000000000..ed188bb7977 --- /dev/null +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.identity_mapping_stores.html @@ -0,0 +1,91 @@ + + + +

Discovery Engine API . projects . locations . identity_mapping_stores

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.sampleQuerySets.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.sampleQuerySets.html index b7f1eb3e676..18abd8ea1bb 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.sampleQuerySets.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.sampleQuerySets.html @@ -79,13 +79,185 @@

Instance Methods

Returns the operations Resource.

+

+ sampleQueries() +

+

Returns the sampleQueries Resource.

+

close()

Close httplib2 connections.

+

+ create(parent, body=None, sampleQuerySetId=None, x__xgafv=None)

+

Creates a SampleQuerySet

+

+ delete(name, x__xgafv=None)

+

Deletes a SampleQuerySet.

+

+ get(name, x__xgafv=None)

+

Gets a SampleQuerySet.

+

+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)

+

Gets a list of SampleQuerySets.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(name, body=None, updateMask=None, x__xgafv=None)

+

Updates a SampleQuerySet.

Method Details

close()
Close httplib2 connections.
+
+ create(parent, body=None, sampleQuerySetId=None, x__xgafv=None) +
Creates a SampleQuerySet
+
+Args:
+  parent: string, Required. The parent resource name, such as `projects/{project}/locations/{location}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A SampleQuerySet is the parent resource of SampleQuery, and contains the configurations shared by all SampleQuery under it.
+  "createTime": "A String", # Output only. Timestamp the SampleQuerySet was created at.
+  "description": "A String", # The description of the SampleQuerySet.
+  "displayName": "A String", # Required. The sample query set display name. This field must be a UTF-8 encoded string with a length limit of 128 characters.
+  "name": "A String", # Immutable. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+}
+
+  sampleQuerySetId: string, Required. The ID to use for the SampleQuerySet, which will become the final component of the SampleQuerySet.name. If the caller does not have permission to create the SampleQuerySet, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all SampleQuerySets with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A SampleQuerySet is the parent resource of SampleQuery, and contains the configurations shared by all SampleQuery under it.
+  "createTime": "A String", # Output only. Timestamp the SampleQuerySet was created at.
+  "description": "A String", # The description of the SampleQuerySet.
+  "displayName": "A String", # Required. The sample query set display name. This field must be a UTF-8 encoded string with a length limit of 128 characters.
+  "name": "A String", # Immutable. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+}
+
+ +
+ delete(name, x__xgafv=None) +
Deletes a SampleQuerySet.
+
+Args:
+  name: string, Required. Full resource name of SampleQuerySet, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to delete the SampleQuerySet, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the SampleQuerySet to delete does not exist, a `NOT_FOUND` error is returned. (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 a SampleQuerySet.
+
+Args:
+  name: string, Required. Full resource name of SampleQuerySet, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to access the SampleQuerySet, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested SampleQuerySet does not exist, a NOT_FOUND error is returned. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A SampleQuerySet is the parent resource of SampleQuery, and contains the configurations shared by all SampleQuery under it.
+  "createTime": "A String", # Output only. Timestamp the SampleQuerySet was created at.
+  "description": "A String", # The description of the SampleQuerySet.
+  "displayName": "A String", # Required. The sample query set display name. This field must be a UTF-8 encoded string with a length limit of 128 characters.
+  "name": "A String", # Immutable. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Gets a list of SampleQuerySets.
+
+Args:
+  parent: string, Required. The parent location resource name, such as `projects/{project}/locations/{location}`. If the caller does not have permission to list SampleQuerySets under this location, regardless of whether or not this location exists, a `PERMISSION_DENIED` error is returned. (required)
+  pageSize: integer, Maximum number of SampleQuerySets to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.
+  pageToken: string, A page token ListSampleQuerySetsResponse.next_page_token, received from a previous SampleQuerySetService.ListSampleQuerySets call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SampleQuerySetService.ListSampleQuerySets must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error 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 SampleQuerySetService.ListSampleQuerySets method.
+  "nextPageToken": "A String", # A token that can be sent as ListSampleQuerySetsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
+  "sampleQuerySets": [ # The SampleQuerySets.
+    { # A SampleQuerySet is the parent resource of SampleQuery, and contains the configurations shared by all SampleQuery under it.
+      "createTime": "A String", # Output only. Timestamp the SampleQuerySet was created at.
+      "description": "A String", # The description of the SampleQuerySet.
+      "displayName": "A String", # Required. The sample query set display name. This field must be a UTF-8 encoded string with a length limit of 128 characters.
+      "name": "A String", # Immutable. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+    },
+  ],
+}
+
+ +
+ 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, body=None, updateMask=None, x__xgafv=None) +
Updates a SampleQuerySet.
+
+Args:
+  name: string, Immutable. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A SampleQuerySet is the parent resource of SampleQuery, and contains the configurations shared by all SampleQuery under it.
+  "createTime": "A String", # Output only. Timestamp the SampleQuerySet was created at.
+  "description": "A String", # The description of the SampleQuerySet.
+  "displayName": "A String", # Required. The sample query set display name. This field must be a UTF-8 encoded string with a length limit of 128 characters.
+  "name": "A String", # Immutable. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+}
+
+  updateMask: string, Indicates which fields in the provided imported 'sample query set' to update. If not set, will by default update all fields.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A SampleQuerySet is the parent resource of SampleQuery, and contains the configurations shared by all SampleQuery under it.
+  "createTime": "A String", # Output only. Timestamp the SampleQuerySet was created at.
+  "description": "A String", # The description of the SampleQuerySet.
+  "displayName": "A String", # Required. The sample query set display name. This field must be a UTF-8 encoded string with a length limit of 128 characters.
+  "name": "A String", # Immutable. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.sampleQuerySets.sampleQueries.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.sampleQuerySets.sampleQueries.html new file mode 100644 index 00000000000..3dfea63cd8c --- /dev/null +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.sampleQuerySets.sampleQueries.html @@ -0,0 +1,398 @@ + + + +

Discovery Engine API . projects . locations . sampleQuerySets . sampleQueries

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ create(parent, body=None, sampleQueryId=None, x__xgafv=None)

+

Creates a SampleQuery

+

+ delete(name, x__xgafv=None)

+

Deletes a SampleQuery.

+

+ get(name, x__xgafv=None)

+

Gets a SampleQuery.

+

+ import_(parent, body=None, x__xgafv=None)

+

Bulk import of multiple SampleQuerys. Sample queries that already exist may be deleted. Note: It is possible for a subset of the SampleQuerys to be successfully imported.

+

+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)

+

Gets a list of SampleQuerys.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(name, body=None, updateMask=None, x__xgafv=None)

+

Updates a SampleQuery.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, sampleQueryId=None, x__xgafv=None) +
Creates a SampleQuery
+
+Args:
+  parent: string, Required. The parent resource name, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Sample Query captures metadata to be used for evaluation.
+  "createTime": "A String", # Output only. Timestamp the SampleQuery was created at.
+  "name": "A String", # Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+  "queryEntry": { # Query Entry captures metadata to be used for search evaluation. # The query entry.
+    "query": "A String", # Required. The query.
+    "targets": [ # List of targets for the query.
+      { # Defines the parameters of the query's expected outcome.
+        "pageNumbers": [ # Expected page numbers of the target. Each page number must be non negative.
+          42,
+        ],
+        "score": 3.14, # Relevance score of the target.
+        "uri": "A String", # Expected uri of the target. This field must be a UTF-8 encoded string with a length limit of 2048 characters. Example of valid uris: `https://example.com/abc`, `gcs://example/example.pdf`.
+      },
+    ],
+  },
+}
+
+  sampleQueryId: string, Required. The ID to use for the SampleQuery, which will become the final component of the SampleQuery.name. If the caller does not have permission to create the SampleQuery, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all SampleQuerys with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Sample Query captures metadata to be used for evaluation.
+  "createTime": "A String", # Output only. Timestamp the SampleQuery was created at.
+  "name": "A String", # Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+  "queryEntry": { # Query Entry captures metadata to be used for search evaluation. # The query entry.
+    "query": "A String", # Required. The query.
+    "targets": [ # List of targets for the query.
+      { # Defines the parameters of the query's expected outcome.
+        "pageNumbers": [ # Expected page numbers of the target. Each page number must be non negative.
+          42,
+        ],
+        "score": 3.14, # Relevance score of the target.
+        "uri": "A String", # Expected uri of the target. This field must be a UTF-8 encoded string with a length limit of 2048 characters. Example of valid uris: `https://example.com/abc`, `gcs://example/example.pdf`.
+      },
+    ],
+  },
+}
+
+ +
+ delete(name, x__xgafv=None) +
Deletes a SampleQuery.
+
+Args:
+  name: string, Required. Full resource name of SampleQuery, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. If the caller does not have permission to delete the SampleQuery, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the SampleQuery to delete does not exist, a `NOT_FOUND` error is returned. (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 a SampleQuery.
+
+Args:
+  name: string, Required. Full resource name of SampleQuery, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. If the caller does not have permission to access the SampleQuery, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested SampleQuery does not exist, a NOT_FOUND error is returned. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Sample Query captures metadata to be used for evaluation.
+  "createTime": "A String", # Output only. Timestamp the SampleQuery was created at.
+  "name": "A String", # Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+  "queryEntry": { # Query Entry captures metadata to be used for search evaluation. # The query entry.
+    "query": "A String", # Required. The query.
+    "targets": [ # List of targets for the query.
+      { # Defines the parameters of the query's expected outcome.
+        "pageNumbers": [ # Expected page numbers of the target. Each page number must be non negative.
+          42,
+        ],
+        "score": 3.14, # Relevance score of the target.
+        "uri": "A String", # Expected uri of the target. This field must be a UTF-8 encoded string with a length limit of 2048 characters. Example of valid uris: `https://example.com/abc`, `gcs://example/example.pdf`.
+      },
+    ],
+  },
+}
+
+ +
+ import_(parent, body=None, x__xgafv=None) +
Bulk import of multiple SampleQuerys. Sample queries that already exist may be deleted. Note: It is possible for a subset of the SampleQuerys to be successfully imported.
+
+Args:
+  parent: string, Required. The parent sample query set resource name, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to list SampleQuerys under this sample query set, regardless of whether or not this sample query set exists, a `PERMISSION_DENIED` error is returned. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for SampleQueryService.ImportSampleQueries method.
+  "bigquerySource": { # BigQuery source import data from. # BigQuery input source.
+    "dataSchema": "A String", # The schema to use when parsing the data from the source. Supported values for user event imports: * `user_event` (default): One UserEvent per row. Supported values for document imports: * `document` (default): One Document format per row. Each document must have a valid Document.id and one of Document.json_data or Document.struct_data. * `custom`: One custom data per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical.
+    "datasetId": "A String", # Required. The BigQuery data set to copy the data from with a length limit of 1,024 characters.
+    "gcsStagingDir": "A String", # Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the BigQuery export to a specific Cloud Storage directory.
+    "partitionDate": { # 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 # BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format.
+      "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.
+    },
+    "projectId": "A String", # The project ID (can be project # or ID) that the BigQuery source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.
+    "tableId": "A String", # Required. The BigQuery table to copy the data from with a length limit of 1,024 characters.
+  },
+  "errorConfig": { # Configuration of destination for Import related errors. # The desired location of errors incurred during the Import.
+    "gcsPrefix": "A String", # Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.
+  },
+  "gcsSource": { # Cloud Storage location for input content. # Cloud Storage location for the input content.
+    "dataSchema": "A String", # The schema to use when parsing the data from the source. Supported values for document imports: * `document` (default): One JSON Document per line. Each document must have a valid Document.id. * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by `input_uris` becomes a document, with the ID set to the first 128 bits of SHA256(URI) encoded as a hex string. * `custom`: One custom data JSON per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical. * `csv`: A CSV file with header conforming to the defined Schema of the data store. Each entry after the header is imported as a Document. This can only be used by the GENERIC Data Store vertical. Supported values for user event imports: * `user_event` (default): One JSON UserEvent per line.
+    "inputUris": [ # Required. Cloud Storage URIs to input files. Each URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files (or 100,000 files if `data_schema` is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is `content`).
+      "A String",
+    ],
+  },
+  "inlineSource": { # The inline source for SampleQuerys. # The Inline source for sample query entries.
+    "sampleQueries": [ # Required. A list of SampleQuerys to import. Max of 1000 items.
+      { # Sample Query captures metadata to be used for evaluation.
+        "createTime": "A String", # Output only. Timestamp the SampleQuery was created at.
+        "name": "A String", # Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+        "queryEntry": { # Query Entry captures metadata to be used for search evaluation. # The query entry.
+          "query": "A String", # Required. The query.
+          "targets": [ # List of targets for the query.
+            { # Defines the parameters of the query's expected outcome.
+              "pageNumbers": [ # Expected page numbers of the target. Each page number must be non negative.
+                42,
+              ],
+              "score": 3.14, # Relevance score of the target.
+              "uri": "A String", # Expected uri of the target. This field must be a UTF-8 encoded string with a length limit of 2048 characters. Example of valid uris: `https://example.com/abc`, `gcs://example/example.pdf`.
+            },
+          ],
+        },
+      },
+    ],
+  },
+}
+
+  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(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Gets a list of SampleQuerys.
+
+Args:
+  parent: string, Required. The parent sample query set resource name, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to list SampleQuerys under this sample query set, regardless of whether or not this sample query set exists, a `PERMISSION_DENIED` error is returned. (required)
+  pageSize: integer, Maximum number of SampleQuerys to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.
+  pageToken: string, A page token ListSampleQueriesResponse.next_page_token, received from a previous SampleQueryService.ListSampleQueries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SampleQueryService.ListSampleQueries must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error 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 SampleQueryService.ListSampleQueries method.
+  "nextPageToken": "A String", # A token that can be sent as ListSampleQueriesRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
+  "sampleQueries": [ # The SampleQuerys.
+    { # Sample Query captures metadata to be used for evaluation.
+      "createTime": "A String", # Output only. Timestamp the SampleQuery was created at.
+      "name": "A String", # Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+      "queryEntry": { # Query Entry captures metadata to be used for search evaluation. # The query entry.
+        "query": "A String", # Required. The query.
+        "targets": [ # List of targets for the query.
+          { # Defines the parameters of the query's expected outcome.
+            "pageNumbers": [ # Expected page numbers of the target. Each page number must be non negative.
+              42,
+            ],
+            "score": 3.14, # Relevance score of the target.
+            "uri": "A String", # Expected uri of the target. This field must be a UTF-8 encoded string with a length limit of 2048 characters. Example of valid uris: `https://example.com/abc`, `gcs://example/example.pdf`.
+          },
+        ],
+      },
+    },
+  ],
+}
+
+ +
+ 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, body=None, updateMask=None, x__xgafv=None) +
Updates a SampleQuery.
+
+Args:
+  name: string, Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Sample Query captures metadata to be used for evaluation.
+  "createTime": "A String", # Output only. Timestamp the SampleQuery was created at.
+  "name": "A String", # Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+  "queryEntry": { # Query Entry captures metadata to be used for search evaluation. # The query entry.
+    "query": "A String", # Required. The query.
+    "targets": [ # List of targets for the query.
+      { # Defines the parameters of the query's expected outcome.
+        "pageNumbers": [ # Expected page numbers of the target. Each page number must be non negative.
+          42,
+        ],
+        "score": 3.14, # Relevance score of the target.
+        "uri": "A String", # Expected uri of the target. This field must be a UTF-8 encoded string with a length limit of 2048 characters. Example of valid uris: `https://example.com/abc`, `gcs://example/example.pdf`.
+      },
+    ],
+  },
+}
+
+  updateMask: string, Indicates which fields in the provided imported 'simple query' to update. If not set, will by default update all fields.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Sample Query captures metadata to be used for evaluation.
+  "createTime": "A String", # Output only. Timestamp the SampleQuery was created at.
+  "name": "A String", # Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+  "queryEntry": { # Query Entry captures metadata to be used for search evaluation. # The query entry.
+    "query": "A String", # Required. The query.
+    "targets": [ # List of targets for the query.
+      { # Defines the parameters of the query's expected outcome.
+        "pageNumbers": [ # Expected page numbers of the target. Each page number must be non negative.
+          42,
+        ],
+        "score": 3.14, # Relevance score of the target.
+        "uri": "A String", # Expected uri of the target. This field must be a UTF-8 encoded string with a length limit of 2048 characters. Example of valid uris: `https://example.com/abc`, `gcs://example/example.pdf`.
+      },
+    ],
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html index f97b75bd12f..1dbddaff8f0 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html @@ -176,7 +176,7 @@

Method Details

"filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the Answer response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customers might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) "maxReturnResults": 42, # Number of search results to return. The default value is 10. "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents) + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents) }, "searchResultList": { # Search result list. # Search result list. "searchResults": [ # Search results. @@ -228,7 +228,7 @@

Method Details

An object of the form: { # Response message for ConversationalSearchService.AnswerQuery method. - "answer": { # Defines an answer. # Answer resource object. If AnswerQueryRequest.StepSpec.max_step_count is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API. + "answer": { # Defines an answer. # Answer resource object. If AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.max_rephrase_steps is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", ], @@ -312,7 +312,7 @@

Method Details

"snippetStatus": "A String", # Status of the snippet defined by the search team. }, ], - "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document (code pointer: http://shortn/_objzAfIiHq), or the Chunk in search result (code pointer: http://shortn/_Ipo6KFFGBL). + "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document , or the Chunk in search result . "a_key": "", # Properties of the object. }, "title": "A String", # Title. @@ -399,7 +399,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -498,7 +498,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -603,7 +603,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -691,7 +691,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -925,7 +925,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -999,7 +999,7 @@

Method Details

"languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate. "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Default to Condition.DISABLED. - "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in Servingconfig.geo_search_query_detection_field_names. + "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names. "A String", ], }, @@ -1021,6 +1021,7 @@

Method Details

"searchAsYouTypeSpec": { # Specification for search as you type in search requests. # Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical. "condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED. }, + "servingConfig": "A String", # Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.sessions.answers.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.sessions.answers.html index 6512be89516..b9de6a69fc2 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.sessions.answers.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.sessions.answers.html @@ -184,7 +184,7 @@

Method Details

"snippetStatus": "A String", # Status of the snippet defined by the search team. }, ], - "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document (code pointer: http://shortn/_objzAfIiHq), or the Chunk in search result (code pointer: http://shortn/_Ipo6KFFGBL). + "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document , or the Chunk in search result . "a_key": "", # Properties of the object. }, "title": "A String", # Title. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html index 4853e21a08e..2918dad648b 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html @@ -176,7 +176,7 @@

Method Details

"filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the Answer response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customers might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) "maxReturnResults": 42, # Number of search results to return. The default value is 10. "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents) + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents) }, "searchResultList": { # Search result list. # Search result list. "searchResults": [ # Search results. @@ -228,7 +228,7 @@

Method Details

An object of the form: { # Response message for ConversationalSearchService.AnswerQuery method. - "answer": { # Defines an answer. # Answer resource object. If AnswerQueryRequest.StepSpec.max_step_count is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API. + "answer": { # Defines an answer. # Answer resource object. If AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.max_rephrase_steps is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", ], @@ -312,7 +312,7 @@

Method Details

"snippetStatus": "A String", # Status of the snippet defined by the search team. }, ], - "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document (code pointer: http://shortn/_objzAfIiHq), or the Chunk in search result (code pointer: http://shortn/_Ipo6KFFGBL). + "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document , or the Chunk in search result . "a_key": "", # Properties of the object. }, "title": "A String", # Title. @@ -399,7 +399,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -498,7 +498,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -603,7 +603,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -691,7 +691,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -925,7 +925,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -999,7 +999,7 @@

Method Details

"languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate. "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Default to Condition.DISABLED. - "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in Servingconfig.geo_search_query_detection_field_names. + "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names. "A String", ], }, @@ -1021,6 +1021,7 @@

Method Details

"searchAsYouTypeSpec": { # Specification for search as you type in search requests. # Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical. "condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED. }, + "servingConfig": "A String", # Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.sessions.answers.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.sessions.answers.html index 82932881d2b..50026fc8d25 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.sessions.answers.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.sessions.answers.html @@ -184,7 +184,7 @@

Method Details

"snippetStatus": "A String", # Status of the snippet defined by the search team. }, ], - "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document (code pointer: http://shortn/_objzAfIiHq), or the Chunk in search result (code pointer: http://shortn/_Ipo6KFFGBL). + "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document , or the Chunk in search result . "a_key": "", # Properties of the object. }, "title": "A String", # Title. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html index fab6652d4c3..5cba7a9d3a0 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html @@ -176,7 +176,7 @@

Method Details

"filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the Answer response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customers might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) "maxReturnResults": 42, # Number of search results to return. The default value is 10. "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents) + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents) }, "searchResultList": { # Search result list. # Search result list. "searchResults": [ # Search results. @@ -228,7 +228,7 @@

Method Details

An object of the form: { # Response message for ConversationalSearchService.AnswerQuery method. - "answer": { # Defines an answer. # Answer resource object. If AnswerQueryRequest.StepSpec.max_step_count is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API. + "answer": { # Defines an answer. # Answer resource object. If AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.max_rephrase_steps is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", ], @@ -312,7 +312,7 @@

Method Details

"snippetStatus": "A String", # Status of the snippet defined by the search team. }, ], - "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document (code pointer: http://shortn/_objzAfIiHq), or the Chunk in search result (code pointer: http://shortn/_Ipo6KFFGBL). + "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document , or the Chunk in search result . "a_key": "", # Properties of the object. }, "title": "A String", # Title. @@ -399,7 +399,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -498,7 +498,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -603,7 +603,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -691,7 +691,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -925,7 +925,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -999,7 +999,7 @@

Method Details

"languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate. "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Default to Condition.DISABLED. - "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in Servingconfig.geo_search_query_detection_field_names. + "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names. "A String", ], }, @@ -1021,6 +1021,7 @@

Method Details

"searchAsYouTypeSpec": { # Specification for search as you type in search requests. # Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical. "condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED. }, + "servingConfig": "A String", # Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.sessions.answers.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.sessions.answers.html index 443ff931a9b..240338cfb05 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.sessions.answers.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.sessions.answers.html @@ -184,7 +184,7 @@

Method Details

"snippetStatus": "A String", # Status of the snippet defined by the search team. }, ], - "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document (code pointer: http://shortn/_objzAfIiHq), or the Chunk in search result (code pointer: http://shortn/_Ipo6KFFGBL). + "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document , or the Chunk in search result . "a_key": "", # Properties of the object. }, "title": "A String", # Title. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.evaluations.html b/docs/dyn/discoveryengine_v1beta.projects.locations.evaluations.html index 7df82cad4d0..a538e2d2304 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.evaluations.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.evaluations.html @@ -82,10 +82,840 @@

Instance Methods

close()

Close httplib2 connections.

+

+ create(parent, body=None, x__xgafv=None)

+

Creates a Evaluation. Upon creation, the evaluation will be automatically triggered and begin execution.

+

+ get(name, x__xgafv=None)

+

Gets a Evaluation.

+

+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)

+

Gets a list of Evaluations.

+

+ listResults(evaluation, pageSize=None, pageToken=None, x__xgafv=None)

+

Gets a list of results for a given a Evaluation.

+

+ listResults_next()

+

Retrieves the next page of results.

+

+ list_next()

+

Retrieves the next page of results.

Method Details

close()
Close httplib2 connections.
+
+ create(parent, body=None, x__xgafv=None) +
Creates a Evaluation. Upon creation, the evaluation will be automatically triggered and begin execution.
+
+Args:
+  parent: string, Required. The parent resource name, such as `projects/{project}/locations/{location}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data.
+  "createTime": "A String", # Output only. Timestamp the Evaluation was created at.
+  "endTime": "A String", # Output only. Timestamp the Evaluation was completed at.
+  "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). # Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED.
+    "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.
+  },
+  "errorSamples": [ # Output only. A sample of errors encountered while processing the request.
+    { # 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).
+      "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.
+    },
+  ],
+  "evaluationSpec": { # Describes the specification of the evaluation. # Required. The specification of the evaluation.
+    "querySetSpec": { # Describes the specification of the query set. # Required. The specification of the query set.
+      "sampleQuerySet": "A String", # Required. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.
+    },
+    "searchRequest": { # Request message for SearchService.Search method. # Required. The search request that is used to perform the evaluation. Only the following fields within SearchRequest are supported; if any other fields are provided, an UNSUPPORTED error will be returned: * SearchRequest.serving_config * SearchRequest.branch * SearchRequest.canonical_filter * SearchRequest.query_expansion_spec * SearchRequest.spell_correction_spec * SearchRequest.content_search_spec * SearchRequest.user_pseudo_id
+      "boostSpec": { # Boost specification to boost certain documents. # Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)
+        "conditionBoostSpecs": [ # Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.
+          { # Boost applies to documents which match a condition.
+            "boost": 3.14, # Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied.
+            "boostControlSpec": { # Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. # Complex specification for custom ranking based on customer defined attribute value.
+              "attributeType": "A String", # The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).
+              "controlPoints": [ # The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.
+                { # The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).
+                  "attributeValue": "A String", # Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.
+                  "boostAmount": 3.14, # The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.
+                },
+              ],
+              "fieldName": "A String", # The name of the field whose value will be used to determine the boost amount.
+              "interpolationType": "A String", # The interpolation type to be applied to connect the control points listed below.
+            },
+            "condition": "A String", # An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": `(document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))`
+          },
+        ],
+      },
+      "branch": "A String", # The branch resource name, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Use `default_branch` as the branch ID or leave this field empty, to search documents under the default branch.
+      "canonicalFilter": "A String", # The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about filter syntax, see SearchRequest.filter.
+      "contentSearchSpec": { # A specification for configuring the behavior of content search. # A specification for configuring the behavior of content search.
+        "chunkSpec": { # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS
+          "numNextChunks": 42, # The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned.
+          "numPreviousChunks": 42, # The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned.
+        },
+        "extractiveContentSpec": { # A specification for configuring the extractive content in a search response. # If there is no extractive_content_spec provided, there will be no extractive answer in the search response.
+          "maxExtractiveAnswerCount": 42, # The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult.
+          "maxExtractiveSegmentCount": 42, # The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`.
+          "numNextSegments": 42, # Return at most `num_next_segments` segments after each selected segments.
+          "numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.
+          "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`.
+        },
+        "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.
+        "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response.
+          "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0.
+          "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet.
+          "returnSnippet": True or False, # If `true`, then return snippet. If no snippet can be generated, we return "No snippet is available for this page." A `snippet_status` with `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned.
+        },
+        "summarySpec": { # A specification for configuring a summary returned in a search response. # If `summarySpec` is not specified, summaries are not included in the search response.
+          "ignoreAdversarialQuery": True or False, # Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead.
+          "ignoreNonSummarySeekingQuery": True or False, # Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead.
+          "includeCitations": True or False, # Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results.
+          "languageCode": "A String", # Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.
+          "modelPromptSpec": { # Specification of the prompt to use with the model. # If specified, the spec will be used to modify the prompt provided to the LLM.
+            "preamble": "A String", # Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide.
+          },
+          "modelSpec": { # Specification of the model. # If specified, the spec will be used to modify the model specification provided to the LLM.
+            "version": "A String", # The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). * `preview`: string. (Public preview) Uses a preview model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).
+          },
+          "summaryResultCount": 42, # The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.
+          "useSemanticChunks": True or False, # If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list.
+        },
+      },
+      "dataStoreSpecs": [ # Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.
+        { # A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned.
+          "dataStore": "A String", # Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
+        },
+      ],
+      "embeddingSpec": { # The specification that uses customized query embedding vector to do semantic document retrieval. # Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path.
+        "embeddingVectors": [ # The embedding vector used for retrieval. Limit to 1.
+          { # Embedding vector.
+            "fieldPath": "A String", # Embedding field path in schema.
+            "vector": [ # Query embedding vector.
+              3.14,
+            ],
+          },
+        ],
+      },
+      "facetSpecs": [ # Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.
+        { # A facet specification to perform faceted search.
+          "enableDynamicPosition": True or False, # Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false * "brands", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how API orders "gender" and "rating" facets. However, notice that "price" and "brands" are always ranked at first and second position because their enable_dynamic_position is false.
+          "excludedFilterKeys": [ # List of keys to exclude when faceting. By default, FacetKey.key is not excluded from the filter unless it is listed in this field. Listing a facet key in this field allows its values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned. For example, suppose there are 100 documents with the color facet "Red" and 200 documents with the color facet "Blue". A query containing the filter "color:ANY("Red")" and having "color" as FacetKey.key would by default return only "Red" documents in the search results, and also return "Red" with count 100 as the only color facet. Although there are also blue documents available, "Blue" would not be shown as an available facet value. If "color" is listed in "excludedFilterKeys", then the query returns the facet values "Red" with count 100 and "Blue" with count 200, because the "color" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly filtered to return only "Red" documents. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.
+            "A String",
+          ],
+          "facetKey": { # Specifies how a facet is computed. # Required. The facet key specification.
+            "caseInsensitive": True or False, # True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.
+            "contains": [ # Only get facet values that contain the given strings. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "contains" to "2022", the "category" facet only contains "Action > 2022" and "Sci-Fi > 2022". Only supported on textual fields. Maximum is 10.
+              "A String",
+            ],
+            "intervals": [ # Set only if values should be bucketed into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30.
+              { # A floating point interval.
+                "exclusiveMaximum": 3.14, # Exclusive upper bound.
+                "exclusiveMinimum": 3.14, # Exclusive lower bound.
+                "maximum": 3.14, # Inclusive upper bound.
+                "minimum": 3.14, # Inclusive lower bound.
+              },
+            ],
+            "key": "A String", # Required. Supported textual and numerical facet keys in Document object, over which the facet values are computed. Facet key is case-sensitive.
+            "orderBy": "A String", # The order in which documents are returned. Allowed values are: * "count desc", which means order by SearchResponse.Facet.values.count descending. * "value desc", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets. If not set, textual values are sorted in [natural order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals.
+            "prefixes": [ # Only get facet values that start with the given string prefix. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "prefixes" to "Action", the "category" facet only contains "Action > 2022" and "Action > 2021". Only supported on textual fields. Maximum is 10.
+              "A String",
+            ],
+            "restrictedValues": [ # Only get facet for the given restricted values. Only supported on textual fields. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "restricted_values" to "Action > 2022", the "category" facet only contains "Action > 2022". Only supported on textual fields. Maximum is 10.
+              "A String",
+            ],
+          },
+          "limit": 42, # Maximum facet values that are returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. For aggregation in healthcare search, when the [FacetKey.key] is "healthcare_aggregation_key", the limit will be overridden to 10,000 internally, regardless of the value set here. If this field is negative, an `INVALID_ARGUMENT` is returned.
+        },
+      ],
+      "filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
+      "imageQuery": { # Specifies the image query input. # Raw image query.
+        "imageBytes": "A String", # Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP.
+      },
+      "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.
+      "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done.
+        "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Default to Condition.DISABLED.
+        "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.
+          "A String",
+        ],
+      },
+      "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.
+      "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering for retail search, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
+      "pageSize": 42, # Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.
+      "pageToken": "A String", # A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.
+      "params": { # Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. For example, `user_country_code: "au"` For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example, `search_type: 1`
+        "a_key": "",
+      },
+      "query": "A String", # Raw search query.
+      "queryExpansionSpec": { # Specification to determine under which conditions query expansion should occur. # The query expansion specification that specifies the conditions under which query expansion occurs.
+        "condition": "A String", # The condition under which query expansion should occur. Default to Condition.DISABLED.
+        "pinUnexpandedResults": True or False, # Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results.
+      },
+      "rankingExpression": "A String", # The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The ranking expression is a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.
+      "regionCode": "A String", # The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.
+      "safeSearch": True or False, # Whether to turn on safe search. This is only supported for website search.
+      "searchAsYouTypeSpec": { # Specification for search as you type in search requests. # Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical.
+        "condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED.
+      },
+      "servingConfig": "A String", # Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.
+      "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.
+      "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set.
+        "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID.
+        "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is simliar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode.
+      },
+      "spellCorrectionSpec": { # The specification for query spell correction. # The spell correction specification that specifies the mode under which spell correction takes effect.
+        "mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO.
+      },
+      "userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics.
+        "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set.
+        "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+      },
+      "userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * 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. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.
+        "a_key": "A String",
+      },
+      "userPseudoId": "A String", # A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+    },
+  },
+  "name": "A String", # Immutable. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+  "qualityMetrics": { # Describes the metrics produced by the evaluation. # Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet. Only populated when the evaluation's state is SUCCEEDED.
+    "docNdcg": { # Stores the metric values at specific top-k levels. # Normalized discounted cumulative gain (NDCG) per document, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved documents (D1, D2, D3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [D3 (0), D1 (1), D2 (1)] Ideal: [D1 (1), D2 (1), D3 (0)] Calculate NDCG@3 for each SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693
+      "top1": 3.14, # The top-1 value.
+      "top10": 3.14, # The top-10 value.
+      "top3": 3.14, # The top-3 value.
+      "top5": 3.14, # The top-5 value.
+    },
+    "docPrecision": { # Stores the metric values at specific top-k levels. # Precision per document, at various top-k cutoff levels. Precision is the fraction of retrieved documents that are relevant. Example (top-5): * For a single SampleQuery, If 4 out of 5 retrieved documents in the top-5 are relevant, precision@5 = 4/5 = 0.8
+      "top1": 3.14, # The top-1 value.
+      "top10": 3.14, # The top-10 value.
+      "top3": 3.14, # The top-3 value.
+      "top5": 3.14, # The top-5 value.
+    },
+    "docRecall": { # Stores the metric values at specific top-k levels. # Recall per document, at various top-k cutoff levels. Recall is the fraction of relevant documents retrieved out of all relevant documents. Example (top-5): * For a single SampleQuery, If 3 out of 5 relevant documents are retrieved in the top-5, recall@5 = 3/5 = 0.6
+      "top1": 3.14, # The top-1 value.
+      "top10": 3.14, # The top-10 value.
+      "top3": 3.14, # The top-3 value.
+      "top5": 3.14, # The top-5 value.
+    },
+    "pageNdcg": { # Stores the metric values at specific top-k levels. # Normalized discounted cumulative gain (NDCG) per page, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved pages (P1, P2, P3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [P3 (0), P1 (1), P2 (1)] Ideal: [P1 (1), P2 (1), P3 (0)] Calculate NDCG@3 for SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693
+      "top1": 3.14, # The top-1 value.
+      "top10": 3.14, # The top-10 value.
+      "top3": 3.14, # The top-3 value.
+      "top5": 3.14, # The top-5 value.
+    },
+    "pageRecall": { # Stores the metric values at specific top-k levels. # Recall per page, at various top-k cutoff levels. Recall is the fraction of relevant pages retrieved out of all relevant pages. Example (top-5): * For a single SampleQuery, if 3 out of 5 relevant pages are retrieved in the top-5, recall@5 = 3/5 = 0.6
+      "top1": 3.14, # The top-1 value.
+      "top10": 3.14, # The top-10 value.
+      "top3": 3.14, # The top-3 value.
+      "top5": 3.14, # The top-5 value.
+    },
+  },
+  "state": "A String", # Output only. The state of the evaluation.
+}
+
+  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 a Evaluation.
+
+Args:
+  name: string, Required. Full resource name of Evaluation, such as `projects/{project}/locations/{location}/evaluations/{evaluation}`. If the caller does not have permission to access the Evaluation, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Evaluation does not exist, a NOT_FOUND error is returned. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data.
+  "createTime": "A String", # Output only. Timestamp the Evaluation was created at.
+  "endTime": "A String", # Output only. Timestamp the Evaluation was completed at.
+  "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). # Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED.
+    "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.
+  },
+  "errorSamples": [ # Output only. A sample of errors encountered while processing the request.
+    { # 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).
+      "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.
+    },
+  ],
+  "evaluationSpec": { # Describes the specification of the evaluation. # Required. The specification of the evaluation.
+    "querySetSpec": { # Describes the specification of the query set. # Required. The specification of the query set.
+      "sampleQuerySet": "A String", # Required. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.
+    },
+    "searchRequest": { # Request message for SearchService.Search method. # Required. The search request that is used to perform the evaluation. Only the following fields within SearchRequest are supported; if any other fields are provided, an UNSUPPORTED error will be returned: * SearchRequest.serving_config * SearchRequest.branch * SearchRequest.canonical_filter * SearchRequest.query_expansion_spec * SearchRequest.spell_correction_spec * SearchRequest.content_search_spec * SearchRequest.user_pseudo_id
+      "boostSpec": { # Boost specification to boost certain documents. # Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)
+        "conditionBoostSpecs": [ # Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.
+          { # Boost applies to documents which match a condition.
+            "boost": 3.14, # Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied.
+            "boostControlSpec": { # Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. # Complex specification for custom ranking based on customer defined attribute value.
+              "attributeType": "A String", # The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).
+              "controlPoints": [ # The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.
+                { # The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).
+                  "attributeValue": "A String", # Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.
+                  "boostAmount": 3.14, # The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.
+                },
+              ],
+              "fieldName": "A String", # The name of the field whose value will be used to determine the boost amount.
+              "interpolationType": "A String", # The interpolation type to be applied to connect the control points listed below.
+            },
+            "condition": "A String", # An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": `(document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))`
+          },
+        ],
+      },
+      "branch": "A String", # The branch resource name, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Use `default_branch` as the branch ID or leave this field empty, to search documents under the default branch.
+      "canonicalFilter": "A String", # The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about filter syntax, see SearchRequest.filter.
+      "contentSearchSpec": { # A specification for configuring the behavior of content search. # A specification for configuring the behavior of content search.
+        "chunkSpec": { # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS
+          "numNextChunks": 42, # The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned.
+          "numPreviousChunks": 42, # The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned.
+        },
+        "extractiveContentSpec": { # A specification for configuring the extractive content in a search response. # If there is no extractive_content_spec provided, there will be no extractive answer in the search response.
+          "maxExtractiveAnswerCount": 42, # The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult.
+          "maxExtractiveSegmentCount": 42, # The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`.
+          "numNextSegments": 42, # Return at most `num_next_segments` segments after each selected segments.
+          "numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.
+          "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`.
+        },
+        "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.
+        "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response.
+          "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0.
+          "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet.
+          "returnSnippet": True or False, # If `true`, then return snippet. If no snippet can be generated, we return "No snippet is available for this page." A `snippet_status` with `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned.
+        },
+        "summarySpec": { # A specification for configuring a summary returned in a search response. # If `summarySpec` is not specified, summaries are not included in the search response.
+          "ignoreAdversarialQuery": True or False, # Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead.
+          "ignoreNonSummarySeekingQuery": True or False, # Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead.
+          "includeCitations": True or False, # Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results.
+          "languageCode": "A String", # Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.
+          "modelPromptSpec": { # Specification of the prompt to use with the model. # If specified, the spec will be used to modify the prompt provided to the LLM.
+            "preamble": "A String", # Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide.
+          },
+          "modelSpec": { # Specification of the model. # If specified, the spec will be used to modify the model specification provided to the LLM.
+            "version": "A String", # The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). * `preview`: string. (Public preview) Uses a preview model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).
+          },
+          "summaryResultCount": 42, # The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.
+          "useSemanticChunks": True or False, # If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list.
+        },
+      },
+      "dataStoreSpecs": [ # Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.
+        { # A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned.
+          "dataStore": "A String", # Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
+        },
+      ],
+      "embeddingSpec": { # The specification that uses customized query embedding vector to do semantic document retrieval. # Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path.
+        "embeddingVectors": [ # The embedding vector used for retrieval. Limit to 1.
+          { # Embedding vector.
+            "fieldPath": "A String", # Embedding field path in schema.
+            "vector": [ # Query embedding vector.
+              3.14,
+            ],
+          },
+        ],
+      },
+      "facetSpecs": [ # Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.
+        { # A facet specification to perform faceted search.
+          "enableDynamicPosition": True or False, # Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false * "brands", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how API orders "gender" and "rating" facets. However, notice that "price" and "brands" are always ranked at first and second position because their enable_dynamic_position is false.
+          "excludedFilterKeys": [ # List of keys to exclude when faceting. By default, FacetKey.key is not excluded from the filter unless it is listed in this field. Listing a facet key in this field allows its values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned. For example, suppose there are 100 documents with the color facet "Red" and 200 documents with the color facet "Blue". A query containing the filter "color:ANY("Red")" and having "color" as FacetKey.key would by default return only "Red" documents in the search results, and also return "Red" with count 100 as the only color facet. Although there are also blue documents available, "Blue" would not be shown as an available facet value. If "color" is listed in "excludedFilterKeys", then the query returns the facet values "Red" with count 100 and "Blue" with count 200, because the "color" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly filtered to return only "Red" documents. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.
+            "A String",
+          ],
+          "facetKey": { # Specifies how a facet is computed. # Required. The facet key specification.
+            "caseInsensitive": True or False, # True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.
+            "contains": [ # Only get facet values that contain the given strings. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "contains" to "2022", the "category" facet only contains "Action > 2022" and "Sci-Fi > 2022". Only supported on textual fields. Maximum is 10.
+              "A String",
+            ],
+            "intervals": [ # Set only if values should be bucketed into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30.
+              { # A floating point interval.
+                "exclusiveMaximum": 3.14, # Exclusive upper bound.
+                "exclusiveMinimum": 3.14, # Exclusive lower bound.
+                "maximum": 3.14, # Inclusive upper bound.
+                "minimum": 3.14, # Inclusive lower bound.
+              },
+            ],
+            "key": "A String", # Required. Supported textual and numerical facet keys in Document object, over which the facet values are computed. Facet key is case-sensitive.
+            "orderBy": "A String", # The order in which documents are returned. Allowed values are: * "count desc", which means order by SearchResponse.Facet.values.count descending. * "value desc", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets. If not set, textual values are sorted in [natural order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals.
+            "prefixes": [ # Only get facet values that start with the given string prefix. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "prefixes" to "Action", the "category" facet only contains "Action > 2022" and "Action > 2021". Only supported on textual fields. Maximum is 10.
+              "A String",
+            ],
+            "restrictedValues": [ # Only get facet for the given restricted values. Only supported on textual fields. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "restricted_values" to "Action > 2022", the "category" facet only contains "Action > 2022". Only supported on textual fields. Maximum is 10.
+              "A String",
+            ],
+          },
+          "limit": 42, # Maximum facet values that are returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. For aggregation in healthcare search, when the [FacetKey.key] is "healthcare_aggregation_key", the limit will be overridden to 10,000 internally, regardless of the value set here. If this field is negative, an `INVALID_ARGUMENT` is returned.
+        },
+      ],
+      "filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
+      "imageQuery": { # Specifies the image query input. # Raw image query.
+        "imageBytes": "A String", # Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP.
+      },
+      "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.
+      "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done.
+        "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Default to Condition.DISABLED.
+        "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.
+          "A String",
+        ],
+      },
+      "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.
+      "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering for retail search, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
+      "pageSize": 42, # Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.
+      "pageToken": "A String", # A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.
+      "params": { # Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. For example, `user_country_code: "au"` For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example, `search_type: 1`
+        "a_key": "",
+      },
+      "query": "A String", # Raw search query.
+      "queryExpansionSpec": { # Specification to determine under which conditions query expansion should occur. # The query expansion specification that specifies the conditions under which query expansion occurs.
+        "condition": "A String", # The condition under which query expansion should occur. Default to Condition.DISABLED.
+        "pinUnexpandedResults": True or False, # Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results.
+      },
+      "rankingExpression": "A String", # The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The ranking expression is a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.
+      "regionCode": "A String", # The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.
+      "safeSearch": True or False, # Whether to turn on safe search. This is only supported for website search.
+      "searchAsYouTypeSpec": { # Specification for search as you type in search requests. # Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical.
+        "condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED.
+      },
+      "servingConfig": "A String", # Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.
+      "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.
+      "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set.
+        "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID.
+        "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is simliar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode.
+      },
+      "spellCorrectionSpec": { # The specification for query spell correction. # The spell correction specification that specifies the mode under which spell correction takes effect.
+        "mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO.
+      },
+      "userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics.
+        "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set.
+        "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+      },
+      "userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * 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. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.
+        "a_key": "A String",
+      },
+      "userPseudoId": "A String", # A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+    },
+  },
+  "name": "A String", # Immutable. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+  "qualityMetrics": { # Describes the metrics produced by the evaluation. # Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet. Only populated when the evaluation's state is SUCCEEDED.
+    "docNdcg": { # Stores the metric values at specific top-k levels. # Normalized discounted cumulative gain (NDCG) per document, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved documents (D1, D2, D3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [D3 (0), D1 (1), D2 (1)] Ideal: [D1 (1), D2 (1), D3 (0)] Calculate NDCG@3 for each SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693
+      "top1": 3.14, # The top-1 value.
+      "top10": 3.14, # The top-10 value.
+      "top3": 3.14, # The top-3 value.
+      "top5": 3.14, # The top-5 value.
+    },
+    "docPrecision": { # Stores the metric values at specific top-k levels. # Precision per document, at various top-k cutoff levels. Precision is the fraction of retrieved documents that are relevant. Example (top-5): * For a single SampleQuery, If 4 out of 5 retrieved documents in the top-5 are relevant, precision@5 = 4/5 = 0.8
+      "top1": 3.14, # The top-1 value.
+      "top10": 3.14, # The top-10 value.
+      "top3": 3.14, # The top-3 value.
+      "top5": 3.14, # The top-5 value.
+    },
+    "docRecall": { # Stores the metric values at specific top-k levels. # Recall per document, at various top-k cutoff levels. Recall is the fraction of relevant documents retrieved out of all relevant documents. Example (top-5): * For a single SampleQuery, If 3 out of 5 relevant documents are retrieved in the top-5, recall@5 = 3/5 = 0.6
+      "top1": 3.14, # The top-1 value.
+      "top10": 3.14, # The top-10 value.
+      "top3": 3.14, # The top-3 value.
+      "top5": 3.14, # The top-5 value.
+    },
+    "pageNdcg": { # Stores the metric values at specific top-k levels. # Normalized discounted cumulative gain (NDCG) per page, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved pages (P1, P2, P3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [P3 (0), P1 (1), P2 (1)] Ideal: [P1 (1), P2 (1), P3 (0)] Calculate NDCG@3 for SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693
+      "top1": 3.14, # The top-1 value.
+      "top10": 3.14, # The top-10 value.
+      "top3": 3.14, # The top-3 value.
+      "top5": 3.14, # The top-5 value.
+    },
+    "pageRecall": { # Stores the metric values at specific top-k levels. # Recall per page, at various top-k cutoff levels. Recall is the fraction of relevant pages retrieved out of all relevant pages. Example (top-5): * For a single SampleQuery, if 3 out of 5 relevant pages are retrieved in the top-5, recall@5 = 3/5 = 0.6
+      "top1": 3.14, # The top-1 value.
+      "top10": 3.14, # The top-10 value.
+      "top3": 3.14, # The top-3 value.
+      "top5": 3.14, # The top-5 value.
+    },
+  },
+  "state": "A String", # Output only. The state of the evaluation.
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Gets a list of Evaluations.
+
+Args:
+  parent: string, Required. The parent location resource name, such as `projects/{project}/locations/{location}`. If the caller does not have permission to list Evaluations under this location, regardless of whether or not this location exists, a `PERMISSION_DENIED` error is returned. (required)
+  pageSize: integer, Maximum number of Evaluations to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.
+  pageToken: string, A page token ListEvaluationsResponse.next_page_token, received from a previous EvaluationService.ListEvaluations call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to EvaluationService.ListEvaluations must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error 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 EvaluationService.ListEvaluations method.
+  "evaluations": [ # The Evaluations.
+    { # An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data.
+      "createTime": "A String", # Output only. Timestamp the Evaluation was created at.
+      "endTime": "A String", # Output only. Timestamp the Evaluation was completed at.
+      "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). # Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED.
+        "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.
+      },
+      "errorSamples": [ # Output only. A sample of errors encountered while processing the request.
+        { # 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).
+          "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.
+        },
+      ],
+      "evaluationSpec": { # Describes the specification of the evaluation. # Required. The specification of the evaluation.
+        "querySetSpec": { # Describes the specification of the query set. # Required. The specification of the query set.
+          "sampleQuerySet": "A String", # Required. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.
+        },
+        "searchRequest": { # Request message for SearchService.Search method. # Required. The search request that is used to perform the evaluation. Only the following fields within SearchRequest are supported; if any other fields are provided, an UNSUPPORTED error will be returned: * SearchRequest.serving_config * SearchRequest.branch * SearchRequest.canonical_filter * SearchRequest.query_expansion_spec * SearchRequest.spell_correction_spec * SearchRequest.content_search_spec * SearchRequest.user_pseudo_id
+          "boostSpec": { # Boost specification to boost certain documents. # Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)
+            "conditionBoostSpecs": [ # Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.
+              { # Boost applies to documents which match a condition.
+                "boost": 3.14, # Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied.
+                "boostControlSpec": { # Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. # Complex specification for custom ranking based on customer defined attribute value.
+                  "attributeType": "A String", # The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).
+                  "controlPoints": [ # The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.
+                    { # The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).
+                      "attributeValue": "A String", # Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.
+                      "boostAmount": 3.14, # The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.
+                    },
+                  ],
+                  "fieldName": "A String", # The name of the field whose value will be used to determine the boost amount.
+                  "interpolationType": "A String", # The interpolation type to be applied to connect the control points listed below.
+                },
+                "condition": "A String", # An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": `(document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))`
+              },
+            ],
+          },
+          "branch": "A String", # The branch resource name, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Use `default_branch` as the branch ID or leave this field empty, to search documents under the default branch.
+          "canonicalFilter": "A String", # The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about filter syntax, see SearchRequest.filter.
+          "contentSearchSpec": { # A specification for configuring the behavior of content search. # A specification for configuring the behavior of content search.
+            "chunkSpec": { # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS
+              "numNextChunks": 42, # The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned.
+              "numPreviousChunks": 42, # The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned.
+            },
+            "extractiveContentSpec": { # A specification for configuring the extractive content in a search response. # If there is no extractive_content_spec provided, there will be no extractive answer in the search response.
+              "maxExtractiveAnswerCount": 42, # The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult.
+              "maxExtractiveSegmentCount": 42, # The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`.
+              "numNextSegments": 42, # Return at most `num_next_segments` segments after each selected segments.
+              "numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.
+              "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`.
+            },
+            "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.
+            "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response.
+              "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0.
+              "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet.
+              "returnSnippet": True or False, # If `true`, then return snippet. If no snippet can be generated, we return "No snippet is available for this page." A `snippet_status` with `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned.
+            },
+            "summarySpec": { # A specification for configuring a summary returned in a search response. # If `summarySpec` is not specified, summaries are not included in the search response.
+              "ignoreAdversarialQuery": True or False, # Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead.
+              "ignoreNonSummarySeekingQuery": True or False, # Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead.
+              "includeCitations": True or False, # Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results.
+              "languageCode": "A String", # Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.
+              "modelPromptSpec": { # Specification of the prompt to use with the model. # If specified, the spec will be used to modify the prompt provided to the LLM.
+                "preamble": "A String", # Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide.
+              },
+              "modelSpec": { # Specification of the model. # If specified, the spec will be used to modify the model specification provided to the LLM.
+                "version": "A String", # The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). * `preview`: string. (Public preview) Uses a preview model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).
+              },
+              "summaryResultCount": 42, # The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.
+              "useSemanticChunks": True or False, # If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list.
+            },
+          },
+          "dataStoreSpecs": [ # Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.
+            { # A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned.
+              "dataStore": "A String", # Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
+            },
+          ],
+          "embeddingSpec": { # The specification that uses customized query embedding vector to do semantic document retrieval. # Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path.
+            "embeddingVectors": [ # The embedding vector used for retrieval. Limit to 1.
+              { # Embedding vector.
+                "fieldPath": "A String", # Embedding field path in schema.
+                "vector": [ # Query embedding vector.
+                  3.14,
+                ],
+              },
+            ],
+          },
+          "facetSpecs": [ # Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.
+            { # A facet specification to perform faceted search.
+              "enableDynamicPosition": True or False, # Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false * "brands", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how API orders "gender" and "rating" facets. However, notice that "price" and "brands" are always ranked at first and second position because their enable_dynamic_position is false.
+              "excludedFilterKeys": [ # List of keys to exclude when faceting. By default, FacetKey.key is not excluded from the filter unless it is listed in this field. Listing a facet key in this field allows its values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned. For example, suppose there are 100 documents with the color facet "Red" and 200 documents with the color facet "Blue". A query containing the filter "color:ANY("Red")" and having "color" as FacetKey.key would by default return only "Red" documents in the search results, and also return "Red" with count 100 as the only color facet. Although there are also blue documents available, "Blue" would not be shown as an available facet value. If "color" is listed in "excludedFilterKeys", then the query returns the facet values "Red" with count 100 and "Blue" with count 200, because the "color" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly filtered to return only "Red" documents. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.
+                "A String",
+              ],
+              "facetKey": { # Specifies how a facet is computed. # Required. The facet key specification.
+                "caseInsensitive": True or False, # True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.
+                "contains": [ # Only get facet values that contain the given strings. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "contains" to "2022", the "category" facet only contains "Action > 2022" and "Sci-Fi > 2022". Only supported on textual fields. Maximum is 10.
+                  "A String",
+                ],
+                "intervals": [ # Set only if values should be bucketed into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30.
+                  { # A floating point interval.
+                    "exclusiveMaximum": 3.14, # Exclusive upper bound.
+                    "exclusiveMinimum": 3.14, # Exclusive lower bound.
+                    "maximum": 3.14, # Inclusive upper bound.
+                    "minimum": 3.14, # Inclusive lower bound.
+                  },
+                ],
+                "key": "A String", # Required. Supported textual and numerical facet keys in Document object, over which the facet values are computed. Facet key is case-sensitive.
+                "orderBy": "A String", # The order in which documents are returned. Allowed values are: * "count desc", which means order by SearchResponse.Facet.values.count descending. * "value desc", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets. If not set, textual values are sorted in [natural order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals.
+                "prefixes": [ # Only get facet values that start with the given string prefix. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "prefixes" to "Action", the "category" facet only contains "Action > 2022" and "Action > 2021". Only supported on textual fields. Maximum is 10.
+                  "A String",
+                ],
+                "restrictedValues": [ # Only get facet for the given restricted values. Only supported on textual fields. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "restricted_values" to "Action > 2022", the "category" facet only contains "Action > 2022". Only supported on textual fields. Maximum is 10.
+                  "A String",
+                ],
+              },
+              "limit": 42, # Maximum facet values that are returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. For aggregation in healthcare search, when the [FacetKey.key] is "healthcare_aggregation_key", the limit will be overridden to 10,000 internally, regardless of the value set here. If this field is negative, an `INVALID_ARGUMENT` is returned.
+            },
+          ],
+          "filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
+          "imageQuery": { # Specifies the image query input. # Raw image query.
+            "imageBytes": "A String", # Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP.
+          },
+          "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.
+          "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done.
+            "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Default to Condition.DISABLED.
+            "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.
+              "A String",
+            ],
+          },
+          "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.
+          "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering for retail search, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
+          "pageSize": 42, # Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.
+          "pageToken": "A String", # A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.
+          "params": { # Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. For example, `user_country_code: "au"` For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example, `search_type: 1`
+            "a_key": "",
+          },
+          "query": "A String", # Raw search query.
+          "queryExpansionSpec": { # Specification to determine under which conditions query expansion should occur. # The query expansion specification that specifies the conditions under which query expansion occurs.
+            "condition": "A String", # The condition under which query expansion should occur. Default to Condition.DISABLED.
+            "pinUnexpandedResults": True or False, # Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results.
+          },
+          "rankingExpression": "A String", # The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The ranking expression is a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.
+          "regionCode": "A String", # The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.
+          "safeSearch": True or False, # Whether to turn on safe search. This is only supported for website search.
+          "searchAsYouTypeSpec": { # Specification for search as you type in search requests. # Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical.
+            "condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED.
+          },
+          "servingConfig": "A String", # Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.
+          "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.
+          "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set.
+            "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID.
+            "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is simliar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode.
+          },
+          "spellCorrectionSpec": { # The specification for query spell correction. # The spell correction specification that specifies the mode under which spell correction takes effect.
+            "mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO.
+          },
+          "userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics.
+            "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set.
+            "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+          },
+          "userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * 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. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.
+            "a_key": "A String",
+          },
+          "userPseudoId": "A String", # A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+        },
+      },
+      "name": "A String", # Immutable. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+      "qualityMetrics": { # Describes the metrics produced by the evaluation. # Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet. Only populated when the evaluation's state is SUCCEEDED.
+        "docNdcg": { # Stores the metric values at specific top-k levels. # Normalized discounted cumulative gain (NDCG) per document, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved documents (D1, D2, D3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [D3 (0), D1 (1), D2 (1)] Ideal: [D1 (1), D2 (1), D3 (0)] Calculate NDCG@3 for each SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693
+          "top1": 3.14, # The top-1 value.
+          "top10": 3.14, # The top-10 value.
+          "top3": 3.14, # The top-3 value.
+          "top5": 3.14, # The top-5 value.
+        },
+        "docPrecision": { # Stores the metric values at specific top-k levels. # Precision per document, at various top-k cutoff levels. Precision is the fraction of retrieved documents that are relevant. Example (top-5): * For a single SampleQuery, If 4 out of 5 retrieved documents in the top-5 are relevant, precision@5 = 4/5 = 0.8
+          "top1": 3.14, # The top-1 value.
+          "top10": 3.14, # The top-10 value.
+          "top3": 3.14, # The top-3 value.
+          "top5": 3.14, # The top-5 value.
+        },
+        "docRecall": { # Stores the metric values at specific top-k levels. # Recall per document, at various top-k cutoff levels. Recall is the fraction of relevant documents retrieved out of all relevant documents. Example (top-5): * For a single SampleQuery, If 3 out of 5 relevant documents are retrieved in the top-5, recall@5 = 3/5 = 0.6
+          "top1": 3.14, # The top-1 value.
+          "top10": 3.14, # The top-10 value.
+          "top3": 3.14, # The top-3 value.
+          "top5": 3.14, # The top-5 value.
+        },
+        "pageNdcg": { # Stores the metric values at specific top-k levels. # Normalized discounted cumulative gain (NDCG) per page, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved pages (P1, P2, P3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [P3 (0), P1 (1), P2 (1)] Ideal: [P1 (1), P2 (1), P3 (0)] Calculate NDCG@3 for SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693
+          "top1": 3.14, # The top-1 value.
+          "top10": 3.14, # The top-10 value.
+          "top3": 3.14, # The top-3 value.
+          "top5": 3.14, # The top-5 value.
+        },
+        "pageRecall": { # Stores the metric values at specific top-k levels. # Recall per page, at various top-k cutoff levels. Recall is the fraction of relevant pages retrieved out of all relevant pages. Example (top-5): * For a single SampleQuery, if 3 out of 5 relevant pages are retrieved in the top-5, recall@5 = 3/5 = 0.6
+          "top1": 3.14, # The top-1 value.
+          "top10": 3.14, # The top-10 value.
+          "top3": 3.14, # The top-3 value.
+          "top5": 3.14, # The top-5 value.
+        },
+      },
+      "state": "A String", # Output only. The state of the evaluation.
+    },
+  ],
+  "nextPageToken": "A String", # A token that can be sent as ListEvaluationsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
+}
+
+ +
+ listResults(evaluation, pageSize=None, pageToken=None, x__xgafv=None) +
Gets a list of results for a given a Evaluation.
+
+Args:
+  evaluation: string, Required. The evaluation resource name, such as `projects/{project}/locations/{location}/evaluations/{evaluation}`. If the caller does not have permission to list EvaluationResult under this evaluation, regardless of whether or not this evaluation set exists, a `PERMISSION_DENIED` error is returned. (required)
+  pageSize: integer, Maximum number of EvaluationResult to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.
+  pageToken: string, A page token ListEvaluationResultsResponse.next_page_token, received from a previous EvaluationService.ListEvaluationResults call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to EvaluationService.ListEvaluationResults must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error 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 EvaluationService.ListEvaluationResults method.
+  "evaluationResults": [ # The EvaluationResults.
+    { # Represents the results of an evaluation for a single SampleQuery.
+      "qualityMetrics": { # Describes the metrics produced by the evaluation. # Output only. The metrics produced by the evaluation, for a given SampleQuery.
+        "docNdcg": { # Stores the metric values at specific top-k levels. # Normalized discounted cumulative gain (NDCG) per document, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved documents (D1, D2, D3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [D3 (0), D1 (1), D2 (1)] Ideal: [D1 (1), D2 (1), D3 (0)] Calculate NDCG@3 for each SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693
+          "top1": 3.14, # The top-1 value.
+          "top10": 3.14, # The top-10 value.
+          "top3": 3.14, # The top-3 value.
+          "top5": 3.14, # The top-5 value.
+        },
+        "docPrecision": { # Stores the metric values at specific top-k levels. # Precision per document, at various top-k cutoff levels. Precision is the fraction of retrieved documents that are relevant. Example (top-5): * For a single SampleQuery, If 4 out of 5 retrieved documents in the top-5 are relevant, precision@5 = 4/5 = 0.8
+          "top1": 3.14, # The top-1 value.
+          "top10": 3.14, # The top-10 value.
+          "top3": 3.14, # The top-3 value.
+          "top5": 3.14, # The top-5 value.
+        },
+        "docRecall": { # Stores the metric values at specific top-k levels. # Recall per document, at various top-k cutoff levels. Recall is the fraction of relevant documents retrieved out of all relevant documents. Example (top-5): * For a single SampleQuery, If 3 out of 5 relevant documents are retrieved in the top-5, recall@5 = 3/5 = 0.6
+          "top1": 3.14, # The top-1 value.
+          "top10": 3.14, # The top-10 value.
+          "top3": 3.14, # The top-3 value.
+          "top5": 3.14, # The top-5 value.
+        },
+        "pageNdcg": { # Stores the metric values at specific top-k levels. # Normalized discounted cumulative gain (NDCG) per page, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved pages (P1, P2, P3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [P3 (0), P1 (1), P2 (1)] Ideal: [P1 (1), P2 (1), P3 (0)] Calculate NDCG@3 for SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693
+          "top1": 3.14, # The top-1 value.
+          "top10": 3.14, # The top-10 value.
+          "top3": 3.14, # The top-3 value.
+          "top5": 3.14, # The top-5 value.
+        },
+        "pageRecall": { # Stores the metric values at specific top-k levels. # Recall per page, at various top-k cutoff levels. Recall is the fraction of relevant pages retrieved out of all relevant pages. Example (top-5): * For a single SampleQuery, if 3 out of 5 relevant pages are retrieved in the top-5, recall@5 = 3/5 = 0.6
+          "top1": 3.14, # The top-1 value.
+          "top10": 3.14, # The top-10 value.
+          "top3": 3.14, # The top-3 value.
+          "top5": 3.14, # The top-5 value.
+        },
+      },
+      "sampleQuery": { # Sample Query captures metadata to be used for evaluation. # Output only. The SampleQuery that was evaluated.
+        "createTime": "A String", # Output only. Timestamp the SampleQuery was created at.
+        "name": "A String", # Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+        "queryEntry": { # Query Entry captures metadata to be used for search evaluation. # The query entry.
+          "query": "A String", # Required. The query.
+          "targets": [ # List of targets for the query.
+            { # Defines the parameters of the query's expected outcome.
+              "pageNumbers": [ # Expected page numbers of the target. Each page number must be non negative.
+                42,
+              ],
+              "score": 3.14, # Relevance score of the target.
+              "uri": "A String", # Expected uri of the target. This field must be a UTF-8 encoded string with a length limit of 2048 characters. Example of valid uris: `https://example.com/abc`, `gcs://example/example.pdf`.
+            },
+          ],
+        },
+      },
+    },
+  ],
+  "nextPageToken": "A String", # A token that can be sent as ListEvaluationResultsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
+}
+
+ +
+ listResults_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.
+        
+
+ +
+ 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/discoveryengine_v1beta.projects.locations.sampleQuerySets.html b/docs/dyn/discoveryengine_v1beta.projects.locations.sampleQuerySets.html index f9afeb97172..5500436b5b9 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.sampleQuerySets.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.sampleQuerySets.html @@ -79,13 +79,185 @@

Instance Methods

Returns the operations Resource.

+

+ sampleQueries() +

+

Returns the sampleQueries Resource.

+

close()

Close httplib2 connections.

+

+ create(parent, body=None, sampleQuerySetId=None, x__xgafv=None)

+

Creates a SampleQuerySet

+

+ delete(name, x__xgafv=None)

+

Deletes a SampleQuerySet.

+

+ get(name, x__xgafv=None)

+

Gets a SampleQuerySet.

+

+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)

+

Gets a list of SampleQuerySets.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(name, body=None, updateMask=None, x__xgafv=None)

+

Updates a SampleQuerySet.

Method Details

close()
Close httplib2 connections.
+
+ create(parent, body=None, sampleQuerySetId=None, x__xgafv=None) +
Creates a SampleQuerySet
+
+Args:
+  parent: string, Required. The parent resource name, such as `projects/{project}/locations/{location}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A SampleQuerySet is the parent resource of SampleQuery, and contains the configurations shared by all SampleQuery under it.
+  "createTime": "A String", # Output only. Timestamp the SampleQuerySet was created at.
+  "description": "A String", # The description of the SampleQuerySet.
+  "displayName": "A String", # Required. The sample query set display name. This field must be a UTF-8 encoded string with a length limit of 128 characters.
+  "name": "A String", # Immutable. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+}
+
+  sampleQuerySetId: string, Required. The ID to use for the SampleQuerySet, which will become the final component of the SampleQuerySet.name. If the caller does not have permission to create the SampleQuerySet, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all SampleQuerySets with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A SampleQuerySet is the parent resource of SampleQuery, and contains the configurations shared by all SampleQuery under it.
+  "createTime": "A String", # Output only. Timestamp the SampleQuerySet was created at.
+  "description": "A String", # The description of the SampleQuerySet.
+  "displayName": "A String", # Required. The sample query set display name. This field must be a UTF-8 encoded string with a length limit of 128 characters.
+  "name": "A String", # Immutable. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+}
+
+ +
+ delete(name, x__xgafv=None) +
Deletes a SampleQuerySet.
+
+Args:
+  name: string, Required. Full resource name of SampleQuerySet, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to delete the SampleQuerySet, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the SampleQuerySet to delete does not exist, a `NOT_FOUND` error is returned. (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 a SampleQuerySet.
+
+Args:
+  name: string, Required. Full resource name of SampleQuerySet, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to access the SampleQuerySet, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested SampleQuerySet does not exist, a NOT_FOUND error is returned. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A SampleQuerySet is the parent resource of SampleQuery, and contains the configurations shared by all SampleQuery under it.
+  "createTime": "A String", # Output only. Timestamp the SampleQuerySet was created at.
+  "description": "A String", # The description of the SampleQuerySet.
+  "displayName": "A String", # Required. The sample query set display name. This field must be a UTF-8 encoded string with a length limit of 128 characters.
+  "name": "A String", # Immutable. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Gets a list of SampleQuerySets.
+
+Args:
+  parent: string, Required. The parent location resource name, such as `projects/{project}/locations/{location}`. If the caller does not have permission to list SampleQuerySets under this location, regardless of whether or not this location exists, a `PERMISSION_DENIED` error is returned. (required)
+  pageSize: integer, Maximum number of SampleQuerySets to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.
+  pageToken: string, A page token ListSampleQuerySetsResponse.next_page_token, received from a previous SampleQuerySetService.ListSampleQuerySets call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SampleQuerySetService.ListSampleQuerySets must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error 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 SampleQuerySetService.ListSampleQuerySets method.
+  "nextPageToken": "A String", # A token that can be sent as ListSampleQuerySetsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
+  "sampleQuerySets": [ # The SampleQuerySets.
+    { # A SampleQuerySet is the parent resource of SampleQuery, and contains the configurations shared by all SampleQuery under it.
+      "createTime": "A String", # Output only. Timestamp the SampleQuerySet was created at.
+      "description": "A String", # The description of the SampleQuerySet.
+      "displayName": "A String", # Required. The sample query set display name. This field must be a UTF-8 encoded string with a length limit of 128 characters.
+      "name": "A String", # Immutable. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+    },
+  ],
+}
+
+ +
+ 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, body=None, updateMask=None, x__xgafv=None) +
Updates a SampleQuerySet.
+
+Args:
+  name: string, Immutable. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A SampleQuerySet is the parent resource of SampleQuery, and contains the configurations shared by all SampleQuery under it.
+  "createTime": "A String", # Output only. Timestamp the SampleQuerySet was created at.
+  "description": "A String", # The description of the SampleQuerySet.
+  "displayName": "A String", # Required. The sample query set display name. This field must be a UTF-8 encoded string with a length limit of 128 characters.
+  "name": "A String", # Immutable. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+}
+
+  updateMask: string, Indicates which fields in the provided imported 'sample query set' to update. If not set, will by default update all fields.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A SampleQuerySet is the parent resource of SampleQuery, and contains the configurations shared by all SampleQuery under it.
+  "createTime": "A String", # Output only. Timestamp the SampleQuerySet was created at.
+  "description": "A String", # The description of the SampleQuerySet.
+  "displayName": "A String", # Required. The sample query set display name. This field must be a UTF-8 encoded string with a length limit of 128 characters.
+  "name": "A String", # Immutable. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.sampleQuerySets.sampleQueries.html b/docs/dyn/discoveryengine_v1beta.projects.locations.sampleQuerySets.sampleQueries.html new file mode 100644 index 00000000000..70a61c930b0 --- /dev/null +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.sampleQuerySets.sampleQueries.html @@ -0,0 +1,398 @@ + + + +

Discovery Engine API . projects . locations . sampleQuerySets . sampleQueries

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ create(parent, body=None, sampleQueryId=None, x__xgafv=None)

+

Creates a SampleQuery

+

+ delete(name, x__xgafv=None)

+

Deletes a SampleQuery.

+

+ get(name, x__xgafv=None)

+

Gets a SampleQuery.

+

+ import_(parent, body=None, x__xgafv=None)

+

Bulk import of multiple SampleQuerys. Sample queries that already exist may be deleted. Note: It is possible for a subset of the SampleQuerys to be successfully imported.

+

+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)

+

Gets a list of SampleQuerys.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(name, body=None, updateMask=None, x__xgafv=None)

+

Updates a SampleQuery.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, sampleQueryId=None, x__xgafv=None) +
Creates a SampleQuery
+
+Args:
+  parent: string, Required. The parent resource name, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Sample Query captures metadata to be used for evaluation.
+  "createTime": "A String", # Output only. Timestamp the SampleQuery was created at.
+  "name": "A String", # Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+  "queryEntry": { # Query Entry captures metadata to be used for search evaluation. # The query entry.
+    "query": "A String", # Required. The query.
+    "targets": [ # List of targets for the query.
+      { # Defines the parameters of the query's expected outcome.
+        "pageNumbers": [ # Expected page numbers of the target. Each page number must be non negative.
+          42,
+        ],
+        "score": 3.14, # Relevance score of the target.
+        "uri": "A String", # Expected uri of the target. This field must be a UTF-8 encoded string with a length limit of 2048 characters. Example of valid uris: `https://example.com/abc`, `gcs://example/example.pdf`.
+      },
+    ],
+  },
+}
+
+  sampleQueryId: string, Required. The ID to use for the SampleQuery, which will become the final component of the SampleQuery.name. If the caller does not have permission to create the SampleQuery, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all SampleQuerys with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Sample Query captures metadata to be used for evaluation.
+  "createTime": "A String", # Output only. Timestamp the SampleQuery was created at.
+  "name": "A String", # Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+  "queryEntry": { # Query Entry captures metadata to be used for search evaluation. # The query entry.
+    "query": "A String", # Required. The query.
+    "targets": [ # List of targets for the query.
+      { # Defines the parameters of the query's expected outcome.
+        "pageNumbers": [ # Expected page numbers of the target. Each page number must be non negative.
+          42,
+        ],
+        "score": 3.14, # Relevance score of the target.
+        "uri": "A String", # Expected uri of the target. This field must be a UTF-8 encoded string with a length limit of 2048 characters. Example of valid uris: `https://example.com/abc`, `gcs://example/example.pdf`.
+      },
+    ],
+  },
+}
+
+ +
+ delete(name, x__xgafv=None) +
Deletes a SampleQuery.
+
+Args:
+  name: string, Required. Full resource name of SampleQuery, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. If the caller does not have permission to delete the SampleQuery, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the SampleQuery to delete does not exist, a `NOT_FOUND` error is returned. (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 a SampleQuery.
+
+Args:
+  name: string, Required. Full resource name of SampleQuery, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. If the caller does not have permission to access the SampleQuery, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested SampleQuery does not exist, a NOT_FOUND error is returned. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Sample Query captures metadata to be used for evaluation.
+  "createTime": "A String", # Output only. Timestamp the SampleQuery was created at.
+  "name": "A String", # Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+  "queryEntry": { # Query Entry captures metadata to be used for search evaluation. # The query entry.
+    "query": "A String", # Required. The query.
+    "targets": [ # List of targets for the query.
+      { # Defines the parameters of the query's expected outcome.
+        "pageNumbers": [ # Expected page numbers of the target. Each page number must be non negative.
+          42,
+        ],
+        "score": 3.14, # Relevance score of the target.
+        "uri": "A String", # Expected uri of the target. This field must be a UTF-8 encoded string with a length limit of 2048 characters. Example of valid uris: `https://example.com/abc`, `gcs://example/example.pdf`.
+      },
+    ],
+  },
+}
+
+ +
+ import_(parent, body=None, x__xgafv=None) +
Bulk import of multiple SampleQuerys. Sample queries that already exist may be deleted. Note: It is possible for a subset of the SampleQuerys to be successfully imported.
+
+Args:
+  parent: string, Required. The parent sample query set resource name, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to list SampleQuerys under this sample query set, regardless of whether or not this sample query set exists, a `PERMISSION_DENIED` error is returned. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for SampleQueryService.ImportSampleQueries method.
+  "bigquerySource": { # BigQuery source import data from. # BigQuery input source.
+    "dataSchema": "A String", # The schema to use when parsing the data from the source. Supported values for user event imports: * `user_event` (default): One UserEvent per row. Supported values for document imports: * `document` (default): One Document format per row. Each document must have a valid Document.id and one of Document.json_data or Document.struct_data. * `custom`: One custom data per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical.
+    "datasetId": "A String", # Required. The BigQuery data set to copy the data from with a length limit of 1,024 characters.
+    "gcsStagingDir": "A String", # Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the BigQuery export to a specific Cloud Storage directory.
+    "partitionDate": { # 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 # BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format.
+      "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.
+    },
+    "projectId": "A String", # The project ID (can be project # or ID) that the BigQuery source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.
+    "tableId": "A String", # Required. The BigQuery table to copy the data from with a length limit of 1,024 characters.
+  },
+  "errorConfig": { # Configuration of destination for Import related errors. # The desired location of errors incurred during the Import.
+    "gcsPrefix": "A String", # Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.
+  },
+  "gcsSource": { # Cloud Storage location for input content. # Cloud Storage location for the input content.
+    "dataSchema": "A String", # The schema to use when parsing the data from the source. Supported values for document imports: * `document` (default): One JSON Document per line. Each document must have a valid Document.id. * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by `input_uris` becomes a document, with the ID set to the first 128 bits of SHA256(URI) encoded as a hex string. * `custom`: One custom data JSON per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical. * `csv`: A CSV file with header conforming to the defined Schema of the data store. Each entry after the header is imported as a Document. This can only be used by the GENERIC Data Store vertical. Supported values for user event imports: * `user_event` (default): One JSON UserEvent per line.
+    "inputUris": [ # Required. Cloud Storage URIs to input files. Each URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files (or 100,000 files if `data_schema` is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is `content`).
+      "A String",
+    ],
+  },
+  "inlineSource": { # The inline source for SampleQuerys. # The Inline source for sample query entries.
+    "sampleQueries": [ # Required. A list of SampleQuerys to import. Max of 1000 items.
+      { # Sample Query captures metadata to be used for evaluation.
+        "createTime": "A String", # Output only. Timestamp the SampleQuery was created at.
+        "name": "A String", # Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+        "queryEntry": { # Query Entry captures metadata to be used for search evaluation. # The query entry.
+          "query": "A String", # Required. The query.
+          "targets": [ # List of targets for the query.
+            { # Defines the parameters of the query's expected outcome.
+              "pageNumbers": [ # Expected page numbers of the target. Each page number must be non negative.
+                42,
+              ],
+              "score": 3.14, # Relevance score of the target.
+              "uri": "A String", # Expected uri of the target. This field must be a UTF-8 encoded string with a length limit of 2048 characters. Example of valid uris: `https://example.com/abc`, `gcs://example/example.pdf`.
+            },
+          ],
+        },
+      },
+    ],
+  },
+}
+
+  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(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Gets a list of SampleQuerys.
+
+Args:
+  parent: string, Required. The parent sample query set resource name, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to list SampleQuerys under this sample query set, regardless of whether or not this sample query set exists, a `PERMISSION_DENIED` error is returned. (required)
+  pageSize: integer, Maximum number of SampleQuerys to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.
+  pageToken: string, A page token ListSampleQueriesResponse.next_page_token, received from a previous SampleQueryService.ListSampleQueries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SampleQueryService.ListSampleQueries must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error 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 SampleQueryService.ListSampleQueries method.
+  "nextPageToken": "A String", # A token that can be sent as ListSampleQueriesRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
+  "sampleQueries": [ # The SampleQuerys.
+    { # Sample Query captures metadata to be used for evaluation.
+      "createTime": "A String", # Output only. Timestamp the SampleQuery was created at.
+      "name": "A String", # Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+      "queryEntry": { # Query Entry captures metadata to be used for search evaluation. # The query entry.
+        "query": "A String", # Required. The query.
+        "targets": [ # List of targets for the query.
+          { # Defines the parameters of the query's expected outcome.
+            "pageNumbers": [ # Expected page numbers of the target. Each page number must be non negative.
+              42,
+            ],
+            "score": 3.14, # Relevance score of the target.
+            "uri": "A String", # Expected uri of the target. This field must be a UTF-8 encoded string with a length limit of 2048 characters. Example of valid uris: `https://example.com/abc`, `gcs://example/example.pdf`.
+          },
+        ],
+      },
+    },
+  ],
+}
+
+ +
+ 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, body=None, updateMask=None, x__xgafv=None) +
Updates a SampleQuery.
+
+Args:
+  name: string, Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Sample Query captures metadata to be used for evaluation.
+  "createTime": "A String", # Output only. Timestamp the SampleQuery was created at.
+  "name": "A String", # Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+  "queryEntry": { # Query Entry captures metadata to be used for search evaluation. # The query entry.
+    "query": "A String", # Required. The query.
+    "targets": [ # List of targets for the query.
+      { # Defines the parameters of the query's expected outcome.
+        "pageNumbers": [ # Expected page numbers of the target. Each page number must be non negative.
+          42,
+        ],
+        "score": 3.14, # Relevance score of the target.
+        "uri": "A String", # Expected uri of the target. This field must be a UTF-8 encoded string with a length limit of 2048 characters. Example of valid uris: `https://example.com/abc`, `gcs://example/example.pdf`.
+      },
+    ],
+  },
+}
+
+  updateMask: string, Indicates which fields in the provided imported 'simple query' to update. If not set, will by default update all fields.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Sample Query captures metadata to be used for evaluation.
+  "createTime": "A String", # Output only. Timestamp the SampleQuery was created at.
+  "name": "A String", # Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+  "queryEntry": { # Query Entry captures metadata to be used for search evaluation. # The query entry.
+    "query": "A String", # Required. The query.
+    "targets": [ # List of targets for the query.
+      { # Defines the parameters of the query's expected outcome.
+        "pageNumbers": [ # Expected page numbers of the target. Each page number must be non negative.
+          42,
+        ],
+        "score": 3.14, # Relevance score of the target.
+        "uri": "A String", # Expected uri of the target. This field must be a UTF-8 encoded string with a length limit of 2048 characters. Example of valid uris: `https://example.com/abc`, `gcs://example/example.pdf`.
+      },
+    ],
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/displayvideo_v3.advertisers.creatives.html b/docs/dyn/displayvideo_v3.advertisers.creatives.html index 65bfc0cf55c..088c918405f 100644 --- a/docs/dyn/displayvideo_v3.advertisers.creatives.html +++ b/docs/dyn/displayvideo_v3.advertisers.creatives.html @@ -209,7 +209,7 @@

Method Details

"status": "A String", # Status of the exchange review. }, ], - "publisherReviewStatuses": [ # Publisher review statuses for the creative. **Warning:** This field will be deprecated on June 26th, 2024. After this date, this field will be empty. Read our [feature deprecation announcement](/display-video/api/deprecations#features.creative_publisher_review_statuses) for more information. + "publisherReviewStatuses": [ # Publisher review statuses for the creative. { # Publisher review status for the creative. "publisherName": "A String", # The publisher reviewing the creative. "status": "A String", # Status of the publisher review. @@ -369,7 +369,7 @@

Method Details

"status": "A String", # Status of the exchange review. }, ], - "publisherReviewStatuses": [ # Publisher review statuses for the creative. **Warning:** This field will be deprecated on June 26th, 2024. After this date, this field will be empty. Read our [feature deprecation announcement](/display-video/api/deprecations#features.creative_publisher_review_statuses) for more information. + "publisherReviewStatuses": [ # Publisher review statuses for the creative. { # Publisher review status for the creative. "publisherName": "A String", # The publisher reviewing the creative. "status": "A String", # Status of the publisher review. @@ -556,7 +556,7 @@

Method Details

"status": "A String", # Status of the exchange review. }, ], - "publisherReviewStatuses": [ # Publisher review statuses for the creative. **Warning:** This field will be deprecated on June 26th, 2024. After this date, this field will be empty. Read our [feature deprecation announcement](/display-video/api/deprecations#features.creative_publisher_review_statuses) for more information. + "publisherReviewStatuses": [ # Publisher review statuses for the creative. { # Publisher review status for the creative. "publisherName": "A String", # The publisher reviewing the creative. "status": "A String", # Status of the publisher review. @@ -729,7 +729,7 @@

Method Details

"status": "A String", # Status of the exchange review. }, ], - "publisherReviewStatuses": [ # Publisher review statuses for the creative. **Warning:** This field will be deprecated on June 26th, 2024. After this date, this field will be empty. Read our [feature deprecation announcement](/display-video/api/deprecations#features.creative_publisher_review_statuses) for more information. + "publisherReviewStatuses": [ # Publisher review statuses for the creative. { # Publisher review status for the creative. "publisherName": "A String", # The publisher reviewing the creative. "status": "A String", # Status of the publisher review. @@ -909,7 +909,7 @@

Method Details

"status": "A String", # Status of the exchange review. }, ], - "publisherReviewStatuses": [ # Publisher review statuses for the creative. **Warning:** This field will be deprecated on June 26th, 2024. After this date, this field will be empty. Read our [feature deprecation announcement](/display-video/api/deprecations#features.creative_publisher_review_statuses) for more information. + "publisherReviewStatuses": [ # Publisher review statuses for the creative. { # Publisher review status for the creative. "publisherName": "A String", # The publisher reviewing the creative. "status": "A String", # Status of the publisher review. @@ -1070,7 +1070,7 @@

Method Details

"status": "A String", # Status of the exchange review. }, ], - "publisherReviewStatuses": [ # Publisher review statuses for the creative. **Warning:** This field will be deprecated on June 26th, 2024. After this date, this field will be empty. Read our [feature deprecation announcement](/display-video/api/deprecations#features.creative_publisher_review_statuses) for more information. + "publisherReviewStatuses": [ # Publisher review statuses for the creative. { # Publisher review status for the creative. "publisherName": "A String", # The publisher reviewing the creative. "status": "A String", # Status of the publisher review. diff --git a/docs/dyn/displayvideo_v3.sdfdownloadtasks.html b/docs/dyn/displayvideo_v3.sdfdownloadtasks.html index 9ac1d348338..508af4a4cc6 100644 --- a/docs/dyn/displayvideo_v3.sdfdownloadtasks.html +++ b/docs/dyn/displayvideo_v3.sdfdownloadtasks.html @@ -108,7 +108,7 @@

Method Details

"adGroupIds": [ # YouTube Ad Groups to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest. "A String", ], - "adGroupQaIds": [ # Optional. YouTube Ad Groups QA to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest. + "adGroupQaIds": [ # Optional. YouTube Ad Groups, by ID, to download in QA format. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest. "A String", ], "campaignIds": [ # Campaigns to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest. @@ -120,7 +120,7 @@

Method Details

"lineItemIds": [ # Line Items to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest. "A String", ], - "lineItemQaIds": [ # Optional. Line Items QA to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest. + "lineItemQaIds": [ # Optional. Line Items, by ID, to download in QA format. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest. "A String", ], "mediaProductIds": [ # Media Products to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest. diff --git a/docs/dyn/docs_v1.documents.html b/docs/dyn/docs_v1.documents.html index b80301248db..0526485b8a4 100644 --- a/docs/dyn/docs_v1.documents.html +++ b/docs/dyn/docs_v1.documents.html @@ -84,7 +84,7 @@

Instance Methods

create(body=None, x__xgafv=None)

Creates a blank document using the title given in the request. Other fields in the request, including any provided content, are ignored. Returns the created document.

- get(documentId, suggestionsViewMode=None, x__xgafv=None)

+ get(documentId, includeTabsContent=None, suggestionsViewMode=None, x__xgafv=None)

Gets the latest version of the specified document.

Method Details

@@ -103,22 +103,26 @@

Method Details

"sectionBreakLocation": { # A particular location in the document. # The location of the SectionBreak immediately preceding the section whose SectionStyle this footer should belong to. If this is unset or refers to the first section break in the document, the footer applies to the document style. "index": 42, # The zero-based index, in UTF-16 code units. The index is relative to the beginning of the segment specified by segment_id. "segmentId": "A String", # The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body. + "tabId": "A String", # The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. }, "type": "A String", # The type of footer to create. }, "createFootnote": { # Creates a Footnote segment and inserts a new FootnoteReference to it at the given location. The new Footnote segment will contain a space followed by a newline character. # Creates a footnote. "endOfSegmentLocation": { # Location at the end of a body, header, footer or footnote. The location is immediately before the last newline in the document segment. # Inserts the footnote reference at the end of the document body. Footnote references cannot be inserted inside a header, footer or footnote. Since footnote references can only be inserted in the body, the segment ID field must be empty. "segmentId": "A String", # The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body. + "tabId": "A String", # The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. }, "location": { # A particular location in the document. # Inserts the footnote reference at a specific index in the document. The footnote reference must be inserted inside the bounds of an existing Paragraph. For instance, it cannot be inserted at a table's start index (i.e. between the table and its preceding paragraph). Footnote references cannot be inserted inside an equation, header, footer or footnote. Since footnote references can only be inserted in the body, the segment ID field must be empty. "index": 42, # The zero-based index, in UTF-16 code units. The index is relative to the beginning of the segment specified by segment_id. "segmentId": "A String", # The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body. + "tabId": "A String", # The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. }, }, "createHeader": { # Creates a Header. The new header is applied to the SectionStyle at the location of the SectionBreak if specified, otherwise it is applied to the DocumentStyle. If a header of the specified type already exists, a 400 bad request error is returned. # Creates a header. "sectionBreakLocation": { # A particular location in the document. # The location of the SectionBreak which begins the section this header should belong to. If `section_break_location' is unset or if it refers to the first section break in the document body, the header applies to the DocumentStyle "index": 42, # The zero-based index, in UTF-16 code units. The index is relative to the beginning of the segment specified by segment_id. "segmentId": "A String", # The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body. + "tabId": "A String", # The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. }, "type": "A String", # The type of header to create. }, @@ -128,6 +132,7 @@

Method Details

"endIndex": 42, # The zero-based end index of this range, exclusive, in UTF-16 code units. In all current uses, an end index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges. "segmentId": "A String", # The ID of the header, footer, or footnote that this range is contained in. An empty segment ID signifies the document's body. "startIndex": 42, # The zero-based start index of this range, in UTF-16 code units. In all current uses, a start index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges. + "tabId": "A String", # The tab that contains this range. When omitted, the request applies to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. }, }, "createParagraphBullets": { # Creates bullets for all of the paragraphs that overlap with the given range. The nesting level of each paragraph will be determined by counting leading tabs in front of each paragraph. To avoid excess space between the bullet and the corresponding paragraph, these leading tabs are removed by this request. This may change the indices of parts of the text. If the paragraph immediately before paragraphs being updated is in a list with a matching preset, the paragraphs being updated are added to that preceding list. # Creates bullets for paragraphs. @@ -136,6 +141,7 @@

Method Details

"endIndex": 42, # The zero-based end index of this range, exclusive, in UTF-16 code units. In all current uses, an end index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges. "segmentId": "A String", # The ID of the header, footer, or footnote that this range is contained in. An empty segment ID signifies the document's body. "startIndex": 42, # The zero-based start index of this range, in UTF-16 code units. In all current uses, a start index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges. + "tabId": "A String", # The tab that contains this range. When omitted, the request applies to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. }, }, "deleteContentRange": { # Deletes content from the document. # Deletes content from the document. @@ -143,27 +149,37 @@

Method Details

"endIndex": 42, # The zero-based end index of this range, exclusive, in UTF-16 code units. In all current uses, an end index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges. "segmentId": "A String", # The ID of the header, footer, or footnote that this range is contained in. An empty segment ID signifies the document's body. "startIndex": 42, # The zero-based start index of this range, in UTF-16 code units. In all current uses, a start index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges. + "tabId": "A String", # The tab that contains this range. When omitted, the request applies to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. }, }, "deleteFooter": { # Deletes a Footer from the document. # Deletes a footer from the document. "footerId": "A String", # The id of the footer to delete. If this footer is defined on DocumentStyle, the reference to this footer is removed, resulting in no footer of that type for the first section of the document. If this footer is defined on a SectionStyle, the reference to this footer is removed and the footer of that type is now continued from the previous section. + "tabId": "A String", # The tab that contains the footer to delete. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. }, "deleteHeader": { # Deletes a Header from the document. # Deletes a header from the document. "headerId": "A String", # The id of the header to delete. If this header is defined on DocumentStyle, the reference to this header is removed, resulting in no header of that type for the first section of the document. If this header is defined on a SectionStyle, the reference to this header is removed and the header of that type is now continued from the previous section. + "tabId": "A String", # The tab containing the header to delete. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. }, "deleteNamedRange": { # Deletes a NamedRange. # Deletes a named range. "name": "A String", # The name of the range(s) to delete. All named ranges with the given name will be deleted. "namedRangeId": "A String", # The ID of the named range to delete. + "tabsCriteria": { # A criteria that specifies in which tabs a request executes. # Optional. The criteria used to specify which tab(s) the range deletion should occur in. When omitted, the range deletion is applied to all tabs. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the range deletion applies to the singular tab. In a document containing multiple tabs: - If provided, the range deletion applies to the specified tabs. - If not provided, the range deletion applies to all tabs. + "tabIds": [ # The list of tab IDs in which the request executes. + "A String", + ], + }, }, "deleteParagraphBullets": { # Deletes bullets from all of the paragraphs that overlap with the given range. The nesting level of each paragraph will be visually preserved by adding indent to the start of the corresponding paragraph. # Deletes bullets from paragraphs. "range": { # Specifies a contiguous range of text. # The range to delete bullets from. "endIndex": 42, # The zero-based end index of this range, exclusive, in UTF-16 code units. In all current uses, an end index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges. "segmentId": "A String", # The ID of the header, footer, or footnote that this range is contained in. An empty segment ID signifies the document's body. "startIndex": 42, # The zero-based start index of this range, in UTF-16 code units. In all current uses, a start index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges. + "tabId": "A String", # The tab that contains this range. When omitted, the request applies to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. }, }, "deletePositionedObject": { # Deletes a PositionedObject from the document. # Deletes a positioned object from the document. "objectId": "A String", # The ID of the positioned object to delete. + "tabId": "A String", # The tab that the positioned object to delete is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. }, "deleteTableColumn": { # Deletes a column from a table. # Deletes a column from a table. "tableCellLocation": { # Location of a single cell within a table. # The reference table cell location from which the column will be deleted. The column this cell spans will be deleted. If this is a merged cell that spans multiple columns, all columns that the cell spans will be deleted. If no columns remain in the table after this deletion, the whole table is deleted. @@ -172,6 +188,7 @@

Method Details

"tableStartLocation": { # A particular location in the document. # The location where the table starts in the document. "index": 42, # The zero-based index, in UTF-16 code units. The index is relative to the beginning of the segment specified by segment_id. "segmentId": "A String", # The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body. + "tabId": "A String", # The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. }, }, }, @@ -182,16 +199,19 @@

Method Details

"tableStartLocation": { # A particular location in the document. # The location where the table starts in the document. "index": 42, # The zero-based index, in UTF-16 code units. The index is relative to the beginning of the segment specified by segment_id. "segmentId": "A String", # The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body. + "tabId": "A String", # The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. }, }, }, "insertInlineImage": { # Inserts an InlineObject containing an image at the given location. # Inserts an inline image at the specified location. "endOfSegmentLocation": { # Location at the end of a body, header, footer or footnote. The location is immediately before the last newline in the document segment. # Inserts the text at the end of a header, footer or the document body. Inline images cannot be inserted inside a footnote. "segmentId": "A String", # The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body. + "tabId": "A String", # The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. }, "location": { # A particular location in the document. # Inserts the image at a specific index in the document. The image must be inserted inside the bounds of an existing Paragraph. For instance, it cannot be inserted at a table's start index (i.e. between the table and its preceding paragraph). Inline images cannot be inserted inside a footnote or equation. "index": 42, # The zero-based index, in UTF-16 code units. The index is relative to the beginning of the segment specified by segment_id. "segmentId": "A String", # The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body. + "tabId": "A String", # The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. }, "objectSize": { # A width and height. # The size that the image should appear as in the document. This property is optional and the final size of the image in the document is determined by the following rules: * If neither width nor height is specified, then a default size of the image is calculated based on its resolution. * If one dimension is specified then the other dimension is calculated to preserve the aspect ratio of the image. * If both width and height are specified, the image is scaled to fit within the provided dimensions while maintaining its aspect ratio. "height": { # A magnitude in a single direction in the specified units. # The height of the object. @@ -208,19 +228,23 @@

Method Details

"insertPageBreak": { # Inserts a page break followed by a newline at the specified location. # Inserts a page break at the specified location. "endOfSegmentLocation": { # Location at the end of a body, header, footer or footnote. The location is immediately before the last newline in the document segment. # Inserts the page break at the end of the document body. Page breaks cannot be inserted inside a footnote, header or footer. Since page breaks can only be inserted inside the body, the segment ID field must be empty. "segmentId": "A String", # The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body. + "tabId": "A String", # The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. }, "location": { # A particular location in the document. # Inserts the page break at a specific index in the document. The page break must be inserted inside the bounds of an existing Paragraph. For instance, it cannot be inserted at a table's start index (i.e. between the table and its preceding paragraph). Page breaks cannot be inserted inside a table, equation, footnote, header or footer. Since page breaks can only be inserted inside the body, the segment ID field must be empty. "index": 42, # The zero-based index, in UTF-16 code units. The index is relative to the beginning of the segment specified by segment_id. "segmentId": "A String", # The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body. + "tabId": "A String", # The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. }, }, "insertSectionBreak": { # Inserts a section break at the given location. A newline character will be inserted before the section break. # Inserts a section break at the specified location. "endOfSegmentLocation": { # Location at the end of a body, header, footer or footnote. The location is immediately before the last newline in the document segment. # Inserts a newline and a section break at the end of the document body. Section breaks cannot be inserted inside a footnote, header or footer. Because section breaks can only be inserted inside the body, the segment ID field must be empty. "segmentId": "A String", # The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body. + "tabId": "A String", # The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. }, "location": { # A particular location in the document. # Inserts a newline and a section break at a specific index in the document. The section break must be inserted inside the bounds of an existing Paragraph. For instance, it cannot be inserted at a table's start index (i.e. between the table and its preceding paragraph). Section breaks cannot be inserted inside a table, equation, footnote, header, or footer. Since section breaks can only be inserted inside the body, the segment ID field must be empty. "index": 42, # The zero-based index, in UTF-16 code units. The index is relative to the beginning of the segment specified by segment_id. "segmentId": "A String", # The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body. + "tabId": "A String", # The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. }, "sectionType": "A String", # The type of section to insert. }, @@ -228,10 +252,12 @@

Method Details

"columns": 42, # The number of columns in the table. "endOfSegmentLocation": { # Location at the end of a body, header, footer or footnote. The location is immediately before the last newline in the document segment. # Inserts the table at the end of the given header, footer or document body. A newline character will be inserted before the inserted table. Tables cannot be inserted inside a footnote. "segmentId": "A String", # The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body. + "tabId": "A String", # The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. }, "location": { # A particular location in the document. # Inserts the table at a specific model index. A newline character will be inserted before the inserted table, therefore the table start index will be at the specified location index + 1. The table must be inserted inside the bounds of an existing Paragraph. For instance, it cannot be inserted at a table's start index (i.e. between an existing table and its preceding paragraph). Tables cannot be inserted inside a footnote or equation. "index": 42, # The zero-based index, in UTF-16 code units. The index is relative to the beginning of the segment specified by segment_id. "segmentId": "A String", # The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body. + "tabId": "A String", # The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. }, "rows": 42, # The number of rows in the table. }, @@ -243,6 +269,7 @@

Method Details

"tableStartLocation": { # A particular location in the document. # The location where the table starts in the document. "index": 42, # The zero-based index, in UTF-16 code units. The index is relative to the beginning of the segment specified by segment_id. "segmentId": "A String", # The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body. + "tabId": "A String", # The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. }, }, }, @@ -254,16 +281,19 @@

Method Details

"tableStartLocation": { # A particular location in the document. # The location where the table starts in the document. "index": 42, # The zero-based index, in UTF-16 code units. The index is relative to the beginning of the segment specified by segment_id. "segmentId": "A String", # The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body. + "tabId": "A String", # The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. }, }, }, "insertText": { # Inserts text at the specified location. # Inserts text at the specified location. "endOfSegmentLocation": { # Location at the end of a body, header, footer or footnote. The location is immediately before the last newline in the document segment. # Inserts the text at the end of a header, footer, footnote or the document body. "segmentId": "A String", # The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body. + "tabId": "A String", # The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. }, "location": { # A particular location in the document. # Inserts the text at a specific index in the document. Text must be inserted inside the bounds of an existing Paragraph. For instance, text cannot be inserted at a table's start index (i.e. between the table and its preceding paragraph). The text must be inserted in the preceding paragraph. "index": 42, # The zero-based index, in UTF-16 code units. The index is relative to the beginning of the segment specified by segment_id. "segmentId": "A String", # The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body. + "tabId": "A String", # The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. }, "text": "A String", # The text to be inserted. Inserting a newline character will implicitly create a new Paragraph at that index. The paragraph style of the new paragraph will be copied from the paragraph at the current insertion index, including lists and bullets. Text styles for inserted text will be determined automatically, generally preserving the styling of neighboring text. In most cases, the text style for the inserted text will match the text immediately before the insertion index. Some control characters (U+0000-U+0008, U+000C-U+001F) and characters from the Unicode Basic Multilingual Plane Private Use Area (U+E000-U+F8FF) will be stripped out of the inserted text. }, @@ -277,6 +307,7 @@

Method Details

"tableStartLocation": { # A particular location in the document. # The location where the table starts in the document. "index": 42, # The zero-based index, in UTF-16 code units. The index is relative to the beginning of the segment specified by segment_id. "segmentId": "A String", # The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body. + "tabId": "A String", # The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. }, }, }, @@ -286,6 +317,7 @@

Method Details

"tableStartLocation": { # A particular location in the document. # The location where the table starts in the document. "index": 42, # The zero-based index, in UTF-16 code units. The index is relative to the beginning of the segment specified by segment_id. "segmentId": "A String", # The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body. + "tabId": "A String", # The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. }, }, "replaceAllText": { # Replaces all instances of text matching a criteria with replace text. # Replaces all instances of the specified text. @@ -294,15 +326,26 @@

Method Details

"text": "A String", # The text to search for in the document. }, "replaceText": "A String", # The text that will replace the matched text. + "tabsCriteria": { # A criteria that specifies in which tabs a request executes. # Optional. The criteria used to specify in which tabs the replacement occurs. When omitted, the replacement applies to all tabs. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the replacement applies to the singular tab. In a document containing multiple tabs: - If provided, the replacement applies to the specified tabs. - If omitted, the replacement applies to all tabs. + "tabIds": [ # The list of tab IDs in which the request executes. + "A String", + ], + }, }, "replaceImage": { # Replaces an existing image with a new image. Replacing an image removes some image effects from the existing image in order to mirror the behavior of the Docs editor. # Replaces an image in the document. "imageObjectId": "A String", # The ID of the existing image that will be replaced. The ID can be retrieved from the response of a get request. "imageReplaceMethod": "A String", # The replacement method. + "tabId": "A String", # The tab that the image to be replaced is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. "uri": "A String", # The URI of the new image. The image is fetched once at insertion time and a copy is stored for display inside the document. Images must be less than 50MB, cannot exceed 25 megapixels, and must be in PNG, JPEG, or GIF format. The provided URI can't surpass 2 KB in length. The URI is saved with the image, and exposed through the ImageProperties.source_uri field. }, "replaceNamedRangeContent": { # Replaces the contents of the specified NamedRange or NamedRanges with the given replacement content. Note that an individual NamedRange may consist of multiple discontinuous ranges. In this case, only the content in the first range will be replaced. The other ranges and their content will be deleted. In cases where replacing or deleting any ranges would result in an invalid document structure, a 400 bad request error is returned. # Replaces the content in a named range. "namedRangeId": "A String", # The ID of the named range whose content will be replaced. If there is no named range with the given ID a 400 bad request error is returned. "namedRangeName": "A String", # The name of the NamedRanges whose content will be replaced. If there are multiple named ranges with the given name, then the content of each one will be replaced. If there are no named ranges with the given name, then the request will be a no-op. + "tabsCriteria": { # A criteria that specifies in which tabs a request executes. # Optional. The criteria used to specify in which tabs the replacement occurs. When omitted, the replacement applies to all tabs. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the replacement applies to the singular tab. In a document containing multiple tabs: - If provided, the replacement applies to the specified tabs. - If omitted, the replacement applies to all tabs. + "tabIds": [ # The list of tab IDs in which the request executes. + "A String", + ], + }, "text": "A String", # Replaces the content of the specified named range(s) with the given text. }, "unmergeTableCells": { # Unmerges cells in a Table. # Unmerges cells in a table. @@ -315,6 +358,7 @@

Method Details

"tableStartLocation": { # A particular location in the document. # The location where the table starts in the document. "index": 42, # The zero-based index, in UTF-16 code units. The index is relative to the beginning of the segment specified by segment_id. "segmentId": "A String", # The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body. + "tabId": "A String", # The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. }, }, }, @@ -379,6 +423,7 @@

Method Details

"useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page. }, "fields": "A String", # The fields that should be updated. At least one field must be specified. The root `document_style` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. For example to update the background, set `fields` to `"background"`. + "tabId": "A String", # The tab that contains the style to update. When omitted, the request applies to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If not provided, the request applies to the first tab in the document. }, "updateParagraphStyle": { # Update the styling of all paragraphs that overlap with the given range. # Updates the paragraph style at the specified range. "fields": "A String", # The fields that should be updated. At least one field must be specified. The root `paragraph_style` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. For example, to update the paragraph style's alignment property, set `fields` to `"alignment"`. To reset a property to its default value, include its field name in the field mask but leave the field itself unset. @@ -538,6 +583,7 @@

Method Details

"endIndex": 42, # The zero-based end index of this range, exclusive, in UTF-16 code units. In all current uses, an end index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges. "segmentId": "A String", # The ID of the header, footer, or footnote that this range is contained in. An empty segment ID signifies the document's body. "startIndex": 42, # The zero-based start index of this range, in UTF-16 code units. In all current uses, a start index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges. + "tabId": "A String", # The tab that contains this range. When omitted, the request applies to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. }, }, "updateSectionStyle": { # Updates the SectionStyle. # Updates the section style of the specified range. @@ -546,6 +592,7 @@

Method Details

"endIndex": 42, # The zero-based end index of this range, exclusive, in UTF-16 code units. In all current uses, an end index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges. "segmentId": "A String", # The ID of the header, footer, or footnote that this range is contained in. An empty segment ID signifies the document's body. "startIndex": 42, # The zero-based start index of this range, in UTF-16 code units. In all current uses, a start index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges. + "tabId": "A String", # The tab that contains this range. When omitted, the request applies to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. }, "sectionStyle": { # The styling that applies to a section. # The styles to be set on the section. Certain section style changes may cause other changes in order to mirror the behavior of the Docs editor. See the documentation of SectionStyle for more information. "columnProperties": [ # The section's columns properties. If empty, the section contains one column with the default properties in the Docs editor. A section can be updated to have no more than 3 columns. When updating this property, setting a concrete value is required. Unsetting this property will result in a 400 bad request error. @@ -703,12 +750,14 @@

Method Details

"tableStartLocation": { # A particular location in the document. # The location where the table starts in the document. "index": 42, # The zero-based index, in UTF-16 code units. The index is relative to the beginning of the segment specified by segment_id. "segmentId": "A String", # The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body. + "tabId": "A String", # The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. }, }, }, "tableStartLocation": { # A particular location in the document. # The location where the table starts in the document. When specified, the updates are applied to all the cells in the table. "index": 42, # The zero-based index, in UTF-16 code units. The index is relative to the beginning of the segment specified by segment_id. "segmentId": "A String", # The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body. + "tabId": "A String", # The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. }, }, "updateTableColumnProperties": { # Updates the TableColumnProperties of columns in a table. # Updates the properties of columns in a table. @@ -726,6 +775,7 @@

Method Details

"tableStartLocation": { # A particular location in the document. # The location where the table starts in the document. "index": 42, # The zero-based index, in UTF-16 code units. The index is relative to the beginning of the segment specified by segment_id. "segmentId": "A String", # The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body. + "tabId": "A String", # The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. }, }, "updateTableRowStyle": { # Updates the TableRowStyle of rows in a table. # Updates the row style in a table. @@ -744,6 +794,7 @@

Method Details

"tableStartLocation": { # A particular location in the document. # The location where the table starts in the document. "index": 42, # The zero-based index, in UTF-16 code units. The index is relative to the beginning of the segment specified by segment_id. "segmentId": "A String", # The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body. + "tabId": "A String", # The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. }, }, "updateTextStyle": { # Update the styling of text. # Updates the text style at the specified range. @@ -752,6 +803,7 @@

Method Details

"endIndex": 42, # The zero-based end index of this range, exclusive, in UTF-16 code units. In all current uses, an end index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges. "segmentId": "A String", # The ID of the header, footer, or footnote that this range is contained in. An empty segment ID signifies the document's body. "startIndex": 42, # The zero-based start index of this range, in UTF-16 code units. In all current uses, a start index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges. + "tabId": "A String", # The tab that contains this range. When omitted, the request applies to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. }, "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The styles to set on the text. If the value for a particular style matches that of the parent, that style will be set to inherit. Certain text style changes may cause other changes in order to to mirror the behavior of the Docs editor. See the documentation of TextStyle for more information. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. @@ -780,8 +832,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -892,8 +953,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -943,8 +1013,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -997,8 +1076,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -1047,8 +1135,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -1101,8 +1198,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -1161,8 +1267,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -1215,8 +1330,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -1264,8 +1388,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -1318,8 +1451,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -1368,8 +1510,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -1422,8 +1573,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -1471,8 +1631,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -1525,8 +1694,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -1579,8 +1757,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -1633,8 +1820,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -1688,8 +1884,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -1742,8 +1947,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -1793,8 +2007,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -1847,8 +2070,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -2049,8 +2281,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -2715,8 +2956,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -2766,8 +3016,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -2820,8 +3079,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -2870,8 +3138,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -2924,8 +3201,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -2984,8 +3270,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -3038,8 +3333,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -3087,8 +3391,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -3141,8 +3454,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -3191,8 +3513,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -3245,8 +3576,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -3294,8 +3634,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -3348,8 +3697,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -3402,8 +3760,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -3456,8 +3823,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -3511,8 +3887,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -3565,8 +3950,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -3616,8 +4010,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -3670,8 +4073,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -3872,8 +4284,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -4481,8 +4902,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -4532,8 +4962,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -4586,8 +5025,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -4636,8 +5084,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -4690,8 +5147,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -4750,8 +5216,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -4804,8 +5279,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -4853,8 +5337,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -4907,8 +5400,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -4957,8 +5459,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -5011,8 +5522,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -5060,8 +5580,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -5114,8 +5643,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -5168,8 +5706,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -5222,8 +5769,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -5277,8 +5833,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -5331,8 +5896,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -5382,8 +5956,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -5436,8 +6019,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -5638,8 +6230,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -6247,8 +6848,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -6298,8 +6908,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -6352,8 +6971,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -6402,8 +7030,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -6456,8 +7093,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -6516,8 +7162,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -6570,8 +7225,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -6619,8 +7283,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -6673,8 +7346,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -6723,8 +7405,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -6777,8 +7468,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -6826,8 +7526,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -6880,8 +7589,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -6934,8 +7652,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -6988,8 +7715,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -7043,8 +7779,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -7097,8 +7842,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -7148,8 +7902,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -7202,8 +7965,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -7404,8 +8176,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -8222,8 +9003,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -8286,8 +9076,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -8343,6 +9142,7 @@

Method Details

"endIndex": 42, # The zero-based end index of this range, exclusive, in UTF-16 code units. In all current uses, an end index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges. "segmentId": "A String", # The ID of the header, footer, or footnote that this range is contained in. An empty segment ID signifies the document's body. "startIndex": 42, # The zero-based start index of this range, in UTF-16 code units. In all current uses, a start index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges. + "tabId": "A String", # The tab that contains this range. When omitted, the request applies to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. }, ], }, @@ -8532,8 +9332,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -9048,8 +9857,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -9111,1551 +9929,2147 @@

Method Details

}, }, "suggestionsViewMode": "A String", # Output only. The suggestions view mode applied to the document. Note: When editing a document, changes must be based on a document with SUGGESTIONS_INLINE. - "title": "A String", # The title of the document. -} - - x__xgafv: string, V1 error format. - Allowed values - 1 - v1 error format - 2 - v2 error format - -Returns: - An object of the form: - - { # A Google Docs document. - "body": { # The document body. The body typically contains the full document contents except for headers, footers, and footnotes. # Output only. The main body of the document. - "content": [ # The contents of the body. The indexes for the body's content begin at zero. - { # A StructuralElement describes content that provides structure to the document. - "endIndex": 42, # The zero-based end index of this structural element, exclusive, in UTF-16 code units. - "paragraph": { # A StructuralElement representing a paragraph. A paragraph is a range of content that's terminated with a newline character. # A paragraph type of structural element. - "bullet": { # Describes the bullet of a paragraph. # The bullet for this paragraph. If not present, the paragraph does not belong to a list. - "listId": "A String", # The ID of the list this paragraph belongs to. - "nestingLevel": 42, # The nesting level of this paragraph in the list. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "tabs": [ # Tabs that are part of a document. Tabs can contain child tabs, a tab nested within another tab. Child tabs are represented by the Tab.child_tabs field. + { # A tab in a document. + "childTabs": [ # The child tabs nested within this tab. + # Object with schema name: Tab + ], + "documentTab": { # A tab with document contents. # A tab with document contents, like text and images. + "body": { # The document body. The body typically contains the full document contents except for headers, footers, and footnotes. # The main body of the document tab. + "content": [ # The contents of the body. The indexes for the body's content begin at zero. + { # A StructuralElement describes content that provides structure to the document. + "endIndex": 42, # The zero-based end index of this structural element, exclusive, in UTF-16 code units. + "paragraph": { # A StructuralElement representing a paragraph. A paragraph is a range of content that's terminated with a newline character. # A paragraph type of structural element. + "bullet": { # Describes the bullet of a paragraph. # The bullet for this paragraph. If not present, the paragraph does not belong to a list. + "listId": "A String", # The ID of the list this paragraph belongs to. + "nestingLevel": 42, # The nesting level of this paragraph in the list. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, }, }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - "elements": [ # The content of the paragraph, broken down into its component parts. - { # A ParagraphElement describes content within a Paragraph. - "autoText": { # A ParagraphElement representing a spot in the text that's dynamically replaced with content that can change over time, like a page number. # An auto text paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. An AutoText may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this AutoText, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "elements": [ # The content of the paragraph, broken down into its component parts. + { # A ParagraphElement describes content within a Paragraph. + "autoText": { # A ParagraphElement representing a spot in the text that's dynamically replaced with content that can change over time, like a page number. # An auto text paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. An AutoText may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this AutoText, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this AutoText. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, - }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this AutoText. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + "type": "A String", # The type of this auto text. }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - "type": "A String", # The type of this auto text. - }, - "columnBreak": { # A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column. # A column break paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this ColumnBreak, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "columnBreak": { # A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column. # A column break paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this ColumnBreak, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, - }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, }, }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "endIndex": 42, # The zero-base end index of this paragraph element, exclusive, in UTF-16 code units. + "equation": { # A ParagraphElement representing an equation. # An equation paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. An Equation may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + }, + "footnoteReference": { # A ParagraphElement representing a footnote reference. A footnote reference is the inline content rendered with a number and is used to identify the footnote. # A footnote reference paragraph element. + "footnoteId": "A String", # The ID of the footnote that contains the content of this footnote reference. + "footnoteNumber": "A String", # The rendered number of this footnote. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this FootnoteReference, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this FootnoteReference. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, }, }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - "endIndex": 42, # The zero-base end index of this paragraph element, exclusive, in UTF-16 code units. - "equation": { # A ParagraphElement representing an equation. # An equation paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. An Equation may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - }, - "footnoteReference": { # A ParagraphElement representing a footnote reference. A footnote reference is the inline content rendered with a number and is used to identify the footnote. # A footnote reference paragraph element. - "footnoteId": "A String", # The ID of the footnote that contains the content of this footnote reference. - "footnoteNumber": "A String", # The rendered number of this footnote. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this FootnoteReference, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "horizontalRule": { # A ParagraphElement representing a horizontal line. # A horizontal rule paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A HorizontalRule may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this HorizontalRule, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this HorizontalRule. Similar to text content, like text runs and footnote references, the text style of a horizontal rule can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, }, }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, - }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this FootnoteReference. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - "horizontalRule": { # A ParagraphElement representing a horizontal line. # A horizontal rule paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A HorizontalRule may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this HorizontalRule, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "inlineObjectElement": { # A ParagraphElement that contains an InlineObject. # An inline object paragraph element. + "inlineObjectId": "A String", # The ID of the InlineObject this element contains. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. An InlineObjectElement may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this InlineObject, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this InlineObjectElement. Similar to text content, like text runs and footnote references, the text style of an inline object element can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, - }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this HorizontalRule. Similar to text content, like text runs and footnote references, the text style of a horizontal rule can affect content layout as well as the styling of text inserted next to it. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - "inlineObjectElement": { # A ParagraphElement that contains an InlineObject. # An inline object paragraph element. - "inlineObjectId": "A String", # The ID of the InlineObject this element contains. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. An InlineObjectElement may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this InlineObject, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. }, - }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this InlineObjectElement. Similar to text content, like text runs and footnote references, the text style of an inline object element can affect content layout as well as the styling of text inserted next to it. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - "pageBreak": { # A ParagraphElement representing a page break. A page break makes the subsequent text start at the top of the next page. # A page break paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A PageBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this PageBreak, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "pageBreak": { # A ParagraphElement representing a page break. A page break makes the subsequent text start at the top of the next page. # A page break paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A PageBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this PageBreak, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this PageBreak. Similar to text content, like text runs and footnote references, the text style of a page break can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, - }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this PageBreak. Similar to text content, like text runs and footnote references, the text style of a page break can affect content layout as well as the styling of text inserted next to it. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - "person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address. - "personId": "A String", # Output only. The unique ID of this link. - "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present. - "email": "A String", # Output only. The email address linked to this Person. This field is always present. - "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address. - }, - "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. - "A String", - ], - "suggestedInsertionIds": [ # IDs for suggestions that insert this person link into the document. A Person might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this Person, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + }, + "person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address. + "personId": "A String", # Output only. The unique ID of this link. + "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present. + "email": "A String", # Output only. The email address linked to this Person. This field is always present. + "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address. }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. + "A String", + ], + "suggestedInsertionIds": [ # IDs for suggestions that insert this person link into the document. A Person might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this Person, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this Person. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + "richLink": { # A link to a Google resource (such as a file in Drive, a YouTube video, or a Calendar event). # A paragraph element that links to a Google resource (such as a file in Google Drive, a YouTube video, or a Calendar event.) + "richLinkId": "A String", # Output only. The ID of this link. + "richLinkProperties": { # Properties specific to a RichLink. # Output only. The properties of this RichLink. This field is always present. + "mimeType": "A String", # Output only. The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the RichLink, if there's one (for example, when it's a file in Drive). + "title": "A String", # Output only. The title of the RichLink as displayed in the link. This title matches the title of the linked resource at the time of the insertion or last update of the link. This field is always present. + "uri": "A String", # Output only. The URI to the RichLink. This is always present. + }, + "suggestedDeletionIds": [ # IDs for suggestions that remove this link from the document. A RichLink might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. + "A String", + ], + "suggestedInsertionIds": [ # IDs for suggestions that insert this link into the document. A RichLink might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this RichLink, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this RichLink. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, }, }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + "startIndex": 42, # The zero-based start index of this paragraph element, in UTF-16 code units. + "textRun": { # A ParagraphElement that represents a run of text that all has the same styling. # A text run paragraph element. + "content": "A String", # The text of this run. Any non-text elements in the run are replaced with the Unicode character U+E907. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TextRun may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this run, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this run. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, }, }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this Person. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + ], + "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The style of this paragraph. + "alignment": "A String", # The text alignment for this paragraph. + "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. + "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. + "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - "richLink": { # A link to a Google resource (such as a file in Drive, a YouTube video, or a Calendar event). # A paragraph element that links to a Google resource (such as a file in Google Drive, a YouTube video, or a Calendar event.) - "richLinkId": "A String", # Output only. The ID of this link. - "richLinkProperties": { # Properties specific to a RichLink. # Output only. The properties of this RichLink. This field is always present. - "mimeType": "A String", # Output only. The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the RichLink, if there's one (for example, when it's a file in Drive). - "title": "A String", # Output only. The title of the RichLink as displayed in the link. This title matches the title of the linked resource at the time of the insertion or last update of the link. This field is always present. - "uri": "A String", # Output only. The URI to the RichLink. This is always present. - }, - "suggestedDeletionIds": [ # IDs for suggestions that remove this link from the document. A RichLink might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. - "A String", - ], - "suggestedInsertionIds": [ # IDs for suggestions that insert this link into the document. A RichLink might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this RichLink, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this RichLink. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. + "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. + "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. + "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. + "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. + "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. + "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. + "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. + "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, + "spacingMode": "A String", # The spacing mode for the paragraph. + "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. + { # A tab stop within a paragraph. + "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. + "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + ], }, - }, - "startIndex": 42, # The zero-based start index of this paragraph element, in UTF-16 code units. - "textRun": { # A ParagraphElement that represents a run of text that all has the same styling. # A text run paragraph element. - "content": "A String", # The text of this run. Any non-text elements in the run are replaced with the Unicode character U+E907. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A TextRun may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "positionedObjectIds": [ # The IDs of the positioned objects tethered to this paragraph. "A String", ], - "suggestedTextStyleChanges": { # The suggested text style changes to this run, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "suggestedBulletChanges": { # The suggested changes to this paragraph's bullet. + "a_key": { # A suggested change to a Bullet. + "bullet": { # Describes the bullet of a paragraph. # A Bullet that only includes the changes made in this suggestion. This can be used along with the bullet_suggestion_state to see which fields have changed and their new values. + "listId": "A String", # The ID of the list this paragraph belongs to. + "nestingLevel": 42, # The nesting level of this paragraph in the list. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, }, }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + "bulletSuggestionState": { # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. + "listIdSuggested": True or False, # Indicates if there was a suggested change to the list_id. + "nestingLevelSuggested": True or False, # Indicates if there was a suggested change to the nesting_level. + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, }, }, }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this run. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "suggestedParagraphStyleChanges": { # The suggested paragraph style changes to this paragraph, keyed by suggestion ID. + "a_key": { # A suggested change to a ParagraphStyle. + "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A ParagraphStyle that only includes the changes made in this suggestion. This can be used along with the paragraph_style_suggestion_state to see which fields have changed and their new values. + "alignment": "A String", # The text alignment for this paragraph. + "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. + "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. + "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. + "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. + "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. + "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. + "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. + "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. + "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + }, + "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spacingMode": "A String", # The spacing mode for the paragraph. + "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. + { # A tab stop within a paragraph. + "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. + "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + ], + }, + "paragraphStyleSuggestionState": { # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. + "alignmentSuggested": True or False, # Indicates if there was a suggested change to alignment. + "avoidWidowAndOrphanSuggested": True or False, # Indicates if there was a suggested change to avoid_widow_and_orphan. + "borderBetweenSuggested": True or False, # Indicates if there was a suggested change to border_between. + "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. + "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. + "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. + "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. + "directionSuggested": True or False, # Indicates if there was a suggested change to direction. + "headingIdSuggested": True or False, # Indicates if there was a suggested change to heading_id. + "indentEndSuggested": True or False, # Indicates if there was a suggested change to indent_end. + "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line. + "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start. + "keepLinesTogetherSuggested": True or False, # Indicates if there was a suggested change to keep_lines_together. + "keepWithNextSuggested": True or False, # Indicates if there was a suggested change to keep_with_next. + "lineSpacingSuggested": True or False, # Indicates if there was a suggested change to line_spacing. + "namedStyleTypeSuggested": True or False, # Indicates if there was a suggested change to named_style_type. + "pageBreakBeforeSuggested": True or False, # Indicates if there was a suggested change to page_break_before. + "shadingSuggestionState": { # A mask that indicates which of the fields on the base Shading have been changed in this suggested change. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in shading have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to the Shading. + }, + "spaceAboveSuggested": True or False, # Indicates if there was a suggested change to space_above. + "spaceBelowSuggested": True or False, # Indicates if there was a suggested change to space_below. + "spacingModeSuggested": True or False, # Indicates if there was a suggested change to spacing_mode. + }, + }, + }, + "suggestedPositionedObjectIds": { # The IDs of the positioned objects suggested to be attached to this paragraph, keyed by suggestion ID. + "a_key": { # A collection of object IDs. + "objectIds": [ # The object IDs. + "A String", + ], }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + "sectionBreak": { # A StructuralElement representing a section break. A section is a range of content that has the same SectionStyle. A section break represents the start of a new section, and the section style applies to the section after the section break. The document body always begins with a section break. # A section break type of structural element. + "sectionStyle": { # The styling that applies to a section. # The style of the section after this section break. + "columnProperties": [ # The section's columns properties. If empty, the section contains one column with the default properties in the Docs editor. A section can be updated to have no more than 3 columns. When updating this property, setting a concrete value is required. Unsetting this property will result in a 400 bad request error. + { # Properties that apply to a section's column. + "paddingEnd": { # A magnitude in a single direction in the specified units. # The padding at the end of the column. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # Output only. The width of the column. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, }, + ], + "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only. + "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only. + "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only. + "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only. + "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only. + "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only. + "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. + "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - }, - }, - }, - ], - "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The style of this paragraph. - "alignment": "A String", # The text alignment for this paragraph. - "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. - "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, + "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "sectionType": "A String", # Output only. The type of section. + "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. }, + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A SectionBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "startIndex": 42, # The zero-based start index of this structural element, in UTF-16 code units. + "table": { # A StructuralElement representing a table. # A table type of structural element. + "columns": 42, # Number of columns in the table. It's possible for a table to be non-rectangular, so some rows may have a different number of cells. + "rows": 42, # Number of rows in the table. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A Table may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "tableRows": [ # The contents and style of each row. + { # The contents and style of a row in a Table. + "endIndex": 42, # The zero-based end index of this row, exclusive, in UTF-16 code units. + "startIndex": 42, # The zero-based start index of this row, in UTF-16 code units. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TableRow may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTableRowStyleChanges": { # The suggested style changes to this row, keyed by suggestion ID. + "a_key": { # A suggested change to a TableRowStyle. + "tableRowStyle": { # Styles that apply to a table row. # A TableRowStyle that only includes the changes made in this suggestion. This can be used along with the table_row_style_suggestion_state to see which fields have changed and their new values. + "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries. + "tableHeader": True or False, # Whether the row is a table header. + }, + "tableRowStyleSuggestionState": { # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. + "minRowHeightSuggested": True or False, # Indicates if there was a suggested change to min_row_height. + }, + }, + }, + "tableCells": [ # The contents and style of each cell in this row. It's possible for a table to be non-rectangular, so some rows may have a different number of cells than other rows in the same table. + { # The contents and style of a cell in a Table. + "content": [ # The content of the cell. + # Object with schema name: StructuralElement + ], + "endIndex": 42, # The zero-based end index of this cell, exclusive, in UTF-16 code units. + "startIndex": 42, # The zero-based start index of this cell, in UTF-16 code units. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TableCell may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTableCellStyleChanges": { # The suggested changes to the table cell style, keyed by suggestion ID. + "a_key": { # A suggested change to a TableCellStyle. + "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # A TableCellStyle that only includes the changes made in this suggestion. This can be used along with the table_cell_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "columnSpan": 42, # The column span of the cell. This property is read-only. + "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. + "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "rowSpan": 42, # The row span of the cell. This property is read-only. + }, + "tableCellStyleSuggestionState": { # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. + "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. + "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. + "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. + "columnSpanSuggested": True or False, # Indicates if there was a suggested change to column_span. + "contentAlignmentSuggested": True or False, # Indicates if there was a suggested change to content_alignment. + "paddingBottomSuggested": True or False, # Indicates if there was a suggested change to padding_bottom. + "paddingLeftSuggested": True or False, # Indicates if there was a suggested change to padding_left. + "paddingRightSuggested": True or False, # Indicates if there was a suggested change to padding_right. + "paddingTopSuggested": True or False, # Indicates if there was a suggested change to padding_top. + "rowSpanSuggested": True or False, # Indicates if there was a suggested change to row_span. + }, + }, + }, + "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # The style of the cell. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "columnSpan": 42, # The column span of the cell. This property is read-only. + "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. + "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "rowSpan": 42, # The row span of the cell. This property is read-only. + }, + }, + ], + "tableRowStyle": { # Styles that apply to a table row. # The style of the table row. + "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries. + "tableHeader": True or False, # Whether the row is a table header. + }, }, + ], + "tableStyle": { # Styles that apply to a table. # The style of the table. + "tableColumnProperties": [ # The properties of each column. Note that in Docs, tables contain rows and rows contain cells, similar to HTML. So the properties for a row can be found on the row's table_row_style. + { # The properties of a column in a table. + "width": { # A magnitude in a single direction in the specified units. # The width of the column. Set when the column's `width_type` is FIXED_WIDTH. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "widthType": "A String", # The width type of the column. + }, + ], }, }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "tableOfContents": { # A StructuralElement representing a table of contents. # A table of contents type of structural element. + "content": [ # The content of the table of contents. + # Object with schema name: StructuralElement + ], + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TableOfContents may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], }, }, - "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. - "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. - "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. - "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. - "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. - "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. - "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. - "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + ], + }, + "documentStyle": { # The style of the document. # The style of the document tab. + "background": { # Represents the background of a document. # The background of the document. Documents cannot have a transparent background color. + "color": { # A color that can either be fully opaque or fully transparent. # The background color. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, }, - "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. + }, + "defaultFooterId": "A String", # The ID of the default footer. If not set, there's no default footer. This property is read-only. + "defaultHeaderId": "A String", # The ID of the default header. If not set, there's no default header. This property is read-only. + "evenPageFooterId": "A String", # The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. This property is read-only. + "evenPageHeaderId": "A String", # The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. This property is read-only. + "firstPageFooterId": "A String", # The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. This property is read-only. + "firstPageHeaderId": "A String", # The ID of the header used only for the first page. If not set then a unique header for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_header_id or this value for the header on the first page. If not set, there's no first page header. This property is read-only. + "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of the page_size, which allows changing the page orientation between portrait and landscape. + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin. Updating the bottom page margin on the document style clears the bottom page margin on all section styles. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginFooter": { # A magnitude in a single direction in the specified units. # The amount of space between the bottom of the page and the contents of the footer. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginHeader": { # A magnitude in a single direction in the specified units. # The amount of space between the top of the page and the contents of the header. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin. Updating the left page margin on the document style clears the left page margin on all section styles. It may also cause columns to resize in all sections. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin. Updating the right page margin on the document style clears the right page margin on all section styles. It may also cause columns to resize in all sections. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin. Updating the top page margin on the document style clears the top page margin on all section styles. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "pageNumberStart": 42, # The page number from which to start counting the number of pages. + "pageSize": { # A width and height. # The size of a page in the document. + "height": { # A magnitude in a single direction in the specified units. # The height of the object. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. + "width": { # A magnitude in a single direction in the specified units. # The width of the object. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "spacingMode": "A String", # The spacing mode for the paragraph. - "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. - { # A tab stop within a paragraph. - "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. - "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - ], - }, - "positionedObjectIds": [ # The IDs of the positioned objects tethered to this paragraph. - "A String", - ], - "suggestedBulletChanges": { # The suggested changes to this paragraph's bullet. - "a_key": { # A suggested change to a Bullet. - "bullet": { # Describes the bullet of a paragraph. # A Bullet that only includes the changes made in this suggestion. This can be used along with the bullet_suggestion_state to see which fields have changed and their new values. - "listId": "A String", # The ID of the list this paragraph belongs to. - "nestingLevel": 42, # The nesting level of this paragraph in the list. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - "bulletSuggestionState": { # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. - "listIdSuggested": True or False, # Indicates if there was a suggested change to the list_id. - "nestingLevelSuggested": True or False, # Indicates if there was a suggested change to the nesting_level. - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, - }, - }, }, - "suggestedParagraphStyleChanges": { # The suggested paragraph style changes to this paragraph, keyed by suggestion ID. - "a_key": { # A suggested change to a ParagraphStyle. - "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A ParagraphStyle that only includes the changes made in this suggestion. This can be used along with the paragraph_style_suggestion_state to see which fields have changed and their new values. - "alignment": "A String", # The text alignment for this paragraph. - "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. - "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "useCustomHeaderFooterMargins": True or False, # Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected. When false, the default values in the Docs editor for header and footer margin are used. This property is read-only. + "useEvenPageHeaderFooter": True or False, # Indicates whether to use the even page header / footer IDs for the even pages. + "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page. + }, + "footers": { # The footers in the document tab, keyed by footer ID. + "a_key": { # A document footer. + "content": [ # The contents of the footer. The indexes for a footer's content begin at zero. + { # A StructuralElement describes content that provides structure to the document. + "endIndex": 42, # The zero-based end index of this structural element, exclusive, in UTF-16 code units. + "paragraph": { # A StructuralElement representing a paragraph. A paragraph is a range of content that's terminated with a newline character. # A paragraph type of structural element. + "bullet": { # Describes the bullet of a paragraph. # The bullet for this paragraph. If not present, the paragraph does not belong to a list. + "listId": "A String", # The ID of the list this paragraph belongs to. + "nestingLevel": 42, # The nesting level of this paragraph in the list. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. - "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. - "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. - "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. - "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. - "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. - "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. - "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, }, - }, - "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "spacingMode": "A String", # The spacing mode for the paragraph. - "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. - { # A tab stop within a paragraph. - "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. - "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - ], - }, - "paragraphStyleSuggestionState": { # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. - "alignmentSuggested": True or False, # Indicates if there was a suggested change to alignment. - "avoidWidowAndOrphanSuggested": True or False, # Indicates if there was a suggested change to avoid_widow_and_orphan. - "borderBetweenSuggested": True or False, # Indicates if there was a suggested change to border_between. - "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. - "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. - "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. - "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. - "directionSuggested": True or False, # Indicates if there was a suggested change to direction. - "headingIdSuggested": True or False, # Indicates if there was a suggested change to heading_id. - "indentEndSuggested": True or False, # Indicates if there was a suggested change to indent_end. - "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line. - "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start. - "keepLinesTogetherSuggested": True or False, # Indicates if there was a suggested change to keep_lines_together. - "keepWithNextSuggested": True or False, # Indicates if there was a suggested change to keep_with_next. - "lineSpacingSuggested": True or False, # Indicates if there was a suggested change to line_spacing. - "namedStyleTypeSuggested": True or False, # Indicates if there was a suggested change to named_style_type. - "pageBreakBeforeSuggested": True or False, # Indicates if there was a suggested change to page_break_before. - "shadingSuggestionState": { # A mask that indicates which of the fields on the base Shading have been changed in this suggested change. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in shading have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to the Shading. - }, - "spaceAboveSuggested": True or False, # Indicates if there was a suggested change to space_above. - "spaceBelowSuggested": True or False, # Indicates if there was a suggested change to space_below. - "spacingModeSuggested": True or False, # Indicates if there was a suggested change to spacing_mode. - }, - }, - }, - "suggestedPositionedObjectIds": { # The IDs of the positioned objects suggested to be attached to this paragraph, keyed by suggestion ID. - "a_key": { # A collection of object IDs. - "objectIds": [ # The object IDs. - "A String", - ], - }, - }, - }, - "sectionBreak": { # A StructuralElement representing a section break. A section is a range of content that has the same SectionStyle. A section break represents the start of a new section, and the section style applies to the section after the section break. The document body always begins with a section break. # A section break type of structural element. - "sectionStyle": { # The styling that applies to a section. # The style of the section after this section break. - "columnProperties": [ # The section's columns properties. If empty, the section contains one column with the default properties in the Docs editor. A section can be updated to have no more than 3 columns. When updating this property, setting a concrete value is required. Unsetting this property will result in a 400 bad request error. - { # Properties that apply to a section's column. - "paddingEnd": { # A magnitude in a single direction in the specified units. # The padding at the end of the column. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # Output only. The width of the column. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - ], - "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only. - "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only. - "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only. - "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only. - "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only. - "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only. - "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "sectionType": "A String", # Output only. The type of section. - "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - }, - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A SectionBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - }, - "startIndex": 42, # The zero-based start index of this structural element, in UTF-16 code units. - "table": { # A StructuralElement representing a table. # A table type of structural element. - "columns": 42, # Number of columns in the table. It's possible for a table to be non-rectangular, so some rows may have a different number of cells. - "rows": 42, # Number of rows in the table. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A Table may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "tableRows": [ # The contents and style of each row. - { # The contents and style of a row in a Table. - "endIndex": 42, # The zero-based end index of this row, exclusive, in UTF-16 code units. - "startIndex": 42, # The zero-based start index of this row, in UTF-16 code units. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A TableRow may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTableRowStyleChanges": { # The suggested style changes to this row, keyed by suggestion ID. - "a_key": { # A suggested change to a TableRowStyle. - "tableRowStyle": { # Styles that apply to a table row. # A TableRowStyle that only includes the changes made in this suggestion. This can be used along with the table_row_style_suggestion_state to see which fields have changed and their new values. - "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries. - "tableHeader": True or False, # Whether the row is a table header. - }, - "tableRowStyleSuggestionState": { # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. - "minRowHeightSuggested": True or False, # Indicates if there was a suggested change to min_row_height. - }, - }, - }, - "tableCells": [ # The contents and style of each cell in this row. It's possible for a table to be non-rectangular, so some rows may have a different number of cells than other rows in the same table. - { # The contents and style of a cell in a Table. - "content": [ # The content of the cell. - # Object with schema name: StructuralElement - ], - "endIndex": 42, # The zero-based end index of this cell, exclusive, in UTF-16 code units. - "startIndex": 42, # The zero-based start index of this cell, in UTF-16 code units. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A TableCell may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTableCellStyleChanges": { # The suggested changes to the table cell style, keyed by suggestion ID. - "a_key": { # A suggested change to a TableCellStyle. - "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # A TableCellStyle that only includes the changes made in this suggestion. This can be used along with the table_cell_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "elements": [ # The content of the paragraph, broken down into its component parts. + { # A ParagraphElement describes content within a Paragraph. + "autoText": { # A ParagraphElement representing a spot in the text that's dynamically replaced with content that can change over time, like a page number. # An auto text paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. An AutoText may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this AutoText, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. }, }, }, - "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this AutoText. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -10664,14 +12078,120 @@

Method Details

}, }, }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "type": "A String", # The type of this auto text. + }, + "columnBreak": { # A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column. # A column break paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this ColumnBreak, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, }, - "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -10680,14 +12200,130 @@

Method Details

}, }, }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "endIndex": 42, # The zero-base end index of this paragraph element, exclusive, in UTF-16 code units. + "equation": { # A ParagraphElement representing an equation. # An equation paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. An Equation may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + }, + "footnoteReference": { # A ParagraphElement representing a footnote reference. A footnote reference is the inline content rendered with a number and is used to identify the footnote. # A footnote reference paragraph element. + "footnoteId": "A String", # The ID of the footnote that contains the content of this footnote reference. + "footnoteNumber": "A String", # The rendered number of this footnote. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this FootnoteReference, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, }, - "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this FootnoteReference. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -10696,14 +12332,119 @@

Method Details

}, }, }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "horizontalRule": { # A ParagraphElement representing a horizontal line. # A horizontal rule paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A HorizontalRule may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this HorizontalRule, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, }, - "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this HorizontalRule. Similar to text content, like text runs and footnote references, the text style of a horizontal rule can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -10712,60 +12453,691 @@

Method Details

}, }, }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "inlineObjectElement": { # A ParagraphElement that contains an InlineObject. # An inline object paragraph element. + "inlineObjectId": "A String", # The ID of the InlineObject this element contains. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. An InlineObjectElement may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this InlineObject, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, }, - "columnSpan": 42, # The column span of the cell. This property is read-only. - "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. - "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this InlineObjectElement. Similar to text content, like text runs and footnote references, the text style of an inline object element can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "pageBreak": { # A ParagraphElement representing a page break. A page break makes the subsequent text start at the top of the next page. # A page break paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A PageBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this PageBreak, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, }, - "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this PageBreak. Similar to text content, like text runs and footnote references, the text style of a page break can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address. + "personId": "A String", # Output only. The unique ID of this link. + "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present. + "email": "A String", # Output only. The email address linked to this Person. This field is always present. + "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address. + }, + "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. + "A String", + ], + "suggestedInsertionIds": [ # IDs for suggestions that insert this person link into the document. A Person might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this Person, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, }, - "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this Person. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "richLink": { # A link to a Google resource (such as a file in Drive, a YouTube video, or a Calendar event). # A paragraph element that links to a Google resource (such as a file in Google Drive, a YouTube video, or a Calendar event.) + "richLinkId": "A String", # Output only. The ID of this link. + "richLinkProperties": { # Properties specific to a RichLink. # Output only. The properties of this RichLink. This field is always present. + "mimeType": "A String", # Output only. The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the RichLink, if there's one (for example, when it's a file in Drive). + "title": "A String", # Output only. The title of the RichLink as displayed in the link. This title matches the title of the linked resource at the time of the insertion or last update of the link. This field is always present. + "uri": "A String", # Output only. The URI to the RichLink. This is always present. + }, + "suggestedDeletionIds": [ # IDs for suggestions that remove this link from the document. A RichLink might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. + "A String", + ], + "suggestedInsertionIds": [ # IDs for suggestions that insert this link into the document. A RichLink might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this RichLink, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, }, - "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this RichLink. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "startIndex": 42, # The zero-based start index of this paragraph element, in UTF-16 code units. + "textRun": { # A ParagraphElement that represents a run of text that all has the same styling. # A text run paragraph element. + "content": "A String", # The text of this run. Any non-text elements in the run are replaced with the Unicode character U+E907. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TextRun may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this run, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this run. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, }, - "rowSpan": 42, # The row span of the cell. This property is read-only. - }, - "tableCellStyleSuggestionState": { # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. - "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. - "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. - "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. - "columnSpanSuggested": True or False, # Indicates if there was a suggested change to column_span. - "contentAlignmentSuggested": True or False, # Indicates if there was a suggested change to content_alignment. - "paddingBottomSuggested": True or False, # Indicates if there was a suggested change to padding_bottom. - "paddingLeftSuggested": True or False, # Indicates if there was a suggested change to padding_left. - "paddingRightSuggested": True or False, # Indicates if there was a suggested change to padding_right. - "paddingTopSuggested": True or False, # Indicates if there was a suggested change to padding_top. - "rowSpanSuggested": True or False, # Indicates if there was a suggested change to row_span. }, }, - }, - "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # The style of the cell. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + ], + "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The style of this paragraph. + "alignment": "A String", # The text alignment for this paragraph. + "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. + "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -10775,13 +13147,17 @@

Method Details

}, }, "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, "width": { # A magnitude in a single direction in the specified units. # The width of the border. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, }, - "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -10791,13 +13167,17 @@

Method Details

}, }, "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, "width": { # A magnitude in a single direction in the specified units. # The width of the border. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, }, - "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -10807,13 +13187,17 @@

Method Details

}, }, "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, "width": { # A magnitude in a single direction in the specified units. # The width of the border. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, }, - "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -10823,1662 +13207,2495 @@

Method Details

}, }, "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, "width": { # A magnitude in a single direction in the specified units. # The width of the border. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, }, - "columnSpan": 42, # The column span of the cell. This property is read-only. - "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. - "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell. + "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. + "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. + "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell. + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell. + "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell. + "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. + "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. + "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. + "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. + "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. + "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + }, + "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "rowSpan": 42, # The row span of the cell. This property is read-only. + "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spacingMode": "A String", # The spacing mode for the paragraph. + "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. + { # A tab stop within a paragraph. + "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. + "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + ], }, - }, - ], - "tableRowStyle": { # Styles that apply to a table row. # The style of the table row. - "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries. - "tableHeader": True or False, # Whether the row is a table header. - }, - }, - ], - "tableStyle": { # Styles that apply to a table. # The style of the table. - "tableColumnProperties": [ # The properties of each column. Note that in Docs, tables contain rows and rows contain cells, similar to HTML. So the properties for a row can be found on the row's table_row_style. - { # The properties of a column in a table. - "width": { # A magnitude in a single direction in the specified units. # The width of the column. Set when the column's `width_type` is FIXED_WIDTH. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "widthType": "A String", # The width type of the column. - }, - ], - }, - }, - "tableOfContents": { # A StructuralElement representing a table of contents. # A table of contents type of structural element. - "content": [ # The content of the table of contents. - # Object with schema name: StructuralElement - ], - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A TableOfContents may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - }, - }, - ], - }, - "documentId": "A String", # Output only. The ID of the document. - "documentStyle": { # The style of the document. # Output only. The style of the document. - "background": { # Represents the background of a document. # The background of the document. Documents cannot have a transparent background color. - "color": { # A color that can either be fully opaque or fully transparent. # The background color. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - }, - "defaultFooterId": "A String", # The ID of the default footer. If not set, there's no default footer. This property is read-only. - "defaultHeaderId": "A String", # The ID of the default header. If not set, there's no default header. This property is read-only. - "evenPageFooterId": "A String", # The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. This property is read-only. - "evenPageHeaderId": "A String", # The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. This property is read-only. - "firstPageFooterId": "A String", # The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. This property is read-only. - "firstPageHeaderId": "A String", # The ID of the header used only for the first page. If not set then a unique header for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_header_id or this value for the header on the first page. If not set, there's no first page header. This property is read-only. - "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of the page_size, which allows changing the page orientation between portrait and landscape. - "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin. Updating the bottom page margin on the document style clears the bottom page margin on all section styles. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginFooter": { # A magnitude in a single direction in the specified units. # The amount of space between the bottom of the page and the contents of the footer. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginHeader": { # A magnitude in a single direction in the specified units. # The amount of space between the top of the page and the contents of the header. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin. Updating the left page margin on the document style clears the left page margin on all section styles. It may also cause columns to resize in all sections. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin. Updating the right page margin on the document style clears the right page margin on all section styles. It may also cause columns to resize in all sections. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin. Updating the top page margin on the document style clears the top page margin on all section styles. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "pageNumberStart": 42, # The page number from which to start counting the number of pages. - "pageSize": { # A width and height. # The size of a page in the document. - "height": { # A magnitude in a single direction in the specified units. # The height of the object. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the object. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "useCustomHeaderFooterMargins": True or False, # Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected. When false, the default values in the Docs editor for header and footer margin are used. This property is read-only. - "useEvenPageHeaderFooter": True or False, # Indicates whether to use the even page header / footer IDs for the even pages. - "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page. - }, - "footers": { # Output only. The footers in the document, keyed by footer ID. - "a_key": { # A document footer. - "content": [ # The contents of the footer. The indexes for a footer's content begin at zero. - { # A StructuralElement describes content that provides structure to the document. - "endIndex": 42, # The zero-based end index of this structural element, exclusive, in UTF-16 code units. - "paragraph": { # A StructuralElement representing a paragraph. A paragraph is a range of content that's terminated with a newline character. # A paragraph type of structural element. - "bullet": { # Describes the bullet of a paragraph. # The bullet for this paragraph. If not present, the paragraph does not belong to a list. - "listId": "A String", # The ID of the list this paragraph belongs to. - "nestingLevel": 42, # The nesting level of this paragraph in the list. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - "elements": [ # The content of the paragraph, broken down into its component parts. - { # A ParagraphElement describes content within a Paragraph. - "autoText": { # A ParagraphElement representing a spot in the text that's dynamically replaced with content that can change over time, like a page number. # An auto text paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. An AutoText may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "positionedObjectIds": [ # The IDs of the positioned objects tethered to this paragraph. "A String", ], - "suggestedTextStyleChanges": { # The suggested text style changes to this AutoText, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "suggestedBulletChanges": { # The suggested changes to this paragraph's bullet. + "a_key": { # A suggested change to a Bullet. + "bullet": { # Describes the bullet of a paragraph. # A Bullet that only includes the changes made in this suggestion. This can be used along with the bullet_suggestion_state to see which fields have changed and their new values. + "listId": "A String", # The ID of the list this paragraph belongs to. + "nestingLevel": 42, # The nesting level of this paragraph in the list. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + }, + "bulletSuggestionState": { # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. + "listIdSuggested": True or False, # Indicates if there was a suggested change to the list_id. + "nestingLevelSuggested": True or False, # Indicates if there was a suggested change to the nesting_level. + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + }, + "suggestedParagraphStyleChanges": { # The suggested paragraph style changes to this paragraph, keyed by suggestion ID. + "a_key": { # A suggested change to a ParagraphStyle. + "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A ParagraphStyle that only includes the changes made in this suggestion. This can be used along with the paragraph_style_suggestion_state to see which fields have changed and their new values. + "alignment": "A String", # The text alignment for this paragraph. + "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. + "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. + "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, - }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this AutoText. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - "type": "A String", # The type of this auto text. - }, - "columnBreak": { # A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column. # A column break paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this ColumnBreak, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. + "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. + "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. + "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. + "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. + "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. + "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. + "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. + "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, + "spacingMode": "A String", # The spacing mode for the paragraph. + "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. + { # A tab stop within a paragraph. + "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. + "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + ], }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, - }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "paragraphStyleSuggestionState": { # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. + "alignmentSuggested": True or False, # Indicates if there was a suggested change to alignment. + "avoidWidowAndOrphanSuggested": True or False, # Indicates if there was a suggested change to avoid_widow_and_orphan. + "borderBetweenSuggested": True or False, # Indicates if there was a suggested change to border_between. + "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. + "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. + "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. + "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. + "directionSuggested": True or False, # Indicates if there was a suggested change to direction. + "headingIdSuggested": True or False, # Indicates if there was a suggested change to heading_id. + "indentEndSuggested": True or False, # Indicates if there was a suggested change to indent_end. + "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line. + "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start. + "keepLinesTogetherSuggested": True or False, # Indicates if there was a suggested change to keep_lines_together. + "keepWithNextSuggested": True or False, # Indicates if there was a suggested change to keep_with_next. + "lineSpacingSuggested": True or False, # Indicates if there was a suggested change to line_spacing. + "namedStyleTypeSuggested": True or False, # Indicates if there was a suggested change to named_style_type. + "pageBreakBeforeSuggested": True or False, # Indicates if there was a suggested change to page_break_before. + "shadingSuggestionState": { # A mask that indicates which of the fields on the base Shading have been changed in this suggested change. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in shading have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to the Shading. + }, + "spaceAboveSuggested": True or False, # Indicates if there was a suggested change to space_above. + "spaceBelowSuggested": True or False, # Indicates if there was a suggested change to space_below. + "spacingModeSuggested": True or False, # Indicates if there was a suggested change to spacing_mode. + }, + }, + }, + "suggestedPositionedObjectIds": { # The IDs of the positioned objects suggested to be attached to this paragraph, keyed by suggestion ID. + "a_key": { # A collection of object IDs. + "objectIds": [ # The object IDs. + "A String", + ], + }, + }, + }, + "sectionBreak": { # A StructuralElement representing a section break. A section is a range of content that has the same SectionStyle. A section break represents the start of a new section, and the section style applies to the section after the section break. The document body always begins with a section break. # A section break type of structural element. + "sectionStyle": { # The styling that applies to a section. # The style of the section after this section break. + "columnProperties": [ # The section's columns properties. If empty, the section contains one column with the default properties in the Docs editor. A section can be updated to have no more than 3 columns. When updating this property, setting a concrete value is required. Unsetting this property will result in a 400 bad request error. + { # Properties that apply to a section's column. + "paddingEnd": { # A magnitude in a single direction in the specified units. # The padding at the end of the column. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # Output only. The width of the column. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, }, + ], + "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only. + "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only. + "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only. + "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only. + "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only. + "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only. + "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, + "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. + "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, + "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "sectionType": "A String", # Output only. The type of section. + "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. }, - }, - "endIndex": 42, # The zero-base end index of this paragraph element, exclusive, in UTF-16 code units. - "equation": { # A ParagraphElement representing an equation. # An equation paragraph element. "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. "A String", ], - "suggestedInsertionIds": [ # The suggested insertion IDs. An Equation may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "suggestedInsertionIds": [ # The suggested insertion IDs. A SectionBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. "A String", ], }, - "footnoteReference": { # A ParagraphElement representing a footnote reference. A footnote reference is the inline content rendered with a number and is used to identify the footnote. # A footnote reference paragraph element. - "footnoteId": "A String", # The ID of the footnote that contains the content of this footnote reference. - "footnoteNumber": "A String", # The rendered number of this footnote. + "startIndex": 42, # The zero-based start index of this structural element, in UTF-16 code units. + "table": { # A StructuralElement representing a table. # A table type of structural element. + "columns": 42, # Number of columns in the table. It's possible for a table to be non-rectangular, so some rows may have a different number of cells. + "rows": 42, # Number of rows in the table. "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. "A String", ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "suggestedInsertionIds": [ # The suggested insertion IDs. A Table may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. "A String", ], - "suggestedTextStyleChanges": { # The suggested text style changes to this FootnoteReference, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "tableRows": [ # The contents and style of each row. + { # The contents and style of a row in a Table. + "endIndex": 42, # The zero-based end index of this row, exclusive, in UTF-16 code units. + "startIndex": 42, # The zero-based start index of this row, in UTF-16 code units. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TableRow may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTableRowStyleChanges": { # The suggested style changes to this row, keyed by suggestion ID. + "a_key": { # A suggested change to a TableRowStyle. + "tableRowStyle": { # Styles that apply to a table row. # A TableRowStyle that only includes the changes made in this suggestion. This can be used along with the table_row_style_suggestion_state to see which fields have changed and their new values. + "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries. + "tableHeader": True or False, # Whether the row is a table header. + }, + "tableRowStyleSuggestionState": { # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. + "minRowHeightSuggested": True or False, # Indicates if there was a suggested change to min_row_height. + }, + }, + }, + "tableCells": [ # The contents and style of each cell in this row. It's possible for a table to be non-rectangular, so some rows may have a different number of cells than other rows in the same table. + { # The contents and style of a cell in a Table. + "content": [ # The content of the cell. + # Object with schema name: StructuralElement + ], + "endIndex": 42, # The zero-based end index of this cell, exclusive, in UTF-16 code units. + "startIndex": 42, # The zero-based start index of this cell, in UTF-16 code units. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TableCell may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTableCellStyleChanges": { # The suggested changes to the table cell style, keyed by suggestion ID. + "a_key": { # A suggested change to a TableCellStyle. + "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # A TableCellStyle that only includes the changes made in this suggestion. This can be used along with the table_cell_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "columnSpan": 42, # The column span of the cell. This property is read-only. + "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. + "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "rowSpan": 42, # The row span of the cell. This property is read-only. + }, + "tableCellStyleSuggestionState": { # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. + "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. + "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. + "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. + "columnSpanSuggested": True or False, # Indicates if there was a suggested change to column_span. + "contentAlignmentSuggested": True or False, # Indicates if there was a suggested change to content_alignment. + "paddingBottomSuggested": True or False, # Indicates if there was a suggested change to padding_bottom. + "paddingLeftSuggested": True or False, # Indicates if there was a suggested change to padding_left. + "paddingRightSuggested": True or False, # Indicates if there was a suggested change to padding_right. + "paddingTopSuggested": True or False, # Indicates if there was a suggested change to padding_top. + "rowSpanSuggested": True or False, # Indicates if there was a suggested change to row_span. + }, }, }, + "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # The style of the cell. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "columnSpan": 42, # The column span of the cell. This property is read-only. + "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. + "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "rowSpan": 42, # The row span of the cell. This property is read-only. + }, + }, + ], + "tableRowStyle": { # Styles that apply to a table row. # The style of the table row. + "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, - }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this FootnoteReference. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries. + "tableHeader": True or False, # Whether the row is a table header. }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + ], + "tableStyle": { # Styles that apply to a table. # The style of the table. + "tableColumnProperties": [ # The properties of each column. Note that in Docs, tables contain rows and rows contain cells, similar to HTML. So the properties for a row can be found on the row's table_row_style. + { # The properties of a column in a table. + "width": { # A magnitude in a single direction in the specified units. # The width of the column. Set when the column's `width_type` is FIXED_WIDTH. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, + "widthType": "A String", # The width type of the column. }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, + ], }, }, - "horizontalRule": { # A ParagraphElement representing a horizontal line. # A horizontal rule paragraph element. + "tableOfContents": { # A StructuralElement representing a table of contents. # A table of contents type of structural element. + "content": [ # The content of the table of contents. + # Object with schema name: StructuralElement + ], "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. "A String", ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A HorizontalRule may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. + "suggestedInsertionIds": [ # The suggested insertion IDs. A TableOfContents may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. "A String", ], - "suggestedTextStyleChanges": { # The suggested text style changes to this HorizontalRule, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + }, + }, + ], + "footerId": "A String", # The ID of the footer. + }, + }, + "footnotes": { # The footnotes in the document tab, keyed by footnote ID. + "a_key": { # A document footnote. + "content": [ # The contents of the footnote. The indexes for a footnote's content begin at zero. + { # A StructuralElement describes content that provides structure to the document. + "endIndex": 42, # The zero-based end index of this structural element, exclusive, in UTF-16 code units. + "paragraph": { # A StructuralElement representing a paragraph. A paragraph is a range of content that's terminated with a newline character. # A paragraph type of structural element. + "bullet": { # Describes the bullet of a paragraph. # The bullet for this paragraph. If not present, the paragraph does not belong to a list. + "listId": "A String", # The ID of the list this paragraph belongs to. + "nestingLevel": 42, # The nesting level of this paragraph in the list. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this HorizontalRule. Similar to text content, like text runs and footnote references, the text style of a horizontal rule can affect content layout as well as the styling of text inserted next to it. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, - }, - "inlineObjectElement": { # A ParagraphElement that contains an InlineObject. # An inline object paragraph element. - "inlineObjectId": "A String", # The ID of the InlineObject this element contains. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. An InlineObjectElement may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this InlineObject, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "elements": [ # The content of the paragraph, broken down into its component parts. + { # A ParagraphElement describes content within a Paragraph. + "autoText": { # A ParagraphElement representing a spot in the text that's dynamically replaced with content that can change over time, like a page number. # An auto text paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. An AutoText may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this AutoText, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. }, }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, - }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this InlineObjectElement. Similar to text content, like text runs and footnote references, the text style of an inline object element can affect content layout as well as the styling of text inserted next to it. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - "pageBreak": { # A ParagraphElement representing a page break. A page break makes the subsequent text start at the top of the next page. # A page break paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A PageBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this PageBreak, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this AutoText. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, - }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this PageBreak. Similar to text content, like text runs and footnote references, the text style of a page break can affect content layout as well as the styling of text inserted next to it. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - "person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address. - "personId": "A String", # Output only. The unique ID of this link. - "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present. - "email": "A String", # Output only. The email address linked to this Person. This field is always present. - "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address. - }, - "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. - "A String", - ], - "suggestedInsertionIds": [ # IDs for suggestions that insert this person link into the document. A Person might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this Person, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "type": "A String", # The type of this auto text. + }, + "columnBreak": { # A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column. # A column break paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this ColumnBreak, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. }, }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "endIndex": 42, # The zero-base end index of this paragraph element, exclusive, in UTF-16 code units. + "equation": { # A ParagraphElement representing an equation. # An equation paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. An Equation may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + }, + "footnoteReference": { # A ParagraphElement representing a footnote reference. A footnote reference is the inline content rendered with a number and is used to identify the footnote. # A footnote reference paragraph element. + "footnoteId": "A String", # The ID of the footnote that contains the content of this footnote reference. + "footnoteNumber": "A String", # The rendered number of this footnote. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this FootnoteReference, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. }, }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, - }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this Person. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - "richLink": { # A link to a Google resource (such as a file in Drive, a YouTube video, or a Calendar event). # A paragraph element that links to a Google resource (such as a file in Google Drive, a YouTube video, or a Calendar event.) - "richLinkId": "A String", # Output only. The ID of this link. - "richLinkProperties": { # Properties specific to a RichLink. # Output only. The properties of this RichLink. This field is always present. - "mimeType": "A String", # Output only. The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the RichLink, if there's one (for example, when it's a file in Drive). - "title": "A String", # Output only. The title of the RichLink as displayed in the link. This title matches the title of the linked resource at the time of the insertion or last update of the link. This field is always present. - "uri": "A String", # Output only. The URI to the RichLink. This is always present. - }, - "suggestedDeletionIds": [ # IDs for suggestions that remove this link from the document. A RichLink might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. - "A String", - ], - "suggestedInsertionIds": [ # IDs for suggestions that insert this link into the document. A RichLink might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this RichLink, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this FootnoteReference. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, - }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this RichLink. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - "startIndex": 42, # The zero-based start index of this paragraph element, in UTF-16 code units. - "textRun": { # A ParagraphElement that represents a run of text that all has the same styling. # A text run paragraph element. - "content": "A String", # The text of this run. Any non-text elements in the run are replaced with the Unicode character U+E907. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A TextRun may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this run, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "horizontalRule": { # A ParagraphElement representing a horizontal line. # A horizontal rule paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A HorizontalRule may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this HorizontalRule, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. }, }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this HorizontalRule. Similar to text content, like text runs and footnote references, the text style of a horizontal rule can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "inlineObjectElement": { # A ParagraphElement that contains an InlineObject. # An inline object paragraph element. + "inlineObjectId": "A String", # The ID of the InlineObject this element contains. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. An InlineObjectElement may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this InlineObject, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. }, }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this InlineObjectElement. Similar to text content, like text runs and footnote references, the text style of an inline object element can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "pageBreak": { # A ParagraphElement representing a page break. A page break makes the subsequent text start at the top of the next page. # A page break paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A PageBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this PageBreak, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this PageBreak. Similar to text content, like text runs and footnote references, the text style of a page break can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address. + "personId": "A String", # Output only. The unique ID of this link. + "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present. + "email": "A String", # Output only. The email address linked to this Person. This field is always present. + "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address. + }, + "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. + "A String", + ], + "suggestedInsertionIds": [ # IDs for suggestions that insert this person link into the document. A Person might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this Person, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this Person. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "richLink": { # A link to a Google resource (such as a file in Drive, a YouTube video, or a Calendar event). # A paragraph element that links to a Google resource (such as a file in Google Drive, a YouTube video, or a Calendar event.) + "richLinkId": "A String", # Output only. The ID of this link. + "richLinkProperties": { # Properties specific to a RichLink. # Output only. The properties of this RichLink. This field is always present. + "mimeType": "A String", # Output only. The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the RichLink, if there's one (for example, when it's a file in Drive). + "title": "A String", # Output only. The title of the RichLink as displayed in the link. This title matches the title of the linked resource at the time of the insertion or last update of the link. This field is always present. + "uri": "A String", # Output only. The URI to the RichLink. This is always present. + }, + "suggestedDeletionIds": [ # IDs for suggestions that remove this link from the document. A RichLink might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. + "A String", + ], + "suggestedInsertionIds": [ # IDs for suggestions that insert this link into the document. A RichLink might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this RichLink, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this RichLink. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "startIndex": 42, # The zero-based start index of this paragraph element, in UTF-16 code units. + "textRun": { # A ParagraphElement that represents a run of text that all has the same styling. # A text run paragraph element. + "content": "A String", # The text of this run. Any non-text elements in the run are replaced with the Unicode character U+E907. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TextRun may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this run, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this run. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, }, }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + ], + "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The style of this paragraph. + "alignment": "A String", # The text alignment for this paragraph. + "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. + "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this run. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - }, - ], - "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The style of this paragraph. - "alignment": "A String", # The text alignment for this paragraph. - "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. - "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. + "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. + "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. - "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. - "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. - "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. - "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. - "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. - "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. - "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - }, - }, - }, - "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "spacingMode": "A String", # The spacing mode for the paragraph. - "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. - { # A tab stop within a paragraph. - "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. - "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - ], - }, - "positionedObjectIds": [ # The IDs of the positioned objects tethered to this paragraph. - "A String", - ], - "suggestedBulletChanges": { # The suggested changes to this paragraph's bullet. - "a_key": { # A suggested change to a Bullet. - "bullet": { # Describes the bullet of a paragraph. # A Bullet that only includes the changes made in this suggestion. This can be used along with the bullet_suggestion_state to see which fields have changed and their new values. - "listId": "A String", # The ID of the list this paragraph belongs to. - "nestingLevel": 42, # The nesting level of this paragraph in the list. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. + "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. + "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. + "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. + "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. + "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spacingMode": "A String", # The spacing mode for the paragraph. + "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. + { # A tab stop within a paragraph. + "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. + "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - "bulletSuggestionState": { # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. - "listIdSuggested": True or False, # Indicates if there was a suggested change to the list_id. - "nestingLevelSuggested": True or False, # Indicates if there was a suggested change to the nesting_level. - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + ], }, - }, - }, - }, - "suggestedParagraphStyleChanges": { # The suggested paragraph style changes to this paragraph, keyed by suggestion ID. - "a_key": { # A suggested change to a ParagraphStyle. - "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A ParagraphStyle that only includes the changes made in this suggestion. This can be used along with the paragraph_style_suggestion_state to see which fields have changed and their new values. - "alignment": "A String", # The text alignment for this paragraph. - "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. - "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "positionedObjectIds": [ # The IDs of the positioned objects tethered to this paragraph. + "A String", + ], + "suggestedBulletChanges": { # The suggested changes to this paragraph's bullet. + "a_key": { # A suggested change to a Bullet. + "bullet": { # Describes the bullet of a paragraph. # A Bullet that only includes the changes made in this suggestion. This can be used along with the bullet_suggestion_state to see which fields have changed and their new values. + "listId": "A String", # The ID of the list this paragraph belongs to. + "nestingLevel": 42, # The nesting level of this paragraph in the list. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, }, }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "bulletSuggestionState": { # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. + "listIdSuggested": True or False, # Indicates if there was a suggested change to the list_id. + "nestingLevelSuggested": True or False, # Indicates if there was a suggested change to the nesting_level. + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + }, + "suggestedParagraphStyleChanges": { # The suggested paragraph style changes to this paragraph, keyed by suggestion ID. + "a_key": { # A suggested change to a ParagraphStyle. + "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A ParagraphStyle that only includes the changes made in this suggestion. This can be used along with the paragraph_style_suggestion_state to see which fields have changed and their new values. + "alignment": "A String", # The text alignment for this paragraph. + "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. + "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. + "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. + "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. + "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. + "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. + "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. + "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. + "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + }, + "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, + "spacingMode": "A String", # The spacing mode for the paragraph. + "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. + { # A tab stop within a paragraph. + "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. + "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + ], }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "paragraphStyleSuggestionState": { # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. + "alignmentSuggested": True or False, # Indicates if there was a suggested change to alignment. + "avoidWidowAndOrphanSuggested": True or False, # Indicates if there was a suggested change to avoid_widow_and_orphan. + "borderBetweenSuggested": True or False, # Indicates if there was a suggested change to border_between. + "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. + "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. + "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. + "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. + "directionSuggested": True or False, # Indicates if there was a suggested change to direction. + "headingIdSuggested": True or False, # Indicates if there was a suggested change to heading_id. + "indentEndSuggested": True or False, # Indicates if there was a suggested change to indent_end. + "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line. + "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start. + "keepLinesTogetherSuggested": True or False, # Indicates if there was a suggested change to keep_lines_together. + "keepWithNextSuggested": True or False, # Indicates if there was a suggested change to keep_with_next. + "lineSpacingSuggested": True or False, # Indicates if there was a suggested change to line_spacing. + "namedStyleTypeSuggested": True or False, # Indicates if there was a suggested change to named_style_type. + "pageBreakBeforeSuggested": True or False, # Indicates if there was a suggested change to page_break_before. + "shadingSuggestionState": { # A mask that indicates which of the fields on the base Shading have been changed in this suggested change. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in shading have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to the Shading. + }, + "spaceAboveSuggested": True or False, # Indicates if there was a suggested change to space_above. + "spaceBelowSuggested": True or False, # Indicates if there was a suggested change to space_below. + "spacingModeSuggested": True or False, # Indicates if there was a suggested change to spacing_mode. + }, + }, + }, + "suggestedPositionedObjectIds": { # The IDs of the positioned objects suggested to be attached to this paragraph, keyed by suggestion ID. + "a_key": { # A collection of object IDs. + "objectIds": [ # The object IDs. + "A String", + ], + }, + }, + }, + "sectionBreak": { # A StructuralElement representing a section break. A section is a range of content that has the same SectionStyle. A section break represents the start of a new section, and the section style applies to the section after the section break. The document body always begins with a section break. # A section break type of structural element. + "sectionStyle": { # The styling that applies to a section. # The style of the section after this section break. + "columnProperties": [ # The section's columns properties. If empty, the section contains one column with the default properties in the Docs editor. A section can be updated to have no more than 3 columns. When updating this property, setting a concrete value is required. Unsetting this property will result in a 400 bad request error. + { # Properties that apply to a section's column. + "paddingEnd": { # A magnitude in a single direction in the specified units. # The padding at the end of the column. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # Output only. The width of the column. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + ], + "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only. + "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only. + "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only. + "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only. + "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only. + "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only. + "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - }, - "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - }, - "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, + "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "sectionType": "A String", # Output only. The type of section. + "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. }, - "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. - "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. - "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. - "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. - "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. - "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. - "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. - "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - }, - "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "spacingMode": "A String", # The spacing mode for the paragraph. - "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. - { # A tab stop within a paragraph. - "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. - "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A SectionBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", ], }, - "paragraphStyleSuggestionState": { # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. - "alignmentSuggested": True or False, # Indicates if there was a suggested change to alignment. - "avoidWidowAndOrphanSuggested": True or False, # Indicates if there was a suggested change to avoid_widow_and_orphan. - "borderBetweenSuggested": True or False, # Indicates if there was a suggested change to border_between. - "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. - "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. - "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. - "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. - "directionSuggested": True or False, # Indicates if there was a suggested change to direction. - "headingIdSuggested": True or False, # Indicates if there was a suggested change to heading_id. - "indentEndSuggested": True or False, # Indicates if there was a suggested change to indent_end. - "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line. - "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start. - "keepLinesTogetherSuggested": True or False, # Indicates if there was a suggested change to keep_lines_together. - "keepWithNextSuggested": True or False, # Indicates if there was a suggested change to keep_with_next. - "lineSpacingSuggested": True or False, # Indicates if there was a suggested change to line_spacing. - "namedStyleTypeSuggested": True or False, # Indicates if there was a suggested change to named_style_type. - "pageBreakBeforeSuggested": True or False, # Indicates if there was a suggested change to page_break_before. - "shadingSuggestionState": { # A mask that indicates which of the fields on the base Shading have been changed in this suggested change. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in shading have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to the Shading. - }, - "spaceAboveSuggested": True or False, # Indicates if there was a suggested change to space_above. - "spaceBelowSuggested": True or False, # Indicates if there was a suggested change to space_below. - "spacingModeSuggested": True or False, # Indicates if there was a suggested change to spacing_mode. - }, - }, - }, - "suggestedPositionedObjectIds": { # The IDs of the positioned objects suggested to be attached to this paragraph, keyed by suggestion ID. - "a_key": { # A collection of object IDs. - "objectIds": [ # The object IDs. - "A String", - ], - }, - }, - }, - "sectionBreak": { # A StructuralElement representing a section break. A section is a range of content that has the same SectionStyle. A section break represents the start of a new section, and the section style applies to the section after the section break. The document body always begins with a section break. # A section break type of structural element. - "sectionStyle": { # The styling that applies to a section. # The style of the section after this section break. - "columnProperties": [ # The section's columns properties. If empty, the section contains one column with the default properties in the Docs editor. A section can be updated to have no more than 3 columns. When updating this property, setting a concrete value is required. Unsetting this property will result in a 400 bad request error. - { # Properties that apply to a section's column. - "paddingEnd": { # A magnitude in a single direction in the specified units. # The padding at the end of the column. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # Output only. The width of the column. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - ], - "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only. - "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only. - "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only. - "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only. - "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only. - "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only. - "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "sectionType": "A String", # Output only. The type of section. - "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - }, - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A SectionBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - }, - "startIndex": 42, # The zero-based start index of this structural element, in UTF-16 code units. - "table": { # A StructuralElement representing a table. # A table type of structural element. - "columns": 42, # Number of columns in the table. It's possible for a table to be non-rectangular, so some rows may have a different number of cells. - "rows": 42, # Number of rows in the table. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A Table may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "tableRows": [ # The contents and style of each row. - { # The contents and style of a row in a Table. - "endIndex": 42, # The zero-based end index of this row, exclusive, in UTF-16 code units. - "startIndex": 42, # The zero-based start index of this row, in UTF-16 code units. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A TableRow may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTableRowStyleChanges": { # The suggested style changes to this row, keyed by suggestion ID. - "a_key": { # A suggested change to a TableRowStyle. - "tableRowStyle": { # Styles that apply to a table row. # A TableRowStyle that only includes the changes made in this suggestion. This can be used along with the table_row_style_suggestion_state to see which fields have changed and their new values. - "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries. - "tableHeader": True or False, # Whether the row is a table header. - }, - "tableRowStyleSuggestionState": { # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. - "minRowHeightSuggested": True or False, # Indicates if there was a suggested change to min_row_height. - }, - }, - }, - "tableCells": [ # The contents and style of each cell in this row. It's possible for a table to be non-rectangular, so some rows may have a different number of cells than other rows in the same table. - { # The contents and style of a cell in a Table. - "content": [ # The content of the cell. - # Object with schema name: StructuralElement - ], - "endIndex": 42, # The zero-based end index of this cell, exclusive, in UTF-16 code units. - "startIndex": 42, # The zero-based start index of this cell, in UTF-16 code units. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A TableCell may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTableCellStyleChanges": { # The suggested changes to the table cell style, keyed by suggestion ID. - "a_key": { # A suggested change to a TableCellStyle. - "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # A TableCellStyle that only includes the changes made in this suggestion. This can be used along with the table_cell_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "startIndex": 42, # The zero-based start index of this structural element, in UTF-16 code units. + "table": { # A StructuralElement representing a table. # A table type of structural element. + "columns": 42, # Number of columns in the table. It's possible for a table to be non-rectangular, so some rows may have a different number of cells. + "rows": 42, # Number of rows in the table. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A Table may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "tableRows": [ # The contents and style of each row. + { # The contents and style of a row in a Table. + "endIndex": 42, # The zero-based end index of this row, exclusive, in UTF-16 code units. + "startIndex": 42, # The zero-based start index of this row, in UTF-16 code units. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TableRow may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTableRowStyleChanges": { # The suggested style changes to this row, keyed by suggestion ID. + "a_key": { # A suggested change to a TableRowStyle. + "tableRowStyle": { # Styles that apply to a table row. # A TableRowStyle that only includes the changes made in this suggestion. This can be used along with the table_row_style_suggestion_state to see which fields have changed and their new values. + "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries. + "tableHeader": True or False, # Whether the row is a table header. + }, + "tableRowStyleSuggestionState": { # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. + "minRowHeightSuggested": True or False, # Indicates if there was a suggested change to min_row_height. + }, + }, + }, + "tableCells": [ # The contents and style of each cell in this row. It's possible for a table to be non-rectangular, so some rows may have a different number of cells than other rows in the same table. + { # The contents and style of a cell in a Table. + "content": [ # The content of the cell. + # Object with schema name: StructuralElement + ], + "endIndex": 42, # The zero-based end index of this cell, exclusive, in UTF-16 code units. + "startIndex": 42, # The zero-based start index of this cell, in UTF-16 code units. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TableCell may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTableCellStyleChanges": { # The suggested changes to the table cell style, keyed by suggestion ID. + "a_key": { # A suggested change to a TableCellStyle. + "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # A TableCellStyle that only includes the changes made in this suggestion. This can be used along with the table_cell_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "columnSpan": 42, # The column span of the cell. This property is read-only. + "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. + "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "rowSpan": 42, # The row span of the cell. This property is read-only. + }, + "tableCellStyleSuggestionState": { # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. + "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. + "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. + "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. + "columnSpanSuggested": True or False, # Indicates if there was a suggested change to column_span. + "contentAlignmentSuggested": True or False, # Indicates if there was a suggested change to content_alignment. + "paddingBottomSuggested": True or False, # Indicates if there was a suggested change to padding_bottom. + "paddingLeftSuggested": True or False, # Indicates if there was a suggested change to padding_left. + "paddingRightSuggested": True or False, # Indicates if there was a suggested change to padding_right. + "paddingTopSuggested": True or False, # Indicates if there was a suggested change to padding_top. + "rowSpanSuggested": True or False, # Indicates if there was a suggested change to row_span. }, }, }, - "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # The style of the cell. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -12487,98 +15704,141 @@

Method Details

}, }, }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - }, - "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - }, - "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "columnSpan": 42, # The column span of the cell. This property is read-only. + "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. + "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - }, - "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, + "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, + "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "rowSpan": 42, # The row span of the cell. This property is read-only. }, - "columnSpan": 42, # The column span of the cell. This property is read-only. - "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. - "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "rowSpan": 42, # The row span of the cell. This property is read-only. }, - "tableCellStyleSuggestionState": { # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. - "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. - "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. - "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. - "columnSpanSuggested": True or False, # Indicates if there was a suggested change to column_span. - "contentAlignmentSuggested": True or False, # Indicates if there was a suggested change to content_alignment. - "paddingBottomSuggested": True or False, # Indicates if there was a suggested change to padding_bottom. - "paddingLeftSuggested": True or False, # Indicates if there was a suggested change to padding_left. - "paddingRightSuggested": True or False, # Indicates if there was a suggested change to padding_right. - "paddingTopSuggested": True or False, # Indicates if there was a suggested change to padding_top. - "rowSpanSuggested": True or False, # Indicates if there was a suggested change to row_span. + ], + "tableRowStyle": { # Styles that apply to a table row. # The style of the table row. + "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, + "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries. + "tableHeader": True or False, # Whether the row is a table header. }, }, - "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # The style of the cell. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell. + ], + "tableStyle": { # Styles that apply to a table. # The style of the table. + "tableColumnProperties": [ # The properties of each column. Note that in Docs, tables contain rows and rows contain cells, similar to HTML. So the properties for a row can be found on the row's table_row_style. + { # The properties of a column in a table. + "width": { # A magnitude in a single direction in the specified units. # The width of the column. Set when the column's `width_type` is FIXED_WIDTH. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "widthType": "A String", # The width type of the column. + }, + ], + }, + }, + "tableOfContents": { # A StructuralElement representing a table of contents. # A table of contents type of structural element. + "content": [ # The content of the table of contents. + # Object with schema name: StructuralElement + ], + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TableOfContents may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + }, + }, + ], + "footnoteId": "A String", # The ID of the footnote. + }, + }, + "headers": { # The headers in the document tab, keyed by header ID. + "a_key": { # A document header. + "content": [ # The contents of the header. The indexes for a header's content begin at zero. + { # A StructuralElement describes content that provides structure to the document. + "endIndex": 42, # The zero-based end index of this structural element, exclusive, in UTF-16 code units. + "paragraph": { # A StructuralElement representing a paragraph. A paragraph is a range of content that's terminated with a newline character. # A paragraph type of structural element. + "bullet": { # Describes the bullet of a paragraph. # The bullet for this paragraph. If not present, the paragraph does not belong to a list. + "listId": "A String", # The ID of the list this paragraph belongs to. + "nestingLevel": 42, # The nesting level of this paragraph in the list. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -12587,566 +15847,2152 @@

Method Details

}, }, }, - "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. }, - "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "elements": [ # The content of the paragraph, broken down into its component parts. + { # A ParagraphElement describes content within a Paragraph. + "autoText": { # A ParagraphElement representing a spot in the text that's dynamically replaced with content that can change over time, like a page number. # An auto text paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. An AutoText may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this AutoText, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. }, }, }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this AutoText. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "type": "A String", # The type of this auto text. + }, + "columnBreak": { # A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column. # A column break paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this ColumnBreak, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. }, }, }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "endIndex": 42, # The zero-base end index of this paragraph element, exclusive, in UTF-16 code units. + "equation": { # A ParagraphElement representing an equation. # An equation paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. An Equation may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + }, + "footnoteReference": { # A ParagraphElement representing a footnote reference. A footnote reference is the inline content rendered with a number and is used to identify the footnote. # A footnote reference paragraph element. + "footnoteId": "A String", # The ID of the footnote that contains the content of this footnote reference. + "footnoteNumber": "A String", # The rendered number of this footnote. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this FootnoteReference, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, }, - }, - "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this FootnoteReference. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "horizontalRule": { # A ParagraphElement representing a horizontal line. # A horizontal rule paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A HorizontalRule may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this HorizontalRule, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. }, }, }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this HorizontalRule. Similar to text content, like text runs and footnote references, the text style of a horizontal rule can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "inlineObjectElement": { # A ParagraphElement that contains an InlineObject. # An inline object paragraph element. + "inlineObjectId": "A String", # The ID of the InlineObject this element contains. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. An InlineObjectElement may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this InlineObject, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, }, - }, - "columnSpan": 42, # The column span of the cell. This property is read-only. - "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. - "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell. - "magnitude": 3.14, # The magnitude. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this InlineObjectElement. Similar to text content, like text runs and footnote references, the text style of an inline object element can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "pageBreak": { # A ParagraphElement representing a page break. A page break makes the subsequent text start at the top of the next page. # A page break paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A PageBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this PageBreak, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this PageBreak. Similar to text content, like text runs and footnote references, the text style of a page break can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address. + "personId": "A String", # Output only. The unique ID of this link. + "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present. + "email": "A String", # Output only. The email address linked to this Person. This field is always present. + "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address. + }, + "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. + "A String", + ], + "suggestedInsertionIds": [ # IDs for suggestions that insert this person link into the document. A Person might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this Person, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this Person. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "richLink": { # A link to a Google resource (such as a file in Drive, a YouTube video, or a Calendar event). # A paragraph element that links to a Google resource (such as a file in Google Drive, a YouTube video, or a Calendar event.) + "richLinkId": "A String", # Output only. The ID of this link. + "richLinkProperties": { # Properties specific to a RichLink. # Output only. The properties of this RichLink. This field is always present. + "mimeType": "A String", # Output only. The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the RichLink, if there's one (for example, when it's a file in Drive). + "title": "A String", # Output only. The title of the RichLink as displayed in the link. This title matches the title of the linked resource at the time of the insertion or last update of the link. This field is always present. + "uri": "A String", # Output only. The URI to the RichLink. This is always present. + }, + "suggestedDeletionIds": [ # IDs for suggestions that remove this link from the document. A RichLink might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. + "A String", + ], + "suggestedInsertionIds": [ # IDs for suggestions that insert this link into the document. A RichLink might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this RichLink, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this RichLink. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "startIndex": 42, # The zero-based start index of this paragraph element, in UTF-16 code units. + "textRun": { # A ParagraphElement that represents a run of text that all has the same styling. # A text run paragraph element. + "content": "A String", # The text of this run. Any non-text elements in the run are replaced with the Unicode character U+E907. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TextRun may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this run, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this run. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + }, + ], + "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The style of this paragraph. + "alignment": "A String", # The text alignment for this paragraph. + "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. + "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell. + }, + "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "rowSpan": 42, # The row span of the cell. This property is read-only. }, - }, - ], - "tableRowStyle": { # Styles that apply to a table row. # The style of the table row. - "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries. - "tableHeader": True or False, # Whether the row is a table header. - }, - }, - ], - "tableStyle": { # Styles that apply to a table. # The style of the table. - "tableColumnProperties": [ # The properties of each column. Note that in Docs, tables contain rows and rows contain cells, similar to HTML. So the properties for a row can be found on the row's table_row_style. - { # The properties of a column in a table. - "width": { # A magnitude in a single direction in the specified units. # The width of the column. Set when the column's `width_type` is FIXED_WIDTH. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "widthType": "A String", # The width type of the column. - }, - ], - }, - }, - "tableOfContents": { # A StructuralElement representing a table of contents. # A table of contents type of structural element. - "content": [ # The content of the table of contents. - # Object with schema name: StructuralElement - ], - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A TableOfContents may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - }, - }, - ], - "footerId": "A String", # The ID of the footer. - }, - }, - "footnotes": { # Output only. The footnotes in the document, keyed by footnote ID. - "a_key": { # A document footnote. - "content": [ # The contents of the footnote. The indexes for a footnote's content begin at zero. - { # A StructuralElement describes content that provides structure to the document. - "endIndex": 42, # The zero-based end index of this structural element, exclusive, in UTF-16 code units. - "paragraph": { # A StructuralElement representing a paragraph. A paragraph is a range of content that's terminated with a newline character. # A paragraph type of structural element. - "bullet": { # Describes the bullet of a paragraph. # The bullet for this paragraph. If not present, the paragraph does not belong to a list. - "listId": "A String", # The ID of the list this paragraph belongs to. - "nestingLevel": 42, # The nesting level of this paragraph in the list. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - "elements": [ # The content of the paragraph, broken down into its component parts. - { # A ParagraphElement describes content within a Paragraph. - "autoText": { # A ParagraphElement representing a spot in the text that's dynamically replaced with content that can change over time, like a page number. # An auto text paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. An AutoText may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this AutoText, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this AutoText. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. + "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. + "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. + "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. + "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. + "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. + "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. + "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. + "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, + "spacingMode": "A String", # The spacing mode for the paragraph. + "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. + { # A tab stop within a paragraph. + "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. + "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + ], }, - "type": "A String", # The type of this auto text. - }, - "columnBreak": { # A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column. # A column break paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "positionedObjectIds": [ # The IDs of the positioned objects tethered to this paragraph. "A String", ], - "suggestedTextStyleChanges": { # The suggested text style changes to this ColumnBreak, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "suggestedBulletChanges": { # The suggested changes to this paragraph's bullet. + "a_key": { # A suggested change to a Bullet. + "bullet": { # Describes the bullet of a paragraph. # A Bullet that only includes the changes made in this suggestion. This can be used along with the bullet_suggestion_state to see which fields have changed and their new values. + "listId": "A String", # The ID of the list this paragraph belongs to. + "nestingLevel": 42, # The nesting level of this paragraph in the list. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "bulletSuggestionState": { # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. + "listIdSuggested": True or False, # Indicates if there was a suggested change to the list_id. + "nestingLevelSuggested": True or False, # Indicates if there was a suggested change to the nesting_level. + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + }, + "suggestedParagraphStyleChanges": { # The suggested paragraph style changes to this paragraph, keyed by suggestion ID. + "a_key": { # A suggested change to a ParagraphStyle. + "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A ParagraphStyle that only includes the changes made in this suggestion. This can be used along with the paragraph_style_suggestion_state to see which fields have changed and their new values. + "alignment": "A String", # The text alignment for this paragraph. + "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. + "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. + "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, + "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. + "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. + "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. + "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. + "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. + "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. + "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. + "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + }, + "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spacingMode": "A String", # The spacing mode for the paragraph. + "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. + { # A tab stop within a paragraph. + "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. + "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + ], }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, - }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "paragraphStyleSuggestionState": { # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. + "alignmentSuggested": True or False, # Indicates if there was a suggested change to alignment. + "avoidWidowAndOrphanSuggested": True or False, # Indicates if there was a suggested change to avoid_widow_and_orphan. + "borderBetweenSuggested": True or False, # Indicates if there was a suggested change to border_between. + "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. + "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. + "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. + "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. + "directionSuggested": True or False, # Indicates if there was a suggested change to direction. + "headingIdSuggested": True or False, # Indicates if there was a suggested change to heading_id. + "indentEndSuggested": True or False, # Indicates if there was a suggested change to indent_end. + "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line. + "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start. + "keepLinesTogetherSuggested": True or False, # Indicates if there was a suggested change to keep_lines_together. + "keepWithNextSuggested": True or False, # Indicates if there was a suggested change to keep_with_next. + "lineSpacingSuggested": True or False, # Indicates if there was a suggested change to line_spacing. + "namedStyleTypeSuggested": True or False, # Indicates if there was a suggested change to named_style_type. + "pageBreakBeforeSuggested": True or False, # Indicates if there was a suggested change to page_break_before. + "shadingSuggestionState": { # A mask that indicates which of the fields on the base Shading have been changed in this suggested change. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in shading have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to the Shading. + }, + "spaceAboveSuggested": True or False, # Indicates if there was a suggested change to space_above. + "spaceBelowSuggested": True or False, # Indicates if there was a suggested change to space_below. + "spacingModeSuggested": True or False, # Indicates if there was a suggested change to spacing_mode. + }, + }, + }, + "suggestedPositionedObjectIds": { # The IDs of the positioned objects suggested to be attached to this paragraph, keyed by suggestion ID. + "a_key": { # A collection of object IDs. + "objectIds": [ # The object IDs. + "A String", + ], + }, + }, + }, + "sectionBreak": { # A StructuralElement representing a section break. A section is a range of content that has the same SectionStyle. A section break represents the start of a new section, and the section style applies to the section after the section break. The document body always begins with a section break. # A section break type of structural element. + "sectionStyle": { # The styling that applies to a section. # The style of the section after this section break. + "columnProperties": [ # The section's columns properties. If empty, the section contains one column with the default properties in the Docs editor. A section can be updated to have no more than 3 columns. When updating this property, setting a concrete value is required. Unsetting this property will result in a 400 bad request error. + { # Properties that apply to a section's column. + "paddingEnd": { # A magnitude in a single direction in the specified units. # The padding at the end of the column. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # Output only. The width of the column. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, }, + ], + "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only. + "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only. + "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only. + "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only. + "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only. + "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only. + "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, + "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. + "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, + "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "sectionType": "A String", # Output only. The type of section. + "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. }, - }, - "endIndex": 42, # The zero-base end index of this paragraph element, exclusive, in UTF-16 code units. - "equation": { # A ParagraphElement representing an equation. # An equation paragraph element. "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. "A String", ], - "suggestedInsertionIds": [ # The suggested insertion IDs. An Equation may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "suggestedInsertionIds": [ # The suggested insertion IDs. A SectionBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. "A String", ], }, - "footnoteReference": { # A ParagraphElement representing a footnote reference. A footnote reference is the inline content rendered with a number and is used to identify the footnote. # A footnote reference paragraph element. - "footnoteId": "A String", # The ID of the footnote that contains the content of this footnote reference. - "footnoteNumber": "A String", # The rendered number of this footnote. + "startIndex": 42, # The zero-based start index of this structural element, in UTF-16 code units. + "table": { # A StructuralElement representing a table. # A table type of structural element. + "columns": 42, # Number of columns in the table. It's possible for a table to be non-rectangular, so some rows may have a different number of cells. + "rows": 42, # Number of rows in the table. "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. "A String", ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "suggestedInsertionIds": [ # The suggested insertion IDs. A Table may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. "A String", ], - "suggestedTextStyleChanges": { # The suggested text style changes to this FootnoteReference, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "tableRows": [ # The contents and style of each row. + { # The contents and style of a row in a Table. + "endIndex": 42, # The zero-based end index of this row, exclusive, in UTF-16 code units. + "startIndex": 42, # The zero-based start index of this row, in UTF-16 code units. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TableRow may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTableRowStyleChanges": { # The suggested style changes to this row, keyed by suggestion ID. + "a_key": { # A suggested change to a TableRowStyle. + "tableRowStyle": { # Styles that apply to a table row. # A TableRowStyle that only includes the changes made in this suggestion. This can be used along with the table_row_style_suggestion_state to see which fields have changed and their new values. + "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries. + "tableHeader": True or False, # Whether the row is a table header. + }, + "tableRowStyleSuggestionState": { # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. + "minRowHeightSuggested": True or False, # Indicates if there was a suggested change to min_row_height. + }, + }, + }, + "tableCells": [ # The contents and style of each cell in this row. It's possible for a table to be non-rectangular, so some rows may have a different number of cells than other rows in the same table. + { # The contents and style of a cell in a Table. + "content": [ # The content of the cell. + # Object with schema name: StructuralElement + ], + "endIndex": 42, # The zero-based end index of this cell, exclusive, in UTF-16 code units. + "startIndex": 42, # The zero-based start index of this cell, in UTF-16 code units. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TableCell may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTableCellStyleChanges": { # The suggested changes to the table cell style, keyed by suggestion ID. + "a_key": { # A suggested change to a TableCellStyle. + "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # A TableCellStyle that only includes the changes made in this suggestion. This can be used along with the table_cell_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "columnSpan": 42, # The column span of the cell. This property is read-only. + "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. + "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "rowSpan": 42, # The row span of the cell. This property is read-only. + }, + "tableCellStyleSuggestionState": { # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. + "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. + "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. + "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. + "columnSpanSuggested": True or False, # Indicates if there was a suggested change to column_span. + "contentAlignmentSuggested": True or False, # Indicates if there was a suggested change to content_alignment. + "paddingBottomSuggested": True or False, # Indicates if there was a suggested change to padding_bottom. + "paddingLeftSuggested": True or False, # Indicates if there was a suggested change to padding_left. + "paddingRightSuggested": True or False, # Indicates if there was a suggested change to padding_right. + "paddingTopSuggested": True or False, # Indicates if there was a suggested change to padding_top. + "rowSpanSuggested": True or False, # Indicates if there was a suggested change to row_span. + }, }, }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # The style of the cell. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "columnSpan": 42, # The column span of the cell. This property is read-only. + "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. + "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, + "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "rowSpan": 42, # The row span of the cell. This property is read-only. }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + ], + "tableRowStyle": { # Styles that apply to a table row. # The style of the table row. + "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries. + "tableHeader": True or False, # Whether the row is a table header. }, }, + ], + "tableStyle": { # Styles that apply to a table. # The style of the table. + "tableColumnProperties": [ # The properties of each column. Note that in Docs, tables contain rows and rows contain cells, similar to HTML. So the properties for a row can be found on the row's table_row_style. + { # The properties of a column in a table. + "width": { # A magnitude in a single direction in the specified units. # The width of the column. Set when the column's `width_type` is FIXED_WIDTH. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "widthType": "A String", # The width type of the column. + }, + ], }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this FootnoteReference. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "tableOfContents": { # A StructuralElement representing a table of contents. # A table of contents type of structural element. + "content": [ # The content of the table of contents. + # Object with schema name: StructuralElement + ], + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TableOfContents may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + }, + }, + ], + "headerId": "A String", # The ID of the header. + }, + }, + "inlineObjects": { # The inline objects in the document tab, keyed by object ID. + "a_key": { # An object that appears inline with text. An InlineObject contains an EmbeddedObject such as an image. + "inlineObjectProperties": { # Properties of an InlineObject. # The properties of this inline object. + "embeddedObject": { # An embedded object in the document. # The embedded object of this inline object. + "description": "A String", # The description of the embedded object. The `title` and `description` are both combined to display alt text. + "embeddedDrawingProperties": { # The properties of an embedded drawing and used to differentiate the object type. An embedded drawing is one that's created and edited within a document. Note that extensive details are not supported. # The properties of an embedded drawing. + }, + "embeddedObjectBorder": { # A border around an EmbeddedObject. # The border of the embedded object. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "propertyState": "A String", # The property state of the border property. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "imageProperties": { # The properties of an image. # The properties of an image. + "angle": 3.14, # The clockwise rotation angle of the image, in radians. + "brightness": 3.14, # The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. + "contentUri": "A String", # A URI to the image with a default lifetime of 30 minutes. This URI is tagged with the account of the requester. Anyone with the URI effectively accesses the image as the original requester. Access to the image may be lost if the document's sharing settings change. + "contrast": 3.14, # The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. + "cropProperties": { # The crop properties of an image. The crop rectangle is represented using fractional offsets from the original content's 4 edges. - If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the image's original bounding rectangle. - If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the image's original bounding rectangle. - If all offsets and rotation angle are 0, the image is not cropped. # The crop properties of the image. + "angle": 3.14, # The clockwise rotation angle of the crop rectangle around its center, in radians. Rotation is applied after the offsets. + "offsetBottom": 3.14, # The offset specifies how far inwards the bottom edge of the crop rectangle is from the bottom edge of the original content as a fraction of the original content's height. + "offsetLeft": 3.14, # The offset specifies how far inwards the left edge of the crop rectangle is from the left edge of the original content as a fraction of the original content's width. + "offsetRight": 3.14, # The offset specifies how far inwards the right edge of the crop rectangle is from the right edge of the original content as a fraction of the original content's width. + "offsetTop": 3.14, # The offset specifies how far inwards the top edge of the crop rectangle is from the top edge of the original content as a fraction of the original content's height. + }, + "sourceUri": "A String", # The source URI is the URI used to insert the image. The source URI can be empty. + "transparency": 3.14, # The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means transparent. + }, + "linkedContentReference": { # A reference to the external linked source content. # A reference to the external linked source content. For example, it contains a reference to the source Google Sheets chart when the embedded object is a linked chart. If unset, then the embedded object is not linked. + "sheetsChartReference": { # A reference to a linked chart embedded from Google Sheets. # A reference to the linked chart. + "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that's embedded. + "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart. + }, + }, + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginLeft": { # A magnitude in a single direction in the specified units. # The left margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginRight": { # A magnitude in a single direction in the specified units. # The right margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginTop": { # A magnitude in a single direction in the specified units. # The top margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "size": { # A width and height. # The visible size of the image after cropping. + "height": { # A magnitude in a single direction in the specified units. # The height of the object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "title": "A String", # The title of the embedded object. The `title` and `description` are both combined to display alt text. + }, + }, + "objectId": "A String", # The ID of this inline object. Can be used to update an object’s properties. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInlineObjectPropertiesChanges": { # The suggested changes to the inline object properties, keyed by suggestion ID. + "a_key": { # A suggested change to InlineObjectProperties. + "inlineObjectProperties": { # Properties of an InlineObject. # An InlineObjectProperties that only includes the changes made in this suggestion. This can be used along with the inline_object_properties_suggestion_state to see which fields have changed and their new values. + "embeddedObject": { # An embedded object in the document. # The embedded object of this inline object. + "description": "A String", # The description of the embedded object. The `title` and `description` are both combined to display alt text. + "embeddedDrawingProperties": { # The properties of an embedded drawing and used to differentiate the object type. An embedded drawing is one that's created and edited within a document. Note that extensive details are not supported. # The properties of an embedded drawing. + }, + "embeddedObjectBorder": { # A border around an EmbeddedObject. # The border of the embedded object. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, + "dashStyle": "A String", # The dash style of the border. + "propertyState": "A String", # The property state of the border property. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "imageProperties": { # The properties of an image. # The properties of an image. + "angle": 3.14, # The clockwise rotation angle of the image, in radians. + "brightness": 3.14, # The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. + "contentUri": "A String", # A URI to the image with a default lifetime of 30 minutes. This URI is tagged with the account of the requester. Anyone with the URI effectively accesses the image as the original requester. Access to the image may be lost if the document's sharing settings change. + "contrast": 3.14, # The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. + "cropProperties": { # The crop properties of an image. The crop rectangle is represented using fractional offsets from the original content's 4 edges. - If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the image's original bounding rectangle. - If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the image's original bounding rectangle. - If all offsets and rotation angle are 0, the image is not cropped. # The crop properties of the image. + "angle": 3.14, # The clockwise rotation angle of the crop rectangle around its center, in radians. Rotation is applied after the offsets. + "offsetBottom": 3.14, # The offset specifies how far inwards the bottom edge of the crop rectangle is from the bottom edge of the original content as a fraction of the original content's height. + "offsetLeft": 3.14, # The offset specifies how far inwards the left edge of the crop rectangle is from the left edge of the original content as a fraction of the original content's width. + "offsetRight": 3.14, # The offset specifies how far inwards the right edge of the crop rectangle is from the right edge of the original content as a fraction of the original content's width. + "offsetTop": 3.14, # The offset specifies how far inwards the top edge of the crop rectangle is from the top edge of the original content as a fraction of the original content's height. + }, + "sourceUri": "A String", # The source URI is the URI used to insert the image. The source URI can be empty. + "transparency": 3.14, # The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means transparent. + }, + "linkedContentReference": { # A reference to the external linked source content. # A reference to the external linked source content. For example, it contains a reference to the source Google Sheets chart when the embedded object is a linked chart. If unset, then the embedded object is not linked. + "sheetsChartReference": { # A reference to a linked chart embedded from Google Sheets. # A reference to the linked chart. + "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that's embedded. + "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart. + }, + }, + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom margin of the embedded object. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, + "marginLeft": { # A magnitude in a single direction in the specified units. # The left margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. + "marginRight": { # A magnitude in a single direction in the specified units. # The right margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "marginTop": { # A magnitude in a single direction in the specified units. # The top margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "size": { # A width and height. # The visible size of the image after cropping. + "height": { # A magnitude in a single direction in the specified units. # The height of the object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, + "title": "A String", # The title of the embedded object. The `title` and `description` are both combined to display alt text. }, }, - "horizontalRule": { # A ParagraphElement representing a horizontal line. # A horizontal rule paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A HorizontalRule may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this HorizontalRule, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, + "inlineObjectPropertiesSuggestionState": { # A mask that indicates which of the fields on the base InlineObjectProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base InlineObjectProperties have been changed in this suggestion. + "embeddedObjectSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedObject have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_object have been changed in this suggestion. + "descriptionSuggested": True or False, # Indicates if there was a suggested change to description. + "embeddedDrawingPropertiesSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedDrawingProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_drawing_properties have been changed in this suggestion. + }, + "embeddedObjectBorderSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedObjectBorder have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_object_border have been changed in this suggestion. + "colorSuggested": True or False, # Indicates if there was a suggested change to color. + "dashStyleSuggested": True or False, # Indicates if there was a suggested change to dash_style. + "propertyStateSuggested": True or False, # Indicates if there was a suggested change to property_state. + "widthSuggested": True or False, # Indicates if there was a suggested change to width. + }, + "imagePropertiesSuggestionState": { # A mask that indicates which of the fields on the base ImageProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in image_properties have been changed in this suggestion. + "angleSuggested": True or False, # Indicates if there was a suggested change to angle. + "brightnessSuggested": True or False, # Indicates if there was a suggested change to brightness. + "contentUriSuggested": True or False, # Indicates if there was a suggested change to content_uri. + "contrastSuggested": True or False, # Indicates if there was a suggested change to contrast. + "cropPropertiesSuggestionState": { # A mask that indicates which of the fields on the base CropProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in crop_properties have been changed in this suggestion. + "angleSuggested": True or False, # Indicates if there was a suggested change to angle. + "offsetBottomSuggested": True or False, # Indicates if there was a suggested change to offset_bottom. + "offsetLeftSuggested": True or False, # Indicates if there was a suggested change to offset_left. + "offsetRightSuggested": True or False, # Indicates if there was a suggested change to offset_right. + "offsetTopSuggested": True or False, # Indicates if there was a suggested change to offset_top. }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + "sourceUriSuggested": True or False, # Indicates if there was a suggested change to source_uri. + "transparencySuggested": True or False, # Indicates if there was a suggested change to transparency. + }, + "linkedContentReferenceSuggestionState": { # A mask that indicates which of the fields on the base LinkedContentReference have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in linked_content_reference have been changed in this suggestion. + "sheetsChartReferenceSuggestionState": { # A mask that indicates which of the fields on the base SheetsChartReference have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in sheets_chart_reference have been changed in this suggestion. + "chartIdSuggested": True or False, # Indicates if there was a suggested change to chart_id. + "spreadsheetIdSuggested": True or False, # Indicates if there was a suggested change to spreadsheet_id. }, }, + "marginBottomSuggested": True or False, # Indicates if there was a suggested change to margin_bottom. + "marginLeftSuggested": True or False, # Indicates if there was a suggested change to margin_left. + "marginRightSuggested": True or False, # Indicates if there was a suggested change to margin_right. + "marginTopSuggested": True or False, # Indicates if there was a suggested change to margin_top. + "sizeSuggestionState": { # A mask that indicates which of the fields on the base Size have been changed in this suggestion. For any field set to true, the Size has a new suggested value. # A mask that indicates which of the fields in size have been changed in this suggestion. + "heightSuggested": True or False, # Indicates if there was a suggested change to height. + "widthSuggested": True or False, # Indicates if there was a suggested change to width. + }, + "titleSuggested": True or False, # Indicates if there was a suggested change to title. }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this HorizontalRule. Similar to text content, like text runs and footnote references, the text style of a horizontal rule can affect content layout as well as the styling of text inserted next to it. + }, + }, + }, + "suggestedInsertionId": "A String", # The suggested insertion ID. If empty, then this is not a suggested insertion. + }, + }, + "lists": { # The lists in the document tab, keyed by list ID. + "a_key": { # A List represents the list attributes for a group of paragraphs that all belong to the same list. A paragraph that's part of a list has a reference to the list's ID in its bullet. + "listProperties": { # The properties of a list that describe the look and feel of bullets belonging to paragraphs associated with a list. # The properties of the list. + "nestingLevels": [ # Describes the properties of the bullets at the associated level. A list has at most 9 levels of nesting with nesting level 0 corresponding to the top-most level and nesting level 8 corresponding to the most nested level. The nesting levels are returned in ascending order with the least nested returned first. + { # Contains properties describing the look and feel of a list bullet at a given level of nesting. + "bulletAlignment": "A String", # The alignment of the bullet within the space allotted for rendering the bullet. + "glyphFormat": "A String", # The format string used by bullets at this level of nesting. The glyph format contains one or more placeholders, and these placeholders are replaced with the appropriate values depending on the glyph_type or glyph_symbol. The placeholders follow the pattern `%[nesting_level]`. Furthermore, placeholders can have prefixes and suffixes. Thus, the glyph format follows the pattern `%[nesting_level]`. Note that the prefix and suffix are optional and can be arbitrary strings. For example, the glyph format `%0.` indicates that the rendered glyph will replace the placeholder with the corresponding glyph for nesting level 0 followed by a period as the suffix. So a list with a glyph type of UPPER_ALPHA and glyph format `%0.` at nesting level 0 will result in a list with rendered glyphs `A.` `B.` `C.` The glyph format can contain placeholders for the current nesting level as well as placeholders for parent nesting levels. For example, a list can have a glyph format of `%0.` at nesting level 0 and a glyph format of `%0.%1.` at nesting level 1. Assuming both nesting levels have DECIMAL glyph types, this would result in a list with rendered glyphs `1.` `2.` ` 2.1.` ` 2.2.` `3.` For nesting levels that are ordered, the string that replaces a placeholder in the glyph format for a particular paragraph depends on the paragraph's order within the list. + "glyphSymbol": "A String", # A custom glyph symbol used by bullets when paragraphs at this level of nesting are unordered. The glyph symbol replaces placeholders within the glyph_format. For example, if the glyph_symbol is the solid circle corresponding to Unicode U+25cf code point and the glyph_format is `%0`, the rendered glyph would be the solid circle. + "glyphType": "A String", # The type of glyph used by bullets when paragraphs at this level of nesting are ordered. The glyph type determines the type of glyph used to replace placeholders within the glyph_format when paragraphs at this level of nesting are ordered. For example, if the nesting level is 0, the glyph_format is `%0.` and the glyph type is DECIMAL, then the rendered glyph would replace the placeholder `%0` in the glyph format with a number corresponding to list item's order within the list. + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of paragraphs at this level of nesting. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for paragraphs at this level of nesting. Applied to the side that corresponds to the start of the text, based on the paragraph's content direction. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "startNumber": 42, # The number of the first list item at this nesting level. A value of 0 is treated as a value of 1 for lettered lists and Roman numeral lists. For values of both 0 and 1, lettered and Roman numeral lists will begin at `a` and `i` respectively. This value is ignored for nesting levels with unordered glyphs. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of bullets at this level of nesting. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. @@ -13173,8 +18019,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -13186,17 +18041,31 @@

Method Details

}, }, }, - "inlineObjectElement": { # A ParagraphElement that contains an InlineObject. # An inline object paragraph element. - "inlineObjectId": "A String", # The ID of the InlineObject this element contains. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. An InlineObjectElement may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this InlineObject, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + ], + }, + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this list. + "A String", + ], + "suggestedInsertionId": "A String", # The suggested insertion ID. If empty, then this is not a suggested insertion. + "suggestedListPropertiesChanges": { # The suggested changes to the list properties, keyed by suggestion ID. + "a_key": { # A suggested change to ListProperties. + "listProperties": { # The properties of a list that describe the look and feel of bullets belonging to paragraphs associated with a list. # A ListProperties that only includes the changes made in this suggestion. This can be used along with the list_properties_suggestion_state to see which fields have changed and their new values. + "nestingLevels": [ # Describes the properties of the bullets at the associated level. A list has at most 9 levels of nesting with nesting level 0 corresponding to the top-most level and nesting level 8 corresponding to the most nested level. The nesting levels are returned in ascending order with the least nested returned first. + { # Contains properties describing the look and feel of a list bullet at a given level of nesting. + "bulletAlignment": "A String", # The alignment of the bullet within the space allotted for rendering the bullet. + "glyphFormat": "A String", # The format string used by bullets at this level of nesting. The glyph format contains one or more placeholders, and these placeholders are replaced with the appropriate values depending on the glyph_type or glyph_symbol. The placeholders follow the pattern `%[nesting_level]`. Furthermore, placeholders can have prefixes and suffixes. Thus, the glyph format follows the pattern `%[nesting_level]`. Note that the prefix and suffix are optional and can be arbitrary strings. For example, the glyph format `%0.` indicates that the rendered glyph will replace the placeholder with the corresponding glyph for nesting level 0 followed by a period as the suffix. So a list with a glyph type of UPPER_ALPHA and glyph format `%0.` at nesting level 0 will result in a list with rendered glyphs `A.` `B.` `C.` The glyph format can contain placeholders for the current nesting level as well as placeholders for parent nesting levels. For example, a list can have a glyph format of `%0.` at nesting level 0 and a glyph format of `%0.%1.` at nesting level 1. Assuming both nesting levels have DECIMAL glyph types, this would result in a list with rendered glyphs `1.` `2.` ` 2.1.` ` 2.2.` `3.` For nesting levels that are ordered, the string that replaces a placeholder in the glyph format for a particular paragraph depends on the paragraph's order within the list. + "glyphSymbol": "A String", # A custom glyph symbol used by bullets when paragraphs at this level of nesting are unordered. The glyph symbol replaces placeholders within the glyph_format. For example, if the glyph_symbol is the solid circle corresponding to Unicode U+25cf code point and the glyph_format is `%0`, the rendered glyph would be the solid circle. + "glyphType": "A String", # The type of glyph used by bullets when paragraphs at this level of nesting are ordered. The glyph type determines the type of glyph used to replace placeholders within the glyph_format when paragraphs at this level of nesting are ordered. For example, if the nesting level is 0, the glyph_format is `%0.` and the glyph type is DECIMAL, then the rendered glyph would replace the placeholder `%0` in the glyph format with a number corresponding to list item's order within the list. + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of paragraphs at this level of nesting. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for paragraphs at this level of nesting. Applied to the side that corresponds to the start of the text, based on the paragraph's content direction. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "startNumber": 42, # The number of the first list item at this nesting level. A value of 0 is treated as a value of 1 for lettered lists and Roman numeral lists. For values of both 0 and 1, lettered and Roman numeral lists will begin at `a` and `i` respectively. This value is ignored for nesting levels with unordered glyphs. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of bullets at this level of nesting. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. @@ -13223,8 +18092,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -13235,7 +18113,20 @@

Method Details

"weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + }, + ], + }, + "listPropertiesSuggestionState": { # A mask that indicates which of the fields on the base ListProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base ListProperties have been changed in this suggestion. + "nestingLevelsSuggestionStates": [ # A mask that indicates which of the fields on the corresponding NestingLevel in nesting_levels have been changed in this suggestion. The nesting level suggestion states are returned in ascending order of the nesting level with the least nested returned first. + { # A mask that indicates which of the fields on the base NestingLevel have been changed in this suggestion. For any field set to true, there's a new suggested value. + "bulletAlignmentSuggested": True or False, # Indicates if there was a suggested change to bullet_alignment. + "glyphFormatSuggested": True or False, # Indicates if there was a suggested change to glyph_format. + "glyphSymbolSuggested": True or False, # Indicates if there was a suggested change to glyph_symbol. + "glyphTypeSuggested": True or False, # Indicates if there was a suggested change to glyph_type. + "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line. + "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start. + "startNumberSuggested": True or False, # Indicates if there was a suggested change to start_number. + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion. "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. "boldSuggested": True or False, # Indicates if there was a suggested change to bold. @@ -13249,433 +18140,712 @@

Method Details

"weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. }, }, + ], + }, + }, + }, + }, + }, + "namedRanges": { # The named ranges in the document tab, keyed by name. + "a_key": { # A collection of all the NamedRanges in the document that share a given name. + "name": "A String", # The name that all the named ranges share. + "namedRanges": [ # The NamedRanges that share the same name. + { # A collection of Ranges with the same named range ID. Named ranges allow developers to associate parts of a document with an arbitrary user-defined label so their contents can be programmatically read or edited later. A document can contain multiple named ranges with the same name, but every named range has a unique ID. A named range is created with a single Range, and content inserted inside a named range generally expands that range. However, certain document changes can cause the range to be split into multiple ranges. Named ranges are not private. All applications and collaborators that have access to the document can see its named ranges. + "name": "A String", # The name of the named range. + "namedRangeId": "A String", # The ID of the named range. + "ranges": [ # The ranges that belong to this named range. + { # Specifies a contiguous range of text. + "endIndex": 42, # The zero-based end index of this range, exclusive, in UTF-16 code units. In all current uses, an end index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges. + "segmentId": "A String", # The ID of the header, footer, or footnote that this range is contained in. An empty segment ID signifies the document's body. + "startIndex": 42, # The zero-based start index of this range, in UTF-16 code units. In all current uses, a start index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges. + "tabId": "A String", # The tab that contains this range. When omitted, the request applies to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this InlineObjectElement. Similar to text content, like text runs and footnote references, the text style of an inline object element can affect content layout as well as the styling of text inserted next to it. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + ], + }, + ], + }, + }, + "namedStyles": { # The named styles. Paragraphs in the document can inherit their TextStyle and ParagraphStyle from these named styles. # The named styles of the document tab. + "styles": [ # The named styles. There's an entry for each of the possible named style types. + { # A named style. Paragraphs in the document can inherit their TextStyle and ParagraphStyle from this named style when they have the same named style type. + "namedStyleType": "A String", # The type of this named style. + "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph style of this named style. + "alignment": "A String", # The text alignment for this paragraph. + "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. + "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - "pageBreak": { # A ParagraphElement representing a page break. A page break makes the subsequent text start at the top of the next page. # A page break paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A PageBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this PageBreak, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, + "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this PageBreak. Similar to text content, like text runs and footnote references, the text style of a page break can affect content layout as well as the styling of text inserted next to it. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. + "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. + "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. + "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. + "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. + "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. + "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. + "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + }, + }, + "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spacingMode": "A String", # The spacing mode for the paragraph. + "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. + { # A tab stop within a paragraph. + "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. + "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + ], + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this named style. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, }, - "person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address. - "personId": "A String", # Output only. The unique ID of this link. - "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present. - "email": "A String", # Output only. The email address linked to this Person. This field is always present. - "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address. + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, - "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. - "A String", - ], - "suggestedInsertionIds": [ # IDs for suggestions that insert this person link into the document. A Person might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this Person, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + ], + }, + "positionedObjects": { # The positioned objects in the document tab, keyed by object ID. + "a_key": { # An object that's tethered to a Paragraph and positioned relative to the beginning of the paragraph. A PositionedObject contains an EmbeddedObject such as an image. + "objectId": "A String", # The ID of this positioned object. + "positionedObjectProperties": { # Properties of a PositionedObject. # The properties of this positioned object. + "embeddedObject": { # An embedded object in the document. # The embedded object of this positioned object. + "description": "A String", # The description of the embedded object. The `title` and `description` are both combined to display alt text. + "embeddedDrawingProperties": { # The properties of an embedded drawing and used to differentiate the object type. An embedded drawing is one that's created and edited within a document. Note that extensive details are not supported. # The properties of an embedded drawing. + }, + "embeddedObjectBorder": { # A border around an EmbeddedObject. # The border of the embedded object. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "propertyState": "A String", # The property state of the border property. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "imageProperties": { # The properties of an image. # The properties of an image. + "angle": 3.14, # The clockwise rotation angle of the image, in radians. + "brightness": 3.14, # The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. + "contentUri": "A String", # A URI to the image with a default lifetime of 30 minutes. This URI is tagged with the account of the requester. Anyone with the URI effectively accesses the image as the original requester. Access to the image may be lost if the document's sharing settings change. + "contrast": 3.14, # The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. + "cropProperties": { # The crop properties of an image. The crop rectangle is represented using fractional offsets from the original content's 4 edges. - If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the image's original bounding rectangle. - If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the image's original bounding rectangle. - If all offsets and rotation angle are 0, the image is not cropped. # The crop properties of the image. + "angle": 3.14, # The clockwise rotation angle of the crop rectangle around its center, in radians. Rotation is applied after the offsets. + "offsetBottom": 3.14, # The offset specifies how far inwards the bottom edge of the crop rectangle is from the bottom edge of the original content as a fraction of the original content's height. + "offsetLeft": 3.14, # The offset specifies how far inwards the left edge of the crop rectangle is from the left edge of the original content as a fraction of the original content's width. + "offsetRight": 3.14, # The offset specifies how far inwards the right edge of the crop rectangle is from the right edge of the original content as a fraction of the original content's width. + "offsetTop": 3.14, # The offset specifies how far inwards the top edge of the crop rectangle is from the top edge of the original content as a fraction of the original content's height. + }, + "sourceUri": "A String", # The source URI is the URI used to insert the image. The source URI can be empty. + "transparency": 3.14, # The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means transparent. + }, + "linkedContentReference": { # A reference to the external linked source content. # A reference to the external linked source content. For example, it contains a reference to the source Google Sheets chart when the embedded object is a linked chart. If unset, then the embedded object is not linked. + "sheetsChartReference": { # A reference to a linked chart embedded from Google Sheets. # A reference to the linked chart. + "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that's embedded. + "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart. + }, + }, + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginLeft": { # A magnitude in a single direction in the specified units. # The left margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginRight": { # A magnitude in a single direction in the specified units. # The right margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginTop": { # A magnitude in a single direction in the specified units. # The top margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "size": { # A width and height. # The visible size of the image after cropping. + "height": { # A magnitude in a single direction in the specified units. # The height of the object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "title": "A String", # The title of the embedded object. The `title` and `description` are both combined to display alt text. + }, + "positioning": { # The positioning of a PositionedObject. The positioned object is positioned relative to the beginning of the Paragraph it's tethered to. # The positioning of this positioned object relative to the newline of the Paragraph that references this positioned object. + "layout": "A String", # The layout of this positioned object. + "leftOffset": { # A magnitude in a single direction in the specified units. # The offset of the left edge of the positioned object relative to the beginning of the Paragraph it's tethered to. The exact positioning of the object can depend on other content in the document and the document's styling. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "topOffset": { # A magnitude in a single direction in the specified units. # The offset of the top edge of the positioned object relative to the beginning of the Paragraph it's tethered to. The exact positioning of the object can depend on other content in the document and the document's styling. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + }, + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionId": "A String", # The suggested insertion ID. If empty, then this is not a suggested insertion. + "suggestedPositionedObjectPropertiesChanges": { # The suggested changes to the positioned object properties, keyed by suggestion ID. + "a_key": { # A suggested change to PositionedObjectProperties. + "positionedObjectProperties": { # Properties of a PositionedObject. # A PositionedObjectProperties that only includes the changes made in this suggestion. This can be used along with the positioned_object_properties_suggestion_state to see which fields have changed and their new values. + "embeddedObject": { # An embedded object in the document. # The embedded object of this positioned object. + "description": "A String", # The description of the embedded object. The `title` and `description` are both combined to display alt text. + "embeddedDrawingProperties": { # The properties of an embedded drawing and used to differentiate the object type. An embedded drawing is one that's created and edited within a document. Note that extensive details are not supported. # The properties of an embedded drawing. + }, + "embeddedObjectBorder": { # A border around an EmbeddedObject. # The border of the embedded object. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + "dashStyle": "A String", # The dash style of the border. + "propertyState": "A String", # The property state of the border property. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this Person. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + "imageProperties": { # The properties of an image. # The properties of an image. + "angle": 3.14, # The clockwise rotation angle of the image, in radians. + "brightness": 3.14, # The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. + "contentUri": "A String", # A URI to the image with a default lifetime of 30 minutes. This URI is tagged with the account of the requester. Anyone with the URI effectively accesses the image as the original requester. Access to the image may be lost if the document's sharing settings change. + "contrast": 3.14, # The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. + "cropProperties": { # The crop properties of an image. The crop rectangle is represented using fractional offsets from the original content's 4 edges. - If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the image's original bounding rectangle. - If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the image's original bounding rectangle. - If all offsets and rotation angle are 0, the image is not cropped. # The crop properties of the image. + "angle": 3.14, # The clockwise rotation angle of the crop rectangle around its center, in radians. Rotation is applied after the offsets. + "offsetBottom": 3.14, # The offset specifies how far inwards the bottom edge of the crop rectangle is from the bottom edge of the original content as a fraction of the original content's height. + "offsetLeft": 3.14, # The offset specifies how far inwards the left edge of the crop rectangle is from the left edge of the original content as a fraction of the original content's width. + "offsetRight": 3.14, # The offset specifies how far inwards the right edge of the crop rectangle is from the right edge of the original content as a fraction of the original content's width. + "offsetTop": 3.14, # The offset specifies how far inwards the top edge of the crop rectangle is from the top edge of the original content as a fraction of the original content's height. }, + "sourceUri": "A String", # The source URI is the URI used to insert the image. The source URI can be empty. + "transparency": 3.14, # The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means transparent. }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "linkedContentReference": { # A reference to the external linked source content. # A reference to the external linked source content. For example, it contains a reference to the source Google Sheets chart when the embedded object is a linked chart. If unset, then the embedded object is not linked. + "sheetsChartReference": { # A reference to a linked chart embedded from Google Sheets. # A reference to the linked chart. + "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that's embedded. + "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart. + }, + }, + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom margin of the embedded object. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + "marginLeft": { # A magnitude in a single direction in the specified units. # The left margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginRight": { # A magnitude in a single direction in the specified units. # The right margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginTop": { # A magnitude in a single direction in the specified units. # The top margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "size": { # A width and height. # The visible size of the image after cropping. + "height": { # A magnitude in a single direction in the specified units. # The height of the object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. + "title": "A String", # The title of the embedded object. The `title` and `description` are both combined to display alt text. + }, + "positioning": { # The positioning of a PositionedObject. The positioned object is positioned relative to the beginning of the Paragraph it's tethered to. # The positioning of this positioned object relative to the newline of the Paragraph that references this positioned object. + "layout": "A String", # The layout of this positioned object. + "leftOffset": { # A magnitude in a single direction in the specified units. # The offset of the left edge of the positioned object relative to the beginning of the Paragraph it's tethered to. The exact positioning of the object can depend on other content in the document and the document's styling. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "topOffset": { # A magnitude in a single direction in the specified units. # The offset of the top edge of the positioned object relative to the beginning of the Paragraph it's tethered to. The exact positioning of the object can depend on other content in the document and the document's styling. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, }, }, - "richLink": { # A link to a Google resource (such as a file in Drive, a YouTube video, or a Calendar event). # A paragraph element that links to a Google resource (such as a file in Google Drive, a YouTube video, or a Calendar event.) - "richLinkId": "A String", # Output only. The ID of this link. - "richLinkProperties": { # Properties specific to a RichLink. # Output only. The properties of this RichLink. This field is always present. - "mimeType": "A String", # Output only. The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the RichLink, if there's one (for example, when it's a file in Drive). - "title": "A String", # Output only. The title of the RichLink as displayed in the link. This title matches the title of the linked resource at the time of the insertion or last update of the link. This field is always present. - "uri": "A String", # Output only. The URI to the RichLink. This is always present. - }, - "suggestedDeletionIds": [ # IDs for suggestions that remove this link from the document. A RichLink might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. - "A String", - ], - "suggestedInsertionIds": [ # IDs for suggestions that insert this link into the document. A RichLink might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this RichLink, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, + "positionedObjectPropertiesSuggestionState": { # A mask that indicates which of the fields on the base PositionedObjectProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base PositionedObjectProperties have been changed in this suggestion. + "embeddedObjectSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedObject have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_object have been changed in this suggestion. + "descriptionSuggested": True or False, # Indicates if there was a suggested change to description. + "embeddedDrawingPropertiesSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedDrawingProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_drawing_properties have been changed in this suggestion. + }, + "embeddedObjectBorderSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedObjectBorder have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_object_border have been changed in this suggestion. + "colorSuggested": True or False, # Indicates if there was a suggested change to color. + "dashStyleSuggested": True or False, # Indicates if there was a suggested change to dash_style. + "propertyStateSuggested": True or False, # Indicates if there was a suggested change to property_state. + "widthSuggested": True or False, # Indicates if there was a suggested change to width. + }, + "imagePropertiesSuggestionState": { # A mask that indicates which of the fields on the base ImageProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in image_properties have been changed in this suggestion. + "angleSuggested": True or False, # Indicates if there was a suggested change to angle. + "brightnessSuggested": True or False, # Indicates if there was a suggested change to brightness. + "contentUriSuggested": True or False, # Indicates if there was a suggested change to content_uri. + "contrastSuggested": True or False, # Indicates if there was a suggested change to contrast. + "cropPropertiesSuggestionState": { # A mask that indicates which of the fields on the base CropProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in crop_properties have been changed in this suggestion. + "angleSuggested": True or False, # Indicates if there was a suggested change to angle. + "offsetBottomSuggested": True or False, # Indicates if there was a suggested change to offset_bottom. + "offsetLeftSuggested": True or False, # Indicates if there was a suggested change to offset_left. + "offsetRightSuggested": True or False, # Indicates if there was a suggested change to offset_right. + "offsetTopSuggested": True or False, # Indicates if there was a suggested change to offset_top. }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + "sourceUriSuggested": True or False, # Indicates if there was a suggested change to source_uri. + "transparencySuggested": True or False, # Indicates if there was a suggested change to transparency. + }, + "linkedContentReferenceSuggestionState": { # A mask that indicates which of the fields on the base LinkedContentReference have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in linked_content_reference have been changed in this suggestion. + "sheetsChartReferenceSuggestionState": { # A mask that indicates which of the fields on the base SheetsChartReference have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in sheets_chart_reference have been changed in this suggestion. + "chartIdSuggested": True or False, # Indicates if there was a suggested change to chart_id. + "spreadsheetIdSuggested": True or False, # Indicates if there was a suggested change to spreadsheet_id. }, }, + "marginBottomSuggested": True or False, # Indicates if there was a suggested change to margin_bottom. + "marginLeftSuggested": True or False, # Indicates if there was a suggested change to margin_left. + "marginRightSuggested": True or False, # Indicates if there was a suggested change to margin_right. + "marginTopSuggested": True or False, # Indicates if there was a suggested change to margin_top. + "sizeSuggestionState": { # A mask that indicates which of the fields on the base Size have been changed in this suggestion. For any field set to true, the Size has a new suggested value. # A mask that indicates which of the fields in size have been changed in this suggestion. + "heightSuggested": True or False, # Indicates if there was a suggested change to height. + "widthSuggested": True or False, # Indicates if there was a suggested change to width. + }, + "titleSuggested": True or False, # Indicates if there was a suggested change to title. }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this RichLink. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "positioningSuggestionState": { # A mask that indicates which of the fields on the base PositionedObjectPositioning have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in positioning have been changed in this suggestion. + "layoutSuggested": True or False, # Indicates if there was a suggested change to layout. + "leftOffsetSuggested": True or False, # Indicates if there was a suggested change to left_offset. + "topOffsetSuggested": True or False, # Indicates if there was a suggested change to top_offset. + }, + }, + }, + }, + }, + }, + "suggestedDocumentStyleChanges": { # The suggested changes to the style of the document tab, keyed by suggestion ID. + "a_key": { # A suggested change to the DocumentStyle. + "documentStyle": { # The style of the document. # A DocumentStyle that only includes the changes made in this suggestion. This can be used along with the document_style_suggestion_state to see which fields have changed and their new values. + "background": { # Represents the background of a document. # The background of the document. Documents cannot have a transparent background color. + "color": { # A color that can either be fully opaque or fully transparent. # The background color. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + }, + "defaultFooterId": "A String", # The ID of the default footer. If not set, there's no default footer. This property is read-only. + "defaultHeaderId": "A String", # The ID of the default header. If not set, there's no default header. This property is read-only. + "evenPageFooterId": "A String", # The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. This property is read-only. + "evenPageHeaderId": "A String", # The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. This property is read-only. + "firstPageFooterId": "A String", # The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. This property is read-only. + "firstPageHeaderId": "A String", # The ID of the header used only for the first page. If not set then a unique header for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_header_id or this value for the header on the first page. If not set, there's no first page header. This property is read-only. + "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of the page_size, which allows changing the page orientation between portrait and landscape. + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin. Updating the bottom page margin on the document style clears the bottom page margin on all section styles. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginFooter": { # A magnitude in a single direction in the specified units. # The amount of space between the bottom of the page and the contents of the footer. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginHeader": { # A magnitude in a single direction in the specified units. # The amount of space between the top of the page and the contents of the header. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin. Updating the left page margin on the document style clears the left page margin on all section styles. It may also cause columns to resize in all sections. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin. Updating the right page margin on the document style clears the right page margin on all section styles. It may also cause columns to resize in all sections. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin. Updating the top page margin on the document style clears the top page margin on all section styles. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "pageNumberStart": 42, # The page number from which to start counting the number of pages. + "pageSize": { # A width and height. # The size of a page in the document. + "height": { # A magnitude in a single direction in the specified units. # The height of the object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "useCustomHeaderFooterMargins": True or False, # Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected. When false, the default values in the Docs editor for header and footer margin are used. This property is read-only. + "useEvenPageHeaderFooter": True or False, # Indicates whether to use the even page header / footer IDs for the even pages. + "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page. + }, + "documentStyleSuggestionState": { # A mask that indicates which of the fields on the base DocumentStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DocumentStyle have been changed in this suggestion. + "backgroundSuggestionState": { # A mask that indicates which of the fields on the base Background have been changed in this suggestion. For any field set to true, the Backgound has a new suggested value. # A mask that indicates which of the fields in background have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates whether the current background color has been modified in this suggestion. + }, + "defaultFooterIdSuggested": True or False, # Indicates if there was a suggested change to default_footer_id. + "defaultHeaderIdSuggested": True or False, # Indicates if there was a suggested change to default_header_id. + "evenPageFooterIdSuggested": True or False, # Indicates if there was a suggested change to even_page_footer_id. + "evenPageHeaderIdSuggested": True or False, # Indicates if there was a suggested change to even_page_header_id. + "firstPageFooterIdSuggested": True or False, # Indicates if there was a suggested change to first_page_footer_id. + "firstPageHeaderIdSuggested": True or False, # Indicates if there was a suggested change to first_page_header_id. + "flipPageOrientationSuggested": True or False, # Optional. Indicates if there was a suggested change to flip_page_orientation. + "marginBottomSuggested": True or False, # Indicates if there was a suggested change to margin_bottom. + "marginFooterSuggested": True or False, # Indicates if there was a suggested change to margin_footer. + "marginHeaderSuggested": True or False, # Indicates if there was a suggested change to margin_header. + "marginLeftSuggested": True or False, # Indicates if there was a suggested change to margin_left. + "marginRightSuggested": True or False, # Indicates if there was a suggested change to margin_right. + "marginTopSuggested": True or False, # Indicates if there was a suggested change to margin_top. + "pageNumberStartSuggested": True or False, # Indicates if there was a suggested change to page_number_start. + "pageSizeSuggestionState": { # A mask that indicates which of the fields on the base Size have been changed in this suggestion. For any field set to true, the Size has a new suggested value. # A mask that indicates which of the fields in size have been changed in this suggestion. + "heightSuggested": True or False, # Indicates if there was a suggested change to height. + "widthSuggested": True or False, # Indicates if there was a suggested change to width. + }, + "useCustomHeaderFooterMarginsSuggested": True or False, # Indicates if there was a suggested change to use_custom_header_footer_margins. + "useEvenPageHeaderFooterSuggested": True or False, # Indicates if there was a suggested change to use_even_page_header_footer. + "useFirstPageHeaderFooterSuggested": True or False, # Indicates if there was a suggested change to use_first_page_header_footer. + }, + }, + }, + "suggestedNamedStylesChanges": { # The suggested changes to the named styles of the document tab, keyed by suggestion ID. + "a_key": { # A suggested change to the NamedStyles. + "namedStyles": { # The named styles. Paragraphs in the document can inherit their TextStyle and ParagraphStyle from these named styles. # A NamedStyles that only includes the changes made in this suggestion. This can be used along with the named_styles_suggestion_state to see which fields have changed and their new values. + "styles": [ # The named styles. There's an entry for each of the possible named style types. + { # A named style. Paragraphs in the document can inherit their TextStyle and ParagraphStyle from this named style when they have the same named style type. + "namedStyleType": "A String", # The type of this named style. + "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph style of this named style. + "alignment": "A String", # The text alignment for this paragraph. + "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. + "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. + "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - }, - }, - "startIndex": 42, # The zero-based start index of this paragraph element, in UTF-16 code units. - "textRun": { # A ParagraphElement that represents a run of text that all has the same styling. # A text run paragraph element. - "content": "A String", # The text of this run. Any non-text elements in the run are replaced with the Unicode character U+E907. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A TextRun may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this run, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. + "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. + "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. + "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. + "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. + "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. + "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. + "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + }, + }, + "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spacingMode": "A String", # The spacing mode for the paragraph. + "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. + { # A tab stop within a paragraph. + "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. + "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. }, - }, + ], }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this run. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this named style. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. @@ -13702,8 +18872,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -13715,211 +18894,37 @@

Method Details

}, }, }, - }, - ], - "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The style of this paragraph. - "alignment": "A String", # The text alignment for this paragraph. - "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. - "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. - "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. - "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. - "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. - "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. - "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. - "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. - "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - }, - "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "spacingMode": "A String", # The spacing mode for the paragraph. - "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. - { # A tab stop within a paragraph. - "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. - "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, ], }, - "positionedObjectIds": [ # The IDs of the positioned objects tethered to this paragraph. - "A String", - ], - "suggestedBulletChanges": { # The suggested changes to this paragraph's bullet. - "a_key": { # A suggested change to a Bullet. - "bullet": { # Describes the bullet of a paragraph. # A Bullet that only includes the changes made in this suggestion. This can be used along with the bullet_suggestion_state to see which fields have changed and their new values. - "listId": "A String", # The ID of the list this paragraph belongs to. - "nestingLevel": 42, # The nesting level of this paragraph in the list. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, + "namedStylesSuggestionState": { # The suggestion state of a NamedStyles message. # A mask that indicates which of the fields on the base NamedStyles have been changed in this suggestion. + "stylesSuggestionStates": [ # A mask that indicates which of the fields on the corresponding NamedStyle in styles have been changed in this suggestion. The order of these named style suggestion states matches the order of the corresponding named style within the named styles suggestion. + { # A suggestion state of a NamedStyle message. + "namedStyleType": "A String", # The named style type that this suggestion state corresponds to. This field is provided as a convenience for matching the NamedStyleSuggestionState with its corresponding NamedStyle. + "paragraphStyleSuggestionState": { # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in paragraph style have been changed in this suggestion. + "alignmentSuggested": True or False, # Indicates if there was a suggested change to alignment. + "avoidWidowAndOrphanSuggested": True or False, # Indicates if there was a suggested change to avoid_widow_and_orphan. + "borderBetweenSuggested": True or False, # Indicates if there was a suggested change to border_between. + "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. + "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. + "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. + "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. + "directionSuggested": True or False, # Indicates if there was a suggested change to direction. + "headingIdSuggested": True or False, # Indicates if there was a suggested change to heading_id. + "indentEndSuggested": True or False, # Indicates if there was a suggested change to indent_end. + "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line. + "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start. + "keepLinesTogetherSuggested": True or False, # Indicates if there was a suggested change to keep_lines_together. + "keepWithNextSuggested": True or False, # Indicates if there was a suggested change to keep_with_next. + "lineSpacingSuggested": True or False, # Indicates if there was a suggested change to line_spacing. + "namedStyleTypeSuggested": True or False, # Indicates if there was a suggested change to named_style_type. + "pageBreakBeforeSuggested": True or False, # Indicates if there was a suggested change to page_break_before. + "shadingSuggestionState": { # A mask that indicates which of the fields on the base Shading have been changed in this suggested change. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in shading have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to the Shading. + }, + "spaceAboveSuggested": True or False, # Indicates if there was a suggested change to space_above. + "spaceBelowSuggested": True or False, # Indicates if there was a suggested change to space_below. + "spacingModeSuggested": True or False, # Indicates if there was a suggested change to spacing_mode. }, - }, - "bulletSuggestionState": { # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. - "listIdSuggested": True or False, # Indicates if there was a suggested change to the list_id. - "nestingLevelSuggested": True or False, # Indicates if there was a suggested change to the nesting_level. "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion. "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. @@ -13934,417 +18939,477 @@

Method Details

"weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. }, }, - }, + ], }, - "suggestedParagraphStyleChanges": { # The suggested paragraph style changes to this paragraph, keyed by suggestion ID. - "a_key": { # A suggested change to a ParagraphStyle. - "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A ParagraphStyle that only includes the changes made in this suggestion. This can be used along with the paragraph_style_suggestion_state to see which fields have changed and their new values. - "alignment": "A String", # The text alignment for this paragraph. - "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. - "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, + }, + }, + }, + "tabProperties": { # Properties of a tab. # The properties of the tab, like ID and title. + "index": 42, # The index of the tab within the parent. + "nestingLevel": 42, # Output only. The depth of the tab within the document. Root-level tabs start at 0. + "parentTabId": "A String", # Optional. The ID of the parent tab. Empty when the current tab is a root-level tab, which means it doesn't have any parents. + "tabId": "A String", # Output only. The ID of the tab. This field can't be changed. + "title": "A String", # The user-visible name of the tab. + }, + }, + ], + "title": "A String", # The title of the document. +} + + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # A Google Docs document. + "body": { # The document body. The body typically contains the full document contents except for headers, footers, and footnotes. # Output only. The main body of the document. + "content": [ # The contents of the body. The indexes for the body's content begin at zero. + { # A StructuralElement describes content that provides structure to the document. + "endIndex": 42, # The zero-based end index of this structural element, exclusive, in UTF-16 code units. + "paragraph": { # A StructuralElement representing a paragraph. A paragraph is a range of content that's terminated with a newline character. # A paragraph type of structural element. + "bullet": { # Describes the bullet of a paragraph. # The bullet for this paragraph. If not present, the paragraph does not belong to a list. + "listId": "A String", # The ID of the list this paragraph belongs to. + "nestingLevel": 42, # The nesting level of this paragraph in the list. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, - "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, - "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "elements": [ # The content of the paragraph, broken down into its component parts. + { # A ParagraphElement describes content within a Paragraph. + "autoText": { # A ParagraphElement representing a spot in the text that's dynamically replaced with content that can change over time, like a page number. # An auto text paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. An AutoText may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this AutoText, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. }, }, - "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. - "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. - "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. - "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. - "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. - "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. - "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. - "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this AutoText. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, }, - "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "spacingMode": "A String", # The spacing mode for the paragraph. - "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. - { # A tab stop within a paragraph. - "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. - "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - ], - }, - "paragraphStyleSuggestionState": { # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. - "alignmentSuggested": True or False, # Indicates if there was a suggested change to alignment. - "avoidWidowAndOrphanSuggested": True or False, # Indicates if there was a suggested change to avoid_widow_and_orphan. - "borderBetweenSuggested": True or False, # Indicates if there was a suggested change to border_between. - "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. - "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. - "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. - "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. - "directionSuggested": True or False, # Indicates if there was a suggested change to direction. - "headingIdSuggested": True or False, # Indicates if there was a suggested change to heading_id. - "indentEndSuggested": True or False, # Indicates if there was a suggested change to indent_end. - "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line. - "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start. - "keepLinesTogetherSuggested": True or False, # Indicates if there was a suggested change to keep_lines_together. - "keepWithNextSuggested": True or False, # Indicates if there was a suggested change to keep_with_next. - "lineSpacingSuggested": True or False, # Indicates if there was a suggested change to line_spacing. - "namedStyleTypeSuggested": True or False, # Indicates if there was a suggested change to named_style_type. - "pageBreakBeforeSuggested": True or False, # Indicates if there was a suggested change to page_break_before. - "shadingSuggestionState": { # A mask that indicates which of the fields on the base Shading have been changed in this suggested change. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in shading have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to the Shading. }, - "spaceAboveSuggested": True or False, # Indicates if there was a suggested change to space_above. - "spaceBelowSuggested": True or False, # Indicates if there was a suggested change to space_below. - "spacingModeSuggested": True or False, # Indicates if there was a suggested change to spacing_mode. + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, }, + "type": "A String", # The type of this auto text. }, - }, - "suggestedPositionedObjectIds": { # The IDs of the positioned objects suggested to be attached to this paragraph, keyed by suggestion ID. - "a_key": { # A collection of object IDs. - "objectIds": [ # The object IDs. + "columnBreak": { # A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column. # A column break paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. "A String", ], - }, - }, - }, - "sectionBreak": { # A StructuralElement representing a section break. A section is a range of content that has the same SectionStyle. A section break represents the start of a new section, and the section style applies to the section after the section break. The document body always begins with a section break. # A section break type of structural element. - "sectionStyle": { # The styling that applies to a section. # The style of the section after this section break. - "columnProperties": [ # The section's columns properties. If empty, the section contains one column with the default properties in the Docs editor. A section can be updated to have no more than 3 columns. When updating this property, setting a concrete value is required. Unsetting this property will result in a 400 bad request error. - { # Properties that apply to a section's column. - "paddingEnd": { # A magnitude in a single direction in the specified units. # The padding at the end of the column. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "suggestedInsertionIds": [ # The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this ColumnBreak, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, }, - "width": { # A magnitude in a single direction in the specified units. # Output only. The width of the column. + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, }, - ], - "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only. - "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only. - "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only. - "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only. - "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only. - "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only. - "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. }, - "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "endIndex": 42, # The zero-base end index of this paragraph element, exclusive, in UTF-16 code units. + "equation": { # A ParagraphElement representing an equation. # An equation paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. An Equation may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], }, - "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "sectionType": "A String", # Output only. The type of section. - "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - }, - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A SectionBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - }, - "startIndex": 42, # The zero-based start index of this structural element, in UTF-16 code units. - "table": { # A StructuralElement representing a table. # A table type of structural element. - "columns": 42, # Number of columns in the table. It's possible for a table to be non-rectangular, so some rows may have a different number of cells. - "rows": 42, # Number of rows in the table. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A Table may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "tableRows": [ # The contents and style of each row. - { # The contents and style of a row in a Table. - "endIndex": 42, # The zero-based end index of this row, exclusive, in UTF-16 code units. - "startIndex": 42, # The zero-based start index of this row, in UTF-16 code units. + "footnoteReference": { # A ParagraphElement representing a footnote reference. A footnote reference is the inline content rendered with a number and is used to identify the footnote. # A footnote reference paragraph element. + "footnoteId": "A String", # The ID of the footnote that contains the content of this footnote reference. + "footnoteNumber": "A String", # The rendered number of this footnote. "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. "A String", ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A TableRow may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "suggestedInsertionIds": [ # The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. "A String", ], - "suggestedTableRowStyleChanges": { # The suggested style changes to this row, keyed by suggestion ID. - "a_key": { # A suggested change to a TableRowStyle. - "tableRowStyle": { # Styles that apply to a table row. # A TableRowStyle that only includes the changes made in this suggestion. This can be used along with the table_row_style_suggestion_state to see which fields have changed and their new values. - "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. + "suggestedTextStyleChanges": { # The suggested text style changes to this FootnoteReference, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries. - "tableHeader": True or False, # Whether the row is a table header. + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, }, - "tableRowStyleSuggestionState": { # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. - "minRowHeightSuggested": True or False, # Indicates if there was a suggested change to min_row_height. + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. }, }, }, - "tableCells": [ # The contents and style of each cell in this row. It's possible for a table to be non-rectangular, so some rows may have a different number of cells than other rows in the same table. - { # The contents and style of a cell in a Table. - "content": [ # The content of the cell. - # Object with schema name: StructuralElement - ], - "endIndex": 42, # The zero-based end index of this cell, exclusive, in UTF-16 code units. - "startIndex": 42, # The zero-based start index of this cell, in UTF-16 code units. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A TableCell may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTableCellStyleChanges": { # The suggested changes to the table cell style, keyed by suggestion ID. - "a_key": { # A suggested change to a TableCellStyle. - "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # A TableCellStyle that only includes the changes made in this suggestion. This can be used along with the table_cell_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "columnSpan": 42, # The column span of the cell. This property is read-only. - "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. - "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "rowSpan": 42, # The row span of the cell. This property is read-only. - }, - "tableCellStyleSuggestionState": { # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. - "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. - "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. - "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. - "columnSpanSuggested": True or False, # Indicates if there was a suggested change to column_span. - "contentAlignmentSuggested": True or False, # Indicates if there was a suggested change to content_alignment. - "paddingBottomSuggested": True or False, # Indicates if there was a suggested change to padding_bottom. - "paddingLeftSuggested": True or False, # Indicates if there was a suggested change to padding_left. - "paddingRightSuggested": True or False, # Indicates if there was a suggested change to padding_right. - "paddingTopSuggested": True or False, # Indicates if there was a suggested change to padding_top. - "rowSpanSuggested": True or False, # Indicates if there was a suggested change to row_span. - }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this FootnoteReference. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # The style of the cell. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell. + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "horizontalRule": { # A ParagraphElement representing a horizontal line. # A horizontal rule paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A HorizontalRule may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this HorizontalRule, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -14353,1382 +19418,1366 @@

Method Details

}, }, }, - "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, }, - "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. }, - "columnSpan": 42, # The column span of the cell. This property is read-only. - "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. - "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, - "rowSpan": 42, # The row span of the cell. This property is read-only. + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. }, }, - ], - "tableRowStyle": { # Styles that apply to a table row. # The style of the table row. - "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries. - "tableHeader": True or False, # Whether the row is a table header. }, - }, - ], - "tableStyle": { # Styles that apply to a table. # The style of the table. - "tableColumnProperties": [ # The properties of each column. Note that in Docs, tables contain rows and rows contain cells, similar to HTML. So the properties for a row can be found on the row's table_row_style. - { # The properties of a column in a table. - "width": { # A magnitude in a single direction in the specified units. # The width of the column. Set when the column's `width_type` is FIXED_WIDTH. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this HorizontalRule. Similar to text content, like text runs and footnote references, the text style of a horizontal rule can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "widthType": "A String", # The width type of the column. - }, - ], - }, - }, - "tableOfContents": { # A StructuralElement representing a table of contents. # A table of contents type of structural element. - "content": [ # The content of the table of contents. - # Object with schema name: StructuralElement - ], - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A TableOfContents may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - }, - }, - ], - "footnoteId": "A String", # The ID of the footnote. - }, - }, - "headers": { # Output only. The headers in the document, keyed by header ID. - "a_key": { # A document header. - "content": [ # The contents of the header. The indexes for a header's content begin at zero. - { # A StructuralElement describes content that provides structure to the document. - "endIndex": 42, # The zero-based end index of this structural element, exclusive, in UTF-16 code units. - "paragraph": { # A StructuralElement representing a paragraph. A paragraph is a range of content that's terminated with a newline character. # A paragraph type of structural element. - "bullet": { # Describes the bullet of a paragraph. # The bullet for this paragraph. If not present, the paragraph does not belong to a list. - "listId": "A String", # The ID of the list this paragraph belongs to. - "nestingLevel": 42, # The nesting level of this paragraph in the list. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, - }, - "elements": [ # The content of the paragraph, broken down into its component parts. - { # A ParagraphElement describes content within a Paragraph. - "autoText": { # A ParagraphElement representing a spot in the text that's dynamically replaced with content that can change over time, like a page number. # An auto text paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. An AutoText may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this AutoText, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + "inlineObjectElement": { # A ParagraphElement that contains an InlineObject. # An inline object paragraph element. + "inlineObjectId": "A String", # The ID of the InlineObject this element contains. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. An InlineObjectElement may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this InlineObject, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this AutoText. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this InlineObjectElement. Similar to text content, like text runs and footnote references, the text style of an inline object element can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, - "type": "A String", # The type of this auto text. }, - "columnBreak": { # A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column. # A column break paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this ColumnBreak, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + }, + "pageBreak": { # A ParagraphElement representing a page break. A page break makes the subsequent text start at the top of the next page. # A page break paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A PageBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this PageBreak, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this PageBreak. Similar to text content, like text runs and footnote references, the text style of a page break can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, - "endIndex": 42, # The zero-base end index of this paragraph element, exclusive, in UTF-16 code units. - "equation": { # A ParagraphElement representing an equation. # An equation paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. An Equation may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], + }, + "person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address. + "personId": "A String", # Output only. The unique ID of this link. + "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present. + "email": "A String", # Output only. The email address linked to this Person. This field is always present. + "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address. }, - "footnoteReference": { # A ParagraphElement representing a footnote reference. A footnote reference is the inline content rendered with a number and is used to identify the footnote. # A footnote reference paragraph element. - "footnoteId": "A String", # The ID of the footnote that contains the content of this footnote reference. - "footnoteNumber": "A String", # The rendered number of this footnote. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this FootnoteReference, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. + "A String", + ], + "suggestedInsertionIds": [ # IDs for suggestions that insert this person link into the document. A Person might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this Person, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this FootnoteReference. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this Person. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, - "horizontalRule": { # A ParagraphElement representing a horizontal line. # A horizontal rule paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A HorizontalRule may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this HorizontalRule, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + }, + "richLink": { # A link to a Google resource (such as a file in Drive, a YouTube video, or a Calendar event). # A paragraph element that links to a Google resource (such as a file in Google Drive, a YouTube video, or a Calendar event.) + "richLinkId": "A String", # Output only. The ID of this link. + "richLinkProperties": { # Properties specific to a RichLink. # Output only. The properties of this RichLink. This field is always present. + "mimeType": "A String", # Output only. The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the RichLink, if there's one (for example, when it's a file in Drive). + "title": "A String", # Output only. The title of the RichLink as displayed in the link. This title matches the title of the linked resource at the time of the insertion or last update of the link. This field is always present. + "uri": "A String", # Output only. The URI to the RichLink. This is always present. + }, + "suggestedDeletionIds": [ # IDs for suggestions that remove this link from the document. A RichLink might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. + "A String", + ], + "suggestedInsertionIds": [ # IDs for suggestions that insert this link into the document. A RichLink might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this RichLink, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this HorizontalRule. Similar to text content, like text runs and footnote references, the text style of a horizontal rule can affect content layout as well as the styling of text inserted next to it. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this RichLink. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, - "inlineObjectElement": { # A ParagraphElement that contains an InlineObject. # An inline object paragraph element. - "inlineObjectId": "A String", # The ID of the InlineObject this element contains. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. An InlineObjectElement may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this InlineObject, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + }, + "startIndex": 42, # The zero-based start index of this paragraph element, in UTF-16 code units. + "textRun": { # A ParagraphElement that represents a run of text that all has the same styling. # A text run paragraph element. + "content": "A String", # The text of this run. Any non-text elements in the run are replaced with the Unicode character U+E907. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TextRun may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this run, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this InlineObjectElement. Similar to text content, like text runs and footnote references, the text style of an inline object element can affect content layout as well as the styling of text inserted next to it. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this run. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, - "pageBreak": { # A ParagraphElement representing a page break. A page break makes the subsequent text start at the top of the next page. # A page break paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A PageBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this PageBreak, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + ], + "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The style of this paragraph. + "alignment": "A String", # The text alignment for this paragraph. + "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. + "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. + "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. + "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. + "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. + "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. + "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. + "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. + "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + }, + "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spacingMode": "A String", # The spacing mode for the paragraph. + "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. + { # A tab stop within a paragraph. + "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. + "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + ], + }, + "positionedObjectIds": [ # The IDs of the positioned objects tethered to this paragraph. + "A String", + ], + "suggestedBulletChanges": { # The suggested changes to this paragraph's bullet. + "a_key": { # A suggested change to a Bullet. + "bullet": { # Describes the bullet of a paragraph. # A Bullet that only includes the changes made in this suggestion. This can be used along with the bullet_suggestion_state to see which fields have changed and their new values. + "listId": "A String", # The ID of the list this paragraph belongs to. + "nestingLevel": 42, # The nesting level of this paragraph in the list. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this PageBreak. Similar to text content, like text runs and footnote references, the text style of a page break can affect content layout as well as the styling of text inserted next to it. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. }, - }, - "person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address. - "personId": "A String", # Output only. The unique ID of this link. - "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present. - "email": "A String", # Output only. The email address linked to this Person. This field is always present. - "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address. + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, - "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. - "A String", - ], - "suggestedInsertionIds": [ # IDs for suggestions that insert this person link into the document. A Person might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this Person, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + "bulletSuggestionState": { # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. + "listIdSuggested": True or False, # Indicates if there was a suggested change to the list_id. + "nestingLevelSuggested": True or False, # Indicates if there was a suggested change to the nesting_level. + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + }, + "suggestedParagraphStyleChanges": { # The suggested paragraph style changes to this paragraph, keyed by suggestion ID. + "a_key": { # A suggested change to a ParagraphStyle. + "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A ParagraphStyle that only includes the changes made in this suggestion. This can be used along with the paragraph_style_suggestion_state to see which fields have changed and their new values. + "alignment": "A String", # The text alignment for this paragraph. + "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. + "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this Person. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - "richLink": { # A link to a Google resource (such as a file in Drive, a YouTube video, or a Calendar event). # A paragraph element that links to a Google resource (such as a file in Google Drive, a YouTube video, or a Calendar event.) - "richLinkId": "A String", # Output only. The ID of this link. - "richLinkProperties": { # Properties specific to a RichLink. # Output only. The properties of this RichLink. This field is always present. - "mimeType": "A String", # Output only. The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the RichLink, if there's one (for example, when it's a file in Drive). - "title": "A String", # Output only. The title of the RichLink as displayed in the link. This title matches the title of the linked resource at the time of the insertion or last update of the link. This field is always present. - "uri": "A String", # Output only. The URI to the RichLink. This is always present. + "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, }, - "suggestedDeletionIds": [ # IDs for suggestions that remove this link from the document. A RichLink might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. - "A String", - ], - "suggestedInsertionIds": [ # IDs for suggestions that insert this link into the document. A RichLink might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this RichLink, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, - }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this RichLink. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - "startIndex": 42, # The zero-based start index of this paragraph element, in UTF-16 code units. - "textRun": { # A ParagraphElement that represents a run of text that all has the same styling. # A text run paragraph element. - "content": "A String", # The text of this run. Any non-text elements in the run are replaced with the Unicode character U+E907. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A TextRun may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this run, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, - }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this run. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, }, - }, - ], - "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The style of this paragraph. - "alignment": "A String", # The text alignment for this paragraph. - "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. - "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, + "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. + "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. + "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - }, - "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. + "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. + "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. + "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. + "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. + "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, + "spacingMode": "A String", # The spacing mode for the paragraph. + "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. + { # A tab stop within a paragraph. + "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. + "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + ], }, - "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "paragraphStyleSuggestionState": { # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. + "alignmentSuggested": True or False, # Indicates if there was a suggested change to alignment. + "avoidWidowAndOrphanSuggested": True or False, # Indicates if there was a suggested change to avoid_widow_and_orphan. + "borderBetweenSuggested": True or False, # Indicates if there was a suggested change to border_between. + "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. + "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. + "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. + "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. + "directionSuggested": True or False, # Indicates if there was a suggested change to direction. + "headingIdSuggested": True or False, # Indicates if there was a suggested change to heading_id. + "indentEndSuggested": True or False, # Indicates if there was a suggested change to indent_end. + "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line. + "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start. + "keepLinesTogetherSuggested": True or False, # Indicates if there was a suggested change to keep_lines_together. + "keepWithNextSuggested": True or False, # Indicates if there was a suggested change to keep_with_next. + "lineSpacingSuggested": True or False, # Indicates if there was a suggested change to line_spacing. + "namedStyleTypeSuggested": True or False, # Indicates if there was a suggested change to named_style_type. + "pageBreakBeforeSuggested": True or False, # Indicates if there was a suggested change to page_break_before. + "shadingSuggestionState": { # A mask that indicates which of the fields on the base Shading have been changed in this suggested change. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in shading have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to the Shading. }, + "spaceAboveSuggested": True or False, # Indicates if there was a suggested change to space_above. + "spaceBelowSuggested": True or False, # Indicates if there was a suggested change to space_below. + "spacingModeSuggested": True or False, # Indicates if there was a suggested change to spacing_mode. }, - "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + }, + }, + "suggestedPositionedObjectIds": { # The IDs of the positioned objects suggested to be attached to this paragraph, keyed by suggestion ID. + "a_key": { # A collection of object IDs. + "objectIds": [ # The object IDs. + "A String", + ], + }, + }, + }, + "sectionBreak": { # A StructuralElement representing a section break. A section is a range of content that has the same SectionStyle. A section break represents the start of a new section, and the section style applies to the section after the section break. The document body always begins with a section break. # A section break type of structural element. + "sectionStyle": { # The styling that applies to a section. # The style of the section after this section break. + "columnProperties": [ # The section's columns properties. If empty, the section contains one column with the default properties in the Docs editor. A section can be updated to have no more than 3 columns. When updating this property, setting a concrete value is required. Unsetting this property will result in a 400 bad request error. + { # Properties that apply to a section's column. + "paddingEnd": { # A magnitude in a single direction in the specified units. # The padding at the end of the column. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "width": { # A magnitude in a single direction in the specified units. # Output only. The width of the column. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, }, - "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. - "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. - "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. - "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. - "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. - "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. - "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. - "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - }, - "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "spacingMode": "A String", # The spacing mode for the paragraph. - "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. - { # A tab stop within a paragraph. - "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. - "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - ], - }, - "positionedObjectIds": [ # The IDs of the positioned objects tethered to this paragraph. - "A String", ], - "suggestedBulletChanges": { # The suggested changes to this paragraph's bullet. - "a_key": { # A suggested change to a Bullet. - "bullet": { # Describes the bullet of a paragraph. # A Bullet that only includes the changes made in this suggestion. This can be used along with the bullet_suggestion_state to see which fields have changed and their new values. - "listId": "A String", # The ID of the list this paragraph belongs to. - "nestingLevel": 42, # The nesting level of this paragraph in the list. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only. + "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only. + "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only. + "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only. + "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only. + "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only. + "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "sectionType": "A String", # Output only. The type of section. + "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + }, + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A SectionBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + }, + "startIndex": 42, # The zero-based start index of this structural element, in UTF-16 code units. + "table": { # A StructuralElement representing a table. # A table type of structural element. + "columns": 42, # Number of columns in the table. It's possible for a table to be non-rectangular, so some rows may have a different number of cells. + "rows": 42, # Number of rows in the table. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A Table may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "tableRows": [ # The contents and style of each row. + { # The contents and style of a row in a Table. + "endIndex": 42, # The zero-based end index of this row, exclusive, in UTF-16 code units. + "startIndex": 42, # The zero-based start index of this row, in UTF-16 code units. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TableRow may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTableRowStyleChanges": { # The suggested style changes to this row, keyed by suggestion ID. + "a_key": { # A suggested change to a TableRowStyle. + "tableRowStyle": { # Styles that apply to a table row. # A TableRowStyle that only includes the changes made in this suggestion. This can be used along with the table_row_style_suggestion_state to see which fields have changed and their new values. + "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - "bulletSuggestionState": { # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. - "listIdSuggested": True or False, # Indicates if there was a suggested change to the list_id. - "nestingLevelSuggested": True or False, # Indicates if there was a suggested change to the nesting_level. - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries. + "tableHeader": True or False, # Whether the row is a table header. + }, + "tableRowStyleSuggestionState": { # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. + "minRowHeightSuggested": True or False, # Indicates if there was a suggested change to min_row_height. }, }, }, - }, - "suggestedParagraphStyleChanges": { # The suggested paragraph style changes to this paragraph, keyed by suggestion ID. - "a_key": { # A suggested change to a ParagraphStyle. - "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A ParagraphStyle that only includes the changes made in this suggestion. This can be used along with the paragraph_style_suggestion_state to see which fields have changed and their new values. - "alignment": "A String", # The text alignment for this paragraph. - "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. - "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "tableCells": [ # The contents and style of each cell in this row. It's possible for a table to be non-rectangular, so some rows may have a different number of cells than other rows in the same table. + { # The contents and style of a cell in a Table. + "content": [ # The content of the cell. + # Object with schema name: StructuralElement + ], + "endIndex": 42, # The zero-based end index of this cell, exclusive, in UTF-16 code units. + "startIndex": 42, # The zero-based start index of this cell, in UTF-16 code units. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TableCell may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTableCellStyleChanges": { # The suggested changes to the table cell style, keyed by suggestion ID. + "a_key": { # A suggested change to a TableCellStyle. + "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # A TableCellStyle that only includes the changes made in this suggestion. This can be used along with the table_cell_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "columnSpan": 42, # The column span of the cell. This property is read-only. + "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. + "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, + "rowSpan": 42, # The row span of the cell. This property is read-only. + }, + "tableCellStyleSuggestionState": { # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. + "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. + "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. + "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. + "columnSpanSuggested": True or False, # Indicates if there was a suggested change to column_span. + "contentAlignmentSuggested": True or False, # Indicates if there was a suggested change to content_alignment. + "paddingBottomSuggested": True or False, # Indicates if there was a suggested change to padding_bottom. + "paddingLeftSuggested": True or False, # Indicates if there was a suggested change to padding_left. + "paddingRightSuggested": True or False, # Indicates if there was a suggested change to padding_right. + "paddingTopSuggested": True or False, # Indicates if there was a suggested change to padding_top. + "rowSpanSuggested": True or False, # Indicates if there was a suggested change to row_span. }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. }, }, - "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # The style of the cell. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -15737,58 +20786,321 @@

Method Details

}, }, }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - }, - "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "columnSpan": 42, # The column span of the cell. This property is read-only. + "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. + "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - }, - "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, + "rowSpan": 42, # The row span of the cell. This property is read-only. }, - "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + }, + ], + "tableRowStyle": { # Styles that apply to a table row. # The style of the table row. + "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries. + "tableHeader": True or False, # Whether the row is a table header. + }, + }, + ], + "tableStyle": { # Styles that apply to a table. # The style of the table. + "tableColumnProperties": [ # The properties of each column. Note that in Docs, tables contain rows and rows contain cells, similar to HTML. So the properties for a row can be found on the row's table_row_style. + { # The properties of a column in a table. + "width": { # A magnitude in a single direction in the specified units. # The width of the column. Set when the column's `width_type` is FIXED_WIDTH. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "widthType": "A String", # The width type of the column. + }, + ], + }, + }, + "tableOfContents": { # A StructuralElement representing a table of contents. # A table of contents type of structural element. + "content": [ # The content of the table of contents. + # Object with schema name: StructuralElement + ], + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TableOfContents may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + }, + }, + ], + }, + "documentId": "A String", # Output only. The ID of the document. + "documentStyle": { # The style of the document. # Output only. The style of the document. + "background": { # Represents the background of a document. # The background of the document. Documents cannot have a transparent background color. + "color": { # A color that can either be fully opaque or fully transparent. # The background color. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + }, + "defaultFooterId": "A String", # The ID of the default footer. If not set, there's no default footer. This property is read-only. + "defaultHeaderId": "A String", # The ID of the default header. If not set, there's no default header. This property is read-only. + "evenPageFooterId": "A String", # The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. This property is read-only. + "evenPageHeaderId": "A String", # The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. This property is read-only. + "firstPageFooterId": "A String", # The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. This property is read-only. + "firstPageHeaderId": "A String", # The ID of the header used only for the first page. If not set then a unique header for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_header_id or this value for the header on the first page. If not set, there's no first page header. This property is read-only. + "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of the page_size, which allows changing the page orientation between portrait and landscape. + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin. Updating the bottom page margin on the document style clears the bottom page margin on all section styles. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginFooter": { # A magnitude in a single direction in the specified units. # The amount of space between the bottom of the page and the contents of the footer. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginHeader": { # A magnitude in a single direction in the specified units. # The amount of space between the top of the page and the contents of the header. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin. Updating the left page margin on the document style clears the left page margin on all section styles. It may also cause columns to resize in all sections. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin. Updating the right page margin on the document style clears the right page margin on all section styles. It may also cause columns to resize in all sections. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin. Updating the top page margin on the document style clears the top page margin on all section styles. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "pageNumberStart": 42, # The page number from which to start counting the number of pages. + "pageSize": { # A width and height. # The size of a page in the document. + "height": { # A magnitude in a single direction in the specified units. # The height of the object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "useCustomHeaderFooterMargins": True or False, # Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected. When false, the default values in the Docs editor for header and footer margin are used. This property is read-only. + "useEvenPageHeaderFooter": True or False, # Indicates whether to use the even page header / footer IDs for the even pages. + "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page. + }, + "footers": { # Output only. The footers in the document, keyed by footer ID. + "a_key": { # A document footer. + "content": [ # The contents of the footer. The indexes for a footer's content begin at zero. + { # A StructuralElement describes content that provides structure to the document. + "endIndex": 42, # The zero-based end index of this structural element, exclusive, in UTF-16 code units. + "paragraph": { # A StructuralElement representing a paragraph. A paragraph is a range of content that's terminated with a newline character. # A paragraph type of structural element. + "bullet": { # Describes the bullet of a paragraph. # The bullet for this paragraph. If not present, the paragraph does not belong to a list. + "listId": "A String", # The ID of the list this paragraph belongs to. + "nestingLevel": 42, # The nesting level of this paragraph in the list. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "elements": [ # The content of the paragraph, broken down into its component parts. + { # A ParagraphElement describes content within a Paragraph. + "autoText": { # A ParagraphElement representing a spot in the text that's dynamically replaced with content that can change over time, like a page number. # An auto text paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. An AutoText may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this AutoText, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this AutoText. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -15797,37 +21109,13 @@

Method Details

}, }, }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - }, - "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. - "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. - "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. - "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. - "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. - "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. - "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. - "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -15836,291 +21124,174 @@

Method Details

}, }, }, - }, - "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "spacingMode": "A String", # The spacing mode for the paragraph. - "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. - { # A tab stop within a paragraph. - "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. - "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. }, - }, - ], - }, - "paragraphStyleSuggestionState": { # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. - "alignmentSuggested": True or False, # Indicates if there was a suggested change to alignment. - "avoidWidowAndOrphanSuggested": True or False, # Indicates if there was a suggested change to avoid_widow_and_orphan. - "borderBetweenSuggested": True or False, # Indicates if there was a suggested change to border_between. - "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. - "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. - "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. - "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. - "directionSuggested": True or False, # Indicates if there was a suggested change to direction. - "headingIdSuggested": True or False, # Indicates if there was a suggested change to heading_id. - "indentEndSuggested": True or False, # Indicates if there was a suggested change to indent_end. - "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line. - "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start. - "keepLinesTogetherSuggested": True or False, # Indicates if there was a suggested change to keep_lines_together. - "keepWithNextSuggested": True or False, # Indicates if there was a suggested change to keep_with_next. - "lineSpacingSuggested": True or False, # Indicates if there was a suggested change to line_spacing. - "namedStyleTypeSuggested": True or False, # Indicates if there was a suggested change to named_style_type. - "pageBreakBeforeSuggested": True or False, # Indicates if there was a suggested change to page_break_before. - "shadingSuggestionState": { # A mask that indicates which of the fields on the base Shading have been changed in this suggested change. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in shading have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to the Shading. - }, - "spaceAboveSuggested": True or False, # Indicates if there was a suggested change to space_above. - "spaceBelowSuggested": True or False, # Indicates if there was a suggested change to space_below. - "spacingModeSuggested": True or False, # Indicates if there was a suggested change to spacing_mode. - }, - }, - }, - "suggestedPositionedObjectIds": { # The IDs of the positioned objects suggested to be attached to this paragraph, keyed by suggestion ID. - "a_key": { # A collection of object IDs. - "objectIds": [ # The object IDs. - "A String", - ], - }, - }, - }, - "sectionBreak": { # A StructuralElement representing a section break. A section is a range of content that has the same SectionStyle. A section break represents the start of a new section, and the section style applies to the section after the section break. The document body always begins with a section break. # A section break type of structural element. - "sectionStyle": { # The styling that applies to a section. # The style of the section after this section break. - "columnProperties": [ # The section's columns properties. If empty, the section contains one column with the default properties in the Docs editor. A section can be updated to have no more than 3 columns. When updating this property, setting a concrete value is required. Unsetting this property will result in a 400 bad request error. - { # Properties that apply to a section's column. - "paddingEnd": { # A magnitude in a single direction in the specified units. # The padding at the end of the column. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # Output only. The width of the column. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - ], - "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only. - "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only. - "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only. - "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only. - "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only. - "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only. - "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "sectionType": "A String", # Output only. The type of section. - "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - }, - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A SectionBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - }, - "startIndex": 42, # The zero-based start index of this structural element, in UTF-16 code units. - "table": { # A StructuralElement representing a table. # A table type of structural element. - "columns": 42, # Number of columns in the table. It's possible for a table to be non-rectangular, so some rows may have a different number of cells. - "rows": 42, # Number of rows in the table. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A Table may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "tableRows": [ # The contents and style of each row. - { # The contents and style of a row in a Table. - "endIndex": 42, # The zero-based end index of this row, exclusive, in UTF-16 code units. - "startIndex": 42, # The zero-based start index of this row, in UTF-16 code units. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A TableRow may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTableRowStyleChanges": { # The suggested style changes to this row, keyed by suggestion ID. - "a_key": { # A suggested change to a TableRowStyle. - "tableRowStyle": { # Styles that apply to a table row. # A TableRowStyle that only includes the changes made in this suggestion. This can be used along with the table_row_style_suggestion_state to see which fields have changed and their new values. - "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. }, - "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries. - "tableHeader": True or False, # Whether the row is a table header. + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. }, - "tableRowStyleSuggestionState": { # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. - "minRowHeightSuggested": True or False, # Indicates if there was a suggested change to min_row_height. + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, + "type": "A String", # The type of this auto text. }, - "tableCells": [ # The contents and style of each cell in this row. It's possible for a table to be non-rectangular, so some rows may have a different number of cells than other rows in the same table. - { # The contents and style of a cell in a Table. - "content": [ # The content of the cell. - # Object with schema name: StructuralElement - ], - "endIndex": 42, # The zero-based end index of this cell, exclusive, in UTF-16 code units. - "startIndex": 42, # The zero-based start index of this cell, in UTF-16 code units. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A TableCell may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTableCellStyleChanges": { # The suggested changes to the table cell style, keyed by suggestion ID. - "a_key": { # A suggested change to a TableCellStyle. - "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # A TableCellStyle that only includes the changes made in this suggestion. This can be used along with the table_cell_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + "columnBreak": { # A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column. # A column break paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this ColumnBreak, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. }, - "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. }, - "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "columnSpan": 42, # The column span of the cell. This property is read-only. - "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. - "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "rowSpan": 42, # The row span of the cell. This property is read-only. + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. }, - "tableCellStyleSuggestionState": { # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. - "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. - "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. - "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. - "columnSpanSuggested": True or False, # Indicates if there was a suggested change to column_span. - "contentAlignmentSuggested": True or False, # Indicates if there was a suggested change to content_alignment. - "paddingBottomSuggested": True or False, # Indicates if there was a suggested change to padding_bottom. - "paddingLeftSuggested": True or False, # Indicates if there was a suggested change to padding_left. - "paddingRightSuggested": True or False, # Indicates if there was a suggested change to padding_right. - "paddingTopSuggested": True or False, # Indicates if there was a suggested change to padding_top. - "rowSpanSuggested": True or False, # Indicates if there was a suggested change to row_span. + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, }, - "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # The style of the cell. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "endIndex": 42, # The zero-base end index of this paragraph element, exclusive, in UTF-16 code units. + "equation": { # A ParagraphElement representing an equation. # An equation paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. An Equation may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + }, + "footnoteReference": { # A ParagraphElement representing a footnote reference. A footnote reference is the inline content rendered with a number and is used to identify the footnote. # A footnote reference paragraph element. + "footnoteId": "A String", # The ID of the footnote that contains the content of this footnote reference. + "footnoteNumber": "A String", # The rendered number of this footnote. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this FootnoteReference, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -16129,14 +21300,13 @@

Method Details

}, }, }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - }, - "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -16145,14 +21315,104 @@

Method Details

}, }, }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, - "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this FootnoteReference. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "horizontalRule": { # A ParagraphElement representing a horizontal line. # A horizontal rule paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A HorizontalRule may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this HorizontalRule, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -16161,14 +21421,13 @@

Method Details

}, }, }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - }, - "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -16177,741 +21436,838 @@

Method Details

}, }, }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, - "columnSpan": 42, # The column span of the cell. This property is read-only. - "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. - "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. }, - "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this HorizontalRule. Similar to text content, like text runs and footnote references, the text style of a horizontal rule can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, - "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, - "rowSpan": 42, # The row span of the cell. This property is read-only. + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, - ], - "tableRowStyle": { # Styles that apply to a table row. # The style of the table row. - "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries. - "tableHeader": True or False, # Whether the row is a table header. }, - }, - ], - "tableStyle": { # Styles that apply to a table. # The style of the table. - "tableColumnProperties": [ # The properties of each column. Note that in Docs, tables contain rows and rows contain cells, similar to HTML. So the properties for a row can be found on the row's table_row_style. - { # The properties of a column in a table. - "width": { # A magnitude in a single direction in the specified units. # The width of the column. Set when the column's `width_type` is FIXED_WIDTH. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "inlineObjectElement": { # A ParagraphElement that contains an InlineObject. # An inline object paragraph element. + "inlineObjectId": "A String", # The ID of the InlineObject this element contains. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. An InlineObjectElement may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this InlineObject, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this InlineObjectElement. Similar to text content, like text runs and footnote references, the text style of an inline object element can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, }, - "widthType": "A String", # The width type of the column. - }, - ], - }, - }, - "tableOfContents": { # A StructuralElement representing a table of contents. # A table of contents type of structural element. - "content": [ # The content of the table of contents. - # Object with schema name: StructuralElement - ], - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A TableOfContents may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - }, - }, - ], - "headerId": "A String", # The ID of the header. - }, - }, - "inlineObjects": { # Output only. The inline objects in the document, keyed by object ID. - "a_key": { # An object that appears inline with text. An InlineObject contains an EmbeddedObject such as an image. - "inlineObjectProperties": { # Properties of an InlineObject. # The properties of this inline object. - "embeddedObject": { # An embedded object in the document. # The embedded object of this inline object. - "description": "A String", # The description of the embedded object. The `title` and `description` are both combined to display alt text. - "embeddedDrawingProperties": { # The properties of an embedded drawing and used to differentiate the object type. An embedded drawing is one that's created and edited within a document. Note that extensive details are not supported. # The properties of an embedded drawing. - }, - "embeddedObjectBorder": { # A border around an EmbeddedObject. # The border of the embedded object. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "propertyState": "A String", # The property state of the border property. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "imageProperties": { # The properties of an image. # The properties of an image. - "angle": 3.14, # The clockwise rotation angle of the image, in radians. - "brightness": 3.14, # The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. - "contentUri": "A String", # A URI to the image with a default lifetime of 30 minutes. This URI is tagged with the account of the requester. Anyone with the URI effectively accesses the image as the original requester. Access to the image may be lost if the document's sharing settings change. - "contrast": 3.14, # The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. - "cropProperties": { # The crop properties of an image. The crop rectangle is represented using fractional offsets from the original content's 4 edges. - If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the image's original bounding rectangle. - If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the image's original bounding rectangle. - If all offsets and rotation angle are 0, the image is not cropped. # The crop properties of the image. - "angle": 3.14, # The clockwise rotation angle of the crop rectangle around its center, in radians. Rotation is applied after the offsets. - "offsetBottom": 3.14, # The offset specifies how far inwards the bottom edge of the crop rectangle is from the bottom edge of the original content as a fraction of the original content's height. - "offsetLeft": 3.14, # The offset specifies how far inwards the left edge of the crop rectangle is from the left edge of the original content as a fraction of the original content's width. - "offsetRight": 3.14, # The offset specifies how far inwards the right edge of the crop rectangle is from the right edge of the original content as a fraction of the original content's width. - "offsetTop": 3.14, # The offset specifies how far inwards the top edge of the crop rectangle is from the top edge of the original content as a fraction of the original content's height. - }, - "sourceUri": "A String", # The source URI is the URI used to insert the image. The source URI can be empty. - "transparency": 3.14, # The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means transparent. - }, - "linkedContentReference": { # A reference to the external linked source content. # A reference to the external linked source content. For example, it contains a reference to the source Google Sheets chart when the embedded object is a linked chart. If unset, then the embedded object is not linked. - "sheetsChartReference": { # A reference to a linked chart embedded from Google Sheets. # A reference to the linked chart. - "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that's embedded. - "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart. - }, - }, - "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom margin of the embedded object. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginLeft": { # A magnitude in a single direction in the specified units. # The left margin of the embedded object. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginRight": { # A magnitude in a single direction in the specified units. # The right margin of the embedded object. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginTop": { # A magnitude in a single direction in the specified units. # The top margin of the embedded object. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "size": { # A width and height. # The visible size of the image after cropping. - "height": { # A magnitude in a single direction in the specified units. # The height of the object. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the object. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "title": "A String", # The title of the embedded object. The `title` and `description` are both combined to display alt text. - }, - }, - "objectId": "A String", # The ID of this inline object. Can be used to update an object’s properties. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInlineObjectPropertiesChanges": { # The suggested changes to the inline object properties, keyed by suggestion ID. - "a_key": { # A suggested change to InlineObjectProperties. - "inlineObjectProperties": { # Properties of an InlineObject. # An InlineObjectProperties that only includes the changes made in this suggestion. This can be used along with the inline_object_properties_suggestion_state to see which fields have changed and their new values. - "embeddedObject": { # An embedded object in the document. # The embedded object of this inline object. - "description": "A String", # The description of the embedded object. The `title` and `description` are both combined to display alt text. - "embeddedDrawingProperties": { # The properties of an embedded drawing and used to differentiate the object type. An embedded drawing is one that's created and edited within a document. Note that extensive details are not supported. # The properties of an embedded drawing. - }, - "embeddedObjectBorder": { # A border around an EmbeddedObject. # The border of the embedded object. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "pageBreak": { # A ParagraphElement representing a page break. A page break makes the subsequent text start at the top of the next page. # A page break paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A PageBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this PageBreak, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this PageBreak. Similar to text content, like text runs and footnote references, the text style of a page break can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, }, - "dashStyle": "A String", # The dash style of the border. - "propertyState": "A String", # The property state of the border property. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "imageProperties": { # The properties of an image. # The properties of an image. - "angle": 3.14, # The clockwise rotation angle of the image, in radians. - "brightness": 3.14, # The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. - "contentUri": "A String", # A URI to the image with a default lifetime of 30 minutes. This URI is tagged with the account of the requester. Anyone with the URI effectively accesses the image as the original requester. Access to the image may be lost if the document's sharing settings change. - "contrast": 3.14, # The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. - "cropProperties": { # The crop properties of an image. The crop rectangle is represented using fractional offsets from the original content's 4 edges. - If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the image's original bounding rectangle. - If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the image's original bounding rectangle. - If all offsets and rotation angle are 0, the image is not cropped. # The crop properties of the image. - "angle": 3.14, # The clockwise rotation angle of the crop rectangle around its center, in radians. Rotation is applied after the offsets. - "offsetBottom": 3.14, # The offset specifies how far inwards the bottom edge of the crop rectangle is from the bottom edge of the original content as a fraction of the original content's height. - "offsetLeft": 3.14, # The offset specifies how far inwards the left edge of the crop rectangle is from the left edge of the original content as a fraction of the original content's width. - "offsetRight": 3.14, # The offset specifies how far inwards the right edge of the crop rectangle is from the right edge of the original content as a fraction of the original content's width. - "offsetTop": 3.14, # The offset specifies how far inwards the top edge of the crop rectangle is from the top edge of the original content as a fraction of the original content's height. - }, - "sourceUri": "A String", # The source URI is the URI used to insert the image. The source URI can be empty. - "transparency": 3.14, # The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means transparent. - }, - "linkedContentReference": { # A reference to the external linked source content. # A reference to the external linked source content. For example, it contains a reference to the source Google Sheets chart when the embedded object is a linked chart. If unset, then the embedded object is not linked. - "sheetsChartReference": { # A reference to a linked chart embedded from Google Sheets. # A reference to the linked chart. - "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that's embedded. - "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart. - }, - }, - "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom margin of the embedded object. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginLeft": { # A magnitude in a single direction in the specified units. # The left margin of the embedded object. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginRight": { # A magnitude in a single direction in the specified units. # The right margin of the embedded object. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginTop": { # A magnitude in a single direction in the specified units. # The top margin of the embedded object. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "size": { # A width and height. # The visible size of the image after cropping. - "height": { # A magnitude in a single direction in the specified units. # The height of the object. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the object. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "title": "A String", # The title of the embedded object. The `title` and `description` are both combined to display alt text. - }, - }, - "inlineObjectPropertiesSuggestionState": { # A mask that indicates which of the fields on the base InlineObjectProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base InlineObjectProperties have been changed in this suggestion. - "embeddedObjectSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedObject have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_object have been changed in this suggestion. - "descriptionSuggested": True or False, # Indicates if there was a suggested change to description. - "embeddedDrawingPropertiesSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedDrawingProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_drawing_properties have been changed in this suggestion. - }, - "embeddedObjectBorderSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedObjectBorder have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_object_border have been changed in this suggestion. - "colorSuggested": True or False, # Indicates if there was a suggested change to color. - "dashStyleSuggested": True or False, # Indicates if there was a suggested change to dash_style. - "propertyStateSuggested": True or False, # Indicates if there was a suggested change to property_state. - "widthSuggested": True or False, # Indicates if there was a suggested change to width. - }, - "imagePropertiesSuggestionState": { # A mask that indicates which of the fields on the base ImageProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in image_properties have been changed in this suggestion. - "angleSuggested": True or False, # Indicates if there was a suggested change to angle. - "brightnessSuggested": True or False, # Indicates if there was a suggested change to brightness. - "contentUriSuggested": True or False, # Indicates if there was a suggested change to content_uri. - "contrastSuggested": True or False, # Indicates if there was a suggested change to contrast. - "cropPropertiesSuggestionState": { # A mask that indicates which of the fields on the base CropProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in crop_properties have been changed in this suggestion. - "angleSuggested": True or False, # Indicates if there was a suggested change to angle. - "offsetBottomSuggested": True or False, # Indicates if there was a suggested change to offset_bottom. - "offsetLeftSuggested": True or False, # Indicates if there was a suggested change to offset_left. - "offsetRightSuggested": True or False, # Indicates if there was a suggested change to offset_right. - "offsetTopSuggested": True or False, # Indicates if there was a suggested change to offset_top. - }, - "sourceUriSuggested": True or False, # Indicates if there was a suggested change to source_uri. - "transparencySuggested": True or False, # Indicates if there was a suggested change to transparency. - }, - "linkedContentReferenceSuggestionState": { # A mask that indicates which of the fields on the base LinkedContentReference have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in linked_content_reference have been changed in this suggestion. - "sheetsChartReferenceSuggestionState": { # A mask that indicates which of the fields on the base SheetsChartReference have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in sheets_chart_reference have been changed in this suggestion. - "chartIdSuggested": True or False, # Indicates if there was a suggested change to chart_id. - "spreadsheetIdSuggested": True or False, # Indicates if there was a suggested change to spreadsheet_id. - }, - }, - "marginBottomSuggested": True or False, # Indicates if there was a suggested change to margin_bottom. - "marginLeftSuggested": True or False, # Indicates if there was a suggested change to margin_left. - "marginRightSuggested": True or False, # Indicates if there was a suggested change to margin_right. - "marginTopSuggested": True or False, # Indicates if there was a suggested change to margin_top. - "sizeSuggestionState": { # A mask that indicates which of the fields on the base Size have been changed in this suggestion. For any field set to true, the Size has a new suggested value. # A mask that indicates which of the fields in size have been changed in this suggestion. - "heightSuggested": True or False, # Indicates if there was a suggested change to height. - "widthSuggested": True or False, # Indicates if there was a suggested change to width. - }, - "titleSuggested": True or False, # Indicates if there was a suggested change to title. - }, - }, - }, - }, - "suggestedInsertionId": "A String", # The suggested insertion ID. If empty, then this is not a suggested insertion. - }, - }, - "lists": { # Output only. The lists in the document, keyed by list ID. - "a_key": { # A List represents the list attributes for a group of paragraphs that all belong to the same list. A paragraph that's part of a list has a reference to the list's ID in its bullet. - "listProperties": { # The properties of a list that describe the look and feel of bullets belonging to paragraphs associated with a list. # The properties of the list. - "nestingLevels": [ # Describes the properties of the bullets at the associated level. A list has at most 9 levels of nesting with nesting level 0 corresponding to the top-most level and nesting level 8 corresponding to the most nested level. The nesting levels are returned in ascending order with the least nested returned first. - { # Contains properties describing the look and feel of a list bullet at a given level of nesting. - "bulletAlignment": "A String", # The alignment of the bullet within the space allotted for rendering the bullet. - "glyphFormat": "A String", # The format string used by bullets at this level of nesting. The glyph format contains one or more placeholders, and these placeholders are replaced with the appropriate values depending on the glyph_type or glyph_symbol. The placeholders follow the pattern `%[nesting_level]`. Furthermore, placeholders can have prefixes and suffixes. Thus, the glyph format follows the pattern `%[nesting_level]`. Note that the prefix and suffix are optional and can be arbitrary strings. For example, the glyph format `%0.` indicates that the rendered glyph will replace the placeholder with the corresponding glyph for nesting level 0 followed by a period as the suffix. So a list with a glyph type of UPPER_ALPHA and glyph format `%0.` at nesting level 0 will result in a list with rendered glyphs `A.` `B.` `C.` The glyph format can contain placeholders for the current nesting level as well as placeholders for parent nesting levels. For example, a list can have a glyph format of `%0.` at nesting level 0 and a glyph format of `%0.%1.` at nesting level 1. Assuming both nesting levels have DECIMAL glyph types, this would result in a list with rendered glyphs `1.` `2.` ` 2.1.` ` 2.2.` `3.` For nesting levels that are ordered, the string that replaces a placeholder in the glyph format for a particular paragraph depends on the paragraph's order within the list. - "glyphSymbol": "A String", # A custom glyph symbol used by bullets when paragraphs at this level of nesting are unordered. The glyph symbol replaces placeholders within the glyph_format. For example, if the glyph_symbol is the solid circle corresponding to Unicode U+25cf code point and the glyph_format is `%0`, the rendered glyph would be the solid circle. - "glyphType": "A String", # The type of glyph used by bullets when paragraphs at this level of nesting are ordered. The glyph type determines the type of glyph used to replace placeholders within the glyph_format when paragraphs at this level of nesting are ordered. For example, if the nesting level is 0, the glyph_format is `%0.` and the glyph type is DECIMAL, then the rendered glyph would replace the placeholder `%0` in the glyph format with a number corresponding to list item's order within the list. - "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of paragraphs at this level of nesting. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for paragraphs at this level of nesting. Applied to the side that corresponds to the start of the text, based on the paragraph's content direction. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "startNumber": 42, # The number of the first list item at this nesting level. A value of 0 is treated as a value of 1 for lettered lists and Roman numeral lists. For values of both 0 and 1, lettered and Roman numeral lists will begin at `a` and `i` respectively. This value is ignored for nesting levels with unordered glyphs. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of bullets at this level of nesting. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address. + "personId": "A String", # Output only. The unique ID of this link. + "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present. + "email": "A String", # Output only. The email address linked to this Person. This field is always present. + "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address. }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - ], - }, - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this list. - "A String", - ], - "suggestedInsertionId": "A String", # The suggested insertion ID. If empty, then this is not a suggested insertion. - "suggestedListPropertiesChanges": { # The suggested changes to the list properties, keyed by suggestion ID. - "a_key": { # A suggested change to ListProperties. - "listProperties": { # The properties of a list that describe the look and feel of bullets belonging to paragraphs associated with a list. # A ListProperties that only includes the changes made in this suggestion. This can be used along with the list_properties_suggestion_state to see which fields have changed and their new values. - "nestingLevels": [ # Describes the properties of the bullets at the associated level. A list has at most 9 levels of nesting with nesting level 0 corresponding to the top-most level and nesting level 8 corresponding to the most nested level. The nesting levels are returned in ascending order with the least nested returned first. - { # Contains properties describing the look and feel of a list bullet at a given level of nesting. - "bulletAlignment": "A String", # The alignment of the bullet within the space allotted for rendering the bullet. - "glyphFormat": "A String", # The format string used by bullets at this level of nesting. The glyph format contains one or more placeholders, and these placeholders are replaced with the appropriate values depending on the glyph_type or glyph_symbol. The placeholders follow the pattern `%[nesting_level]`. Furthermore, placeholders can have prefixes and suffixes. Thus, the glyph format follows the pattern `%[nesting_level]`. Note that the prefix and suffix are optional and can be arbitrary strings. For example, the glyph format `%0.` indicates that the rendered glyph will replace the placeholder with the corresponding glyph for nesting level 0 followed by a period as the suffix. So a list with a glyph type of UPPER_ALPHA and glyph format `%0.` at nesting level 0 will result in a list with rendered glyphs `A.` `B.` `C.` The glyph format can contain placeholders for the current nesting level as well as placeholders for parent nesting levels. For example, a list can have a glyph format of `%0.` at nesting level 0 and a glyph format of `%0.%1.` at nesting level 1. Assuming both nesting levels have DECIMAL glyph types, this would result in a list with rendered glyphs `1.` `2.` ` 2.1.` ` 2.2.` `3.` For nesting levels that are ordered, the string that replaces a placeholder in the glyph format for a particular paragraph depends on the paragraph's order within the list. - "glyphSymbol": "A String", # A custom glyph symbol used by bullets when paragraphs at this level of nesting are unordered. The glyph symbol replaces placeholders within the glyph_format. For example, if the glyph_symbol is the solid circle corresponding to Unicode U+25cf code point and the glyph_format is `%0`, the rendered glyph would be the solid circle. - "glyphType": "A String", # The type of glyph used by bullets when paragraphs at this level of nesting are ordered. The glyph type determines the type of glyph used to replace placeholders within the glyph_format when paragraphs at this level of nesting are ordered. For example, if the nesting level is 0, the glyph_format is `%0.` and the glyph type is DECIMAL, then the rendered glyph would replace the placeholder `%0` in the glyph format with a number corresponding to list item's order within the list. - "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of paragraphs at this level of nesting. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for paragraphs at this level of nesting. Applied to the side that corresponds to the start of the text, based on the paragraph's content direction. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "startNumber": 42, # The number of the first list item at this nesting level. A value of 0 is treated as a value of 1 for lettered lists and Roman numeral lists. For values of both 0 and 1, lettered and Roman numeral lists will begin at `a` and `i` respectively. This value is ignored for nesting levels with unordered glyphs. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of bullets at this level of nesting. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. + "A String", + ], + "suggestedInsertionIds": [ # IDs for suggestions that insert this person link into the document. A Person might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this Person, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. }, }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this Person. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - ], - }, - "listPropertiesSuggestionState": { # A mask that indicates which of the fields on the base ListProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base ListProperties have been changed in this suggestion. - "nestingLevelsSuggestionStates": [ # A mask that indicates which of the fields on the corresponding NestingLevel in nesting_levels have been changed in this suggestion. The nesting level suggestion states are returned in ascending order of the nesting level with the least nested returned first. - { # A mask that indicates which of the fields on the base NestingLevel have been changed in this suggestion. For any field set to true, there's a new suggested value. - "bulletAlignmentSuggested": True or False, # Indicates if there was a suggested change to bullet_alignment. - "glyphFormatSuggested": True or False, # Indicates if there was a suggested change to glyph_format. - "glyphSymbolSuggested": True or False, # Indicates if there was a suggested change to glyph_symbol. - "glyphTypeSuggested": True or False, # Indicates if there was a suggested change to glyph_type. - "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line. - "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start. - "startNumberSuggested": True or False, # Indicates if there was a suggested change to start_number. - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. }, - }, - ], - }, - }, - }, - }, - }, - "namedRanges": { # Output only. The named ranges in the document, keyed by name. - "a_key": { # A collection of all the NamedRanges in the document that share a given name. - "name": "A String", # The name that all the named ranges share. - "namedRanges": [ # The NamedRanges that share the same name. - { # A collection of Ranges with the same named range ID. Named ranges allow developers to associate parts of a document with an arbitrary user-defined label so their contents can be programmatically read or edited later. A document can contain multiple named ranges with the same name, but every named range has a unique ID. A named range is created with a single Range, and content inserted inside a named range generally expands that range. However, certain document changes can cause the range to be split into multiple ranges. Named ranges are not private. All applications and collaborators that have access to the document can see its named ranges. - "name": "A String", # The name of the named range. - "namedRangeId": "A String", # The ID of the named range. - "ranges": [ # The ranges that belong to this named range. - { # Specifies a contiguous range of text. - "endIndex": 42, # The zero-based end index of this range, exclusive, in UTF-16 code units. In all current uses, an end index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges. - "segmentId": "A String", # The ID of the header, footer, or footnote that this range is contained in. An empty segment ID signifies the document's body. - "startIndex": 42, # The zero-based start index of this range, in UTF-16 code units. In all current uses, a start index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges. - }, - ], - }, - ], - }, - }, - "namedStyles": { # The named styles. Paragraphs in the document can inherit their TextStyle and ParagraphStyle from these named styles. # Output only. The named styles of the document. - "styles": [ # The named styles. There's an entry for each of the possible named style types. - { # A named style. Paragraphs in the document can inherit their TextStyle and ParagraphStyle from this named style when they have the same named style type. - "namedStyleType": "A String", # The type of this named style. - "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph style of this named style. - "alignment": "A String", # The text alignment for this paragraph. - "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. - "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "richLink": { # A link to a Google resource (such as a file in Drive, a YouTube video, or a Calendar event). # A paragraph element that links to a Google resource (such as a file in Google Drive, a YouTube video, or a Calendar event.) + "richLinkId": "A String", # Output only. The ID of this link. + "richLinkProperties": { # Properties specific to a RichLink. # Output only. The properties of this RichLink. This field is always present. + "mimeType": "A String", # Output only. The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the RichLink, if there's one (for example, when it's a file in Drive). + "title": "A String", # Output only. The title of the RichLink as displayed in the link. This title matches the title of the linked resource at the time of the insertion or last update of the link. This field is always present. + "uri": "A String", # Output only. The URI to the RichLink. This is always present. + }, + "suggestedDeletionIds": [ # IDs for suggestions that remove this link from the document. A RichLink might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. + "A String", + ], + "suggestedInsertionIds": [ # IDs for suggestions that insert this link into the document. A RichLink might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this RichLink, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this RichLink. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "startIndex": 42, # The zero-based start index of this paragraph element, in UTF-16 code units. + "textRun": { # A ParagraphElement that represents a run of text that all has the same styling. # A text run paragraph element. + "content": "A String", # The text of this run. Any non-text elements in the run are replaced with the Unicode character U+E907. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TextRun may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this run, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this run. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, }, }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + ], + "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The style of this paragraph. + "alignment": "A String", # The text alignment for this paragraph. + "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. + "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. - "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. - "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. - "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. - "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. - "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. - "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. - "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, }, - }, - }, - "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "spacingMode": "A String", # The spacing mode for the paragraph. - "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. - { # A tab stop within a paragraph. - "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. - "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. + "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. + "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. + "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - }, - ], - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this named style. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - ], - }, - "positionedObjects": { # Output only. The positioned objects in the document, keyed by object ID. - "a_key": { # An object that's tethered to a Paragraph and positioned relative to the beginning of the paragraph. A PositionedObject contains an EmbeddedObject such as an image. - "objectId": "A String", # The ID of this positioned object. - "positionedObjectProperties": { # Properties of a PositionedObject. # The properties of this positioned object. - "embeddedObject": { # An embedded object in the document. # The embedded object of this positioned object. - "description": "A String", # The description of the embedded object. The `title` and `description` are both combined to display alt text. - "embeddedDrawingProperties": { # The properties of an embedded drawing and used to differentiate the object type. An embedded drawing is one that's created and edited within a document. Note that extensive details are not supported. # The properties of an embedded drawing. - }, - "embeddedObjectBorder": { # A border around an EmbeddedObject. # The border of the embedded object. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "propertyState": "A String", # The property state of the border property. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "imageProperties": { # The properties of an image. # The properties of an image. - "angle": 3.14, # The clockwise rotation angle of the image, in radians. - "brightness": 3.14, # The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. - "contentUri": "A String", # A URI to the image with a default lifetime of 30 minutes. This URI is tagged with the account of the requester. Anyone with the URI effectively accesses the image as the original requester. Access to the image may be lost if the document's sharing settings change. - "contrast": 3.14, # The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. - "cropProperties": { # The crop properties of an image. The crop rectangle is represented using fractional offsets from the original content's 4 edges. - If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the image's original bounding rectangle. - If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the image's original bounding rectangle. - If all offsets and rotation angle are 0, the image is not cropped. # The crop properties of the image. - "angle": 3.14, # The clockwise rotation angle of the crop rectangle around its center, in radians. Rotation is applied after the offsets. - "offsetBottom": 3.14, # The offset specifies how far inwards the bottom edge of the crop rectangle is from the bottom edge of the original content as a fraction of the original content's height. - "offsetLeft": 3.14, # The offset specifies how far inwards the left edge of the crop rectangle is from the left edge of the original content as a fraction of the original content's width. - "offsetRight": 3.14, # The offset specifies how far inwards the right edge of the crop rectangle is from the right edge of the original content as a fraction of the original content's width. - "offsetTop": 3.14, # The offset specifies how far inwards the top edge of the crop rectangle is from the top edge of the original content as a fraction of the original content's height. - }, - "sourceUri": "A String", # The source URI is the URI used to insert the image. The source URI can be empty. - "transparency": 3.14, # The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means transparent. - }, - "linkedContentReference": { # A reference to the external linked source content. # A reference to the external linked source content. For example, it contains a reference to the source Google Sheets chart when the embedded object is a linked chart. If unset, then the embedded object is not linked. - "sheetsChartReference": { # A reference to a linked chart embedded from Google Sheets. # A reference to the linked chart. - "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that's embedded. - "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart. - }, - }, - "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom margin of the embedded object. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginLeft": { # A magnitude in a single direction in the specified units. # The left margin of the embedded object. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginRight": { # A magnitude in a single direction in the specified units. # The right margin of the embedded object. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginTop": { # A magnitude in a single direction in the specified units. # The top margin of the embedded object. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "size": { # A width and height. # The visible size of the image after cropping. - "height": { # A magnitude in a single direction in the specified units. # The height of the object. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the object. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "title": "A String", # The title of the embedded object. The `title` and `description` are both combined to display alt text. - }, - "positioning": { # The positioning of a PositionedObject. The positioned object is positioned relative to the beginning of the Paragraph it's tethered to. # The positioning of this positioned object relative to the newline of the Paragraph that references this positioned object. - "layout": "A String", # The layout of this positioned object. - "leftOffset": { # A magnitude in a single direction in the specified units. # The offset of the left edge of the positioned object relative to the beginning of the Paragraph it's tethered to. The exact positioning of the object can depend on other content in the document and the document's styling. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "topOffset": { # A magnitude in a single direction in the specified units. # The offset of the top edge of the positioned object relative to the beginning of the Paragraph it's tethered to. The exact positioning of the object can depend on other content in the document and the document's styling. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - }, - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionId": "A String", # The suggested insertion ID. If empty, then this is not a suggested insertion. - "suggestedPositionedObjectPropertiesChanges": { # The suggested changes to the positioned object properties, keyed by suggestion ID. - "a_key": { # A suggested change to PositionedObjectProperties. - "positionedObjectProperties": { # Properties of a PositionedObject. # A PositionedObjectProperties that only includes the changes made in this suggestion. This can be used along with the positioned_object_properties_suggestion_state to see which fields have changed and their new values. - "embeddedObject": { # An embedded object in the document. # The embedded object of this positioned object. - "description": "A String", # The description of the embedded object. The `title` and `description` are both combined to display alt text. - "embeddedDrawingProperties": { # The properties of an embedded drawing and used to differentiate the object type. An embedded drawing is one that's created and edited within a document. Note that extensive details are not supported. # The properties of an embedded drawing. - }, - "embeddedObjectBorder": { # A border around an EmbeddedObject. # The border of the embedded object. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. + "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. + "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. + "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. + "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. + "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -16920,653 +22276,511 @@

Method Details

}, }, }, - "dashStyle": "A String", # The dash style of the border. - "propertyState": "A String", # The property state of the border property. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "imageProperties": { # The properties of an image. # The properties of an image. - "angle": 3.14, # The clockwise rotation angle of the image, in radians. - "brightness": 3.14, # The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. - "contentUri": "A String", # A URI to the image with a default lifetime of 30 minutes. This URI is tagged with the account of the requester. Anyone with the URI effectively accesses the image as the original requester. Access to the image may be lost if the document's sharing settings change. - "contrast": 3.14, # The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. - "cropProperties": { # The crop properties of an image. The crop rectangle is represented using fractional offsets from the original content's 4 edges. - If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the image's original bounding rectangle. - If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the image's original bounding rectangle. - If all offsets and rotation angle are 0, the image is not cropped. # The crop properties of the image. - "angle": 3.14, # The clockwise rotation angle of the crop rectangle around its center, in radians. Rotation is applied after the offsets. - "offsetBottom": 3.14, # The offset specifies how far inwards the bottom edge of the crop rectangle is from the bottom edge of the original content as a fraction of the original content's height. - "offsetLeft": 3.14, # The offset specifies how far inwards the left edge of the crop rectangle is from the left edge of the original content as a fraction of the original content's width. - "offsetRight": 3.14, # The offset specifies how far inwards the right edge of the crop rectangle is from the right edge of the original content as a fraction of the original content's width. - "offsetTop": 3.14, # The offset specifies how far inwards the top edge of the crop rectangle is from the top edge of the original content as a fraction of the original content's height. - }, - "sourceUri": "A String", # The source URI is the URI used to insert the image. The source URI can be empty. - "transparency": 3.14, # The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means transparent. - }, - "linkedContentReference": { # A reference to the external linked source content. # A reference to the external linked source content. For example, it contains a reference to the source Google Sheets chart when the embedded object is a linked chart. If unset, then the embedded object is not linked. - "sheetsChartReference": { # A reference to a linked chart embedded from Google Sheets. # A reference to the linked chart. - "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that's embedded. - "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart. - }, - }, - "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom margin of the embedded object. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. }, - "marginLeft": { # A magnitude in a single direction in the specified units. # The left margin of the embedded object. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginRight": { # A magnitude in a single direction in the specified units. # The right margin of the embedded object. + "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginTop": { # A magnitude in a single direction in the specified units. # The top margin of the embedded object. + "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "size": { # A width and height. # The visible size of the image after cropping. - "height": { # A magnitude in a single direction in the specified units. # The height of the object. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the object. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "spacingMode": "A String", # The spacing mode for the paragraph. + "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. + { # A tab stop within a paragraph. + "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. + "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - }, - "title": "A String", # The title of the embedded object. The `title` and `description` are both combined to display alt text. + ], }, - "positioning": { # The positioning of a PositionedObject. The positioned object is positioned relative to the beginning of the Paragraph it's tethered to. # The positioning of this positioned object relative to the newline of the Paragraph that references this positioned object. - "layout": "A String", # The layout of this positioned object. - "leftOffset": { # A magnitude in a single direction in the specified units. # The offset of the left edge of the positioned object relative to the beginning of the Paragraph it's tethered to. The exact positioning of the object can depend on other content in the document and the document's styling. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "topOffset": { # A magnitude in a single direction in the specified units. # The offset of the top edge of the positioned object relative to the beginning of the Paragraph it's tethered to. The exact positioning of the object can depend on other content in the document and the document's styling. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "positionedObjectIds": [ # The IDs of the positioned objects tethered to this paragraph. + "A String", + ], + "suggestedBulletChanges": { # The suggested changes to this paragraph's bullet. + "a_key": { # A suggested change to a Bullet. + "bullet": { # Describes the bullet of a paragraph. # A Bullet that only includes the changes made in this suggestion. This can be used along with the bullet_suggestion_state to see which fields have changed and their new values. + "listId": "A String", # The ID of the list this paragraph belongs to. + "nestingLevel": 42, # The nesting level of this paragraph in the list. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "bulletSuggestionState": { # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. + "listIdSuggested": True or False, # Indicates if there was a suggested change to the list_id. + "nestingLevelSuggested": True or False, # Indicates if there was a suggested change to the nesting_level. + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, }, }, - }, - "positionedObjectPropertiesSuggestionState": { # A mask that indicates which of the fields on the base PositionedObjectProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base PositionedObjectProperties have been changed in this suggestion. - "embeddedObjectSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedObject have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_object have been changed in this suggestion. - "descriptionSuggested": True or False, # Indicates if there was a suggested change to description. - "embeddedDrawingPropertiesSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedDrawingProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_drawing_properties have been changed in this suggestion. - }, - "embeddedObjectBorderSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedObjectBorder have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_object_border have been changed in this suggestion. - "colorSuggested": True or False, # Indicates if there was a suggested change to color. - "dashStyleSuggested": True or False, # Indicates if there was a suggested change to dash_style. - "propertyStateSuggested": True or False, # Indicates if there was a suggested change to property_state. - "widthSuggested": True or False, # Indicates if there was a suggested change to width. - }, - "imagePropertiesSuggestionState": { # A mask that indicates which of the fields on the base ImageProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in image_properties have been changed in this suggestion. - "angleSuggested": True or False, # Indicates if there was a suggested change to angle. - "brightnessSuggested": True or False, # Indicates if there was a suggested change to brightness. - "contentUriSuggested": True or False, # Indicates if there was a suggested change to content_uri. - "contrastSuggested": True or False, # Indicates if there was a suggested change to contrast. - "cropPropertiesSuggestionState": { # A mask that indicates which of the fields on the base CropProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in crop_properties have been changed in this suggestion. - "angleSuggested": True or False, # Indicates if there was a suggested change to angle. - "offsetBottomSuggested": True or False, # Indicates if there was a suggested change to offset_bottom. - "offsetLeftSuggested": True or False, # Indicates if there was a suggested change to offset_left. - "offsetRightSuggested": True or False, # Indicates if there was a suggested change to offset_right. - "offsetTopSuggested": True or False, # Indicates if there was a suggested change to offset_top. + "suggestedParagraphStyleChanges": { # The suggested paragraph style changes to this paragraph, keyed by suggestion ID. + "a_key": { # A suggested change to a ParagraphStyle. + "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A ParagraphStyle that only includes the changes made in this suggestion. This can be used along with the paragraph_style_suggestion_state to see which fields have changed and their new values. + "alignment": "A String", # The text alignment for this paragraph. + "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. + "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. + "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. + "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. + "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. + "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. + "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. + "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. + "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + }, + "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spacingMode": "A String", # The spacing mode for the paragraph. + "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. + { # A tab stop within a paragraph. + "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. + "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + ], }, - "sourceUriSuggested": True or False, # Indicates if there was a suggested change to source_uri. - "transparencySuggested": True or False, # Indicates if there was a suggested change to transparency. - }, - "linkedContentReferenceSuggestionState": { # A mask that indicates which of the fields on the base LinkedContentReference have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in linked_content_reference have been changed in this suggestion. - "sheetsChartReferenceSuggestionState": { # A mask that indicates which of the fields on the base SheetsChartReference have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in sheets_chart_reference have been changed in this suggestion. - "chartIdSuggested": True or False, # Indicates if there was a suggested change to chart_id. - "spreadsheetIdSuggested": True or False, # Indicates if there was a suggested change to spreadsheet_id. + "paragraphStyleSuggestionState": { # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. + "alignmentSuggested": True or False, # Indicates if there was a suggested change to alignment. + "avoidWidowAndOrphanSuggested": True or False, # Indicates if there was a suggested change to avoid_widow_and_orphan. + "borderBetweenSuggested": True or False, # Indicates if there was a suggested change to border_between. + "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. + "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. + "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. + "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. + "directionSuggested": True or False, # Indicates if there was a suggested change to direction. + "headingIdSuggested": True or False, # Indicates if there was a suggested change to heading_id. + "indentEndSuggested": True or False, # Indicates if there was a suggested change to indent_end. + "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line. + "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start. + "keepLinesTogetherSuggested": True or False, # Indicates if there was a suggested change to keep_lines_together. + "keepWithNextSuggested": True or False, # Indicates if there was a suggested change to keep_with_next. + "lineSpacingSuggested": True or False, # Indicates if there was a suggested change to line_spacing. + "namedStyleTypeSuggested": True or False, # Indicates if there was a suggested change to named_style_type. + "pageBreakBeforeSuggested": True or False, # Indicates if there was a suggested change to page_break_before. + "shadingSuggestionState": { # A mask that indicates which of the fields on the base Shading have been changed in this suggested change. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in shading have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to the Shading. + }, + "spaceAboveSuggested": True or False, # Indicates if there was a suggested change to space_above. + "spaceBelowSuggested": True or False, # Indicates if there was a suggested change to space_below. + "spacingModeSuggested": True or False, # Indicates if there was a suggested change to spacing_mode. }, }, - "marginBottomSuggested": True or False, # Indicates if there was a suggested change to margin_bottom. - "marginLeftSuggested": True or False, # Indicates if there was a suggested change to margin_left. - "marginRightSuggested": True or False, # Indicates if there was a suggested change to margin_right. - "marginTopSuggested": True or False, # Indicates if there was a suggested change to margin_top. - "sizeSuggestionState": { # A mask that indicates which of the fields on the base Size have been changed in this suggestion. For any field set to true, the Size has a new suggested value. # A mask that indicates which of the fields in size have been changed in this suggestion. - "heightSuggested": True or False, # Indicates if there was a suggested change to height. - "widthSuggested": True or False, # Indicates if there was a suggested change to width. - }, - "titleSuggested": True or False, # Indicates if there was a suggested change to title. - }, - "positioningSuggestionState": { # A mask that indicates which of the fields on the base PositionedObjectPositioning have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in positioning have been changed in this suggestion. - "layoutSuggested": True or False, # Indicates if there was a suggested change to layout. - "leftOffsetSuggested": True or False, # Indicates if there was a suggested change to left_offset. - "topOffsetSuggested": True or False, # Indicates if there was a suggested change to top_offset. }, - }, - }, - }, - }, - }, - "revisionId": "A String", # Output only. The revision ID of the document. Can be used in update requests to specify which revision of a document to apply updates to and how the request should behave if the document has been edited since that revision. Only populated if the user has edit access to the document. The revision ID is not a sequential number but an opaque string. The format of the revision ID might change over time. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the document has not changed. Conversely, a changed ID (for the same document and user) usually means the document has been updated. However, a changed ID can also be due to internal factors such as ID format changes. - "suggestedDocumentStyleChanges": { # Output only. The suggested changes to the style of the document, keyed by suggestion ID. - "a_key": { # A suggested change to the DocumentStyle. - "documentStyle": { # The style of the document. # A DocumentStyle that only includes the changes made in this suggestion. This can be used along with the document_style_suggestion_state to see which fields have changed and their new values. - "background": { # Represents the background of a document. # The background of the document. Documents cannot have a transparent background color. - "color": { # A color that can either be fully opaque or fully transparent. # The background color. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "suggestedPositionedObjectIds": { # The IDs of the positioned objects suggested to be attached to this paragraph, keyed by suggestion ID. + "a_key": { # A collection of object IDs. + "objectIds": [ # The object IDs. + "A String", + ], }, }, }, - }, - "defaultFooterId": "A String", # The ID of the default footer. If not set, there's no default footer. This property is read-only. - "defaultHeaderId": "A String", # The ID of the default header. If not set, there's no default header. This property is read-only. - "evenPageFooterId": "A String", # The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. This property is read-only. - "evenPageHeaderId": "A String", # The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. This property is read-only. - "firstPageFooterId": "A String", # The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. This property is read-only. - "firstPageHeaderId": "A String", # The ID of the header used only for the first page. If not set then a unique header for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_header_id or this value for the header on the first page. If not set, there's no first page header. This property is read-only. - "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of the page_size, which allows changing the page orientation between portrait and landscape. - "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin. Updating the bottom page margin on the document style clears the bottom page margin on all section styles. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginFooter": { # A magnitude in a single direction in the specified units. # The amount of space between the bottom of the page and the contents of the footer. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginHeader": { # A magnitude in a single direction in the specified units. # The amount of space between the top of the page and the contents of the header. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin. Updating the left page margin on the document style clears the left page margin on all section styles. It may also cause columns to resize in all sections. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin. Updating the right page margin on the document style clears the right page margin on all section styles. It may also cause columns to resize in all sections. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin. Updating the top page margin on the document style clears the top page margin on all section styles. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "pageNumberStart": 42, # The page number from which to start counting the number of pages. - "pageSize": { # A width and height. # The size of a page in the document. - "height": { # A magnitude in a single direction in the specified units. # The height of the object. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the object. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "useCustomHeaderFooterMargins": True or False, # Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected. When false, the default values in the Docs editor for header and footer margin are used. This property is read-only. - "useEvenPageHeaderFooter": True or False, # Indicates whether to use the even page header / footer IDs for the even pages. - "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page. - }, - "documentStyleSuggestionState": { # A mask that indicates which of the fields on the base DocumentStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DocumentStyle have been changed in this suggestion. - "backgroundSuggestionState": { # A mask that indicates which of the fields on the base Background have been changed in this suggestion. For any field set to true, the Backgound has a new suggested value. # A mask that indicates which of the fields in background have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates whether the current background color has been modified in this suggestion. - }, - "defaultFooterIdSuggested": True or False, # Indicates if there was a suggested change to default_footer_id. - "defaultHeaderIdSuggested": True or False, # Indicates if there was a suggested change to default_header_id. - "evenPageFooterIdSuggested": True or False, # Indicates if there was a suggested change to even_page_footer_id. - "evenPageHeaderIdSuggested": True or False, # Indicates if there was a suggested change to even_page_header_id. - "firstPageFooterIdSuggested": True or False, # Indicates if there was a suggested change to first_page_footer_id. - "firstPageHeaderIdSuggested": True or False, # Indicates if there was a suggested change to first_page_header_id. - "flipPageOrientationSuggested": True or False, # Optional. Indicates if there was a suggested change to flip_page_orientation. - "marginBottomSuggested": True or False, # Indicates if there was a suggested change to margin_bottom. - "marginFooterSuggested": True or False, # Indicates if there was a suggested change to margin_footer. - "marginHeaderSuggested": True or False, # Indicates if there was a suggested change to margin_header. - "marginLeftSuggested": True or False, # Indicates if there was a suggested change to margin_left. - "marginRightSuggested": True or False, # Indicates if there was a suggested change to margin_right. - "marginTopSuggested": True or False, # Indicates if there was a suggested change to margin_top. - "pageNumberStartSuggested": True or False, # Indicates if there was a suggested change to page_number_start. - "pageSizeSuggestionState": { # A mask that indicates which of the fields on the base Size have been changed in this suggestion. For any field set to true, the Size has a new suggested value. # A mask that indicates which of the fields in size have been changed in this suggestion. - "heightSuggested": True or False, # Indicates if there was a suggested change to height. - "widthSuggested": True or False, # Indicates if there was a suggested change to width. - }, - "useCustomHeaderFooterMarginsSuggested": True or False, # Indicates if there was a suggested change to use_custom_header_footer_margins. - "useEvenPageHeaderFooterSuggested": True or False, # Indicates if there was a suggested change to use_even_page_header_footer. - "useFirstPageHeaderFooterSuggested": True or False, # Indicates if there was a suggested change to use_first_page_header_footer. - }, - }, - }, - "suggestedNamedStylesChanges": { # Output only. The suggested changes to the named styles of the document, keyed by suggestion ID. - "a_key": { # A suggested change to the NamedStyles. - "namedStyles": { # The named styles. Paragraphs in the document can inherit their TextStyle and ParagraphStyle from these named styles. # A NamedStyles that only includes the changes made in this suggestion. This can be used along with the named_styles_suggestion_state to see which fields have changed and their new values. - "styles": [ # The named styles. There's an entry for each of the possible named style types. - { # A named style. Paragraphs in the document can inherit their TextStyle and ParagraphStyle from this named style when they have the same named style type. - "namedStyleType": "A String", # The type of this named style. - "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph style of this named style. - "alignment": "A String", # The text alignment for this paragraph. - "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. - "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + "sectionBreak": { # A StructuralElement representing a section break. A section is a range of content that has the same SectionStyle. A section break represents the start of a new section, and the section style applies to the section after the section break. The document body always begins with a section break. # A section break type of structural element. + "sectionStyle": { # The styling that applies to a section. # The style of the section after this section break. + "columnProperties": [ # The section's columns properties. If empty, the section contains one column with the default properties in the Docs editor. A section can be updated to have no more than 3 columns. When updating this property, setting a concrete value is required. Unsetting this property will result in a 400 bad request error. + { # Properties that apply to a section's column. + "paddingEnd": { # A magnitude in a single direction in the specified units. # The padding at the end of the column. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + "width": { # A magnitude in a single direction in the specified units. # Output only. The width of the column. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. - "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. - "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + ], + "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only. + "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only. + "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only. + "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only. + "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only. + "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only. + "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. + "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. - "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. - "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. - "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. - "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. - "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - }, - "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. + "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. + "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "spacingMode": "A String", # The spacing mode for the paragraph. - "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. - { # A tab stop within a paragraph. - "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. - "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - ], - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this named style. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - ], - }, - "namedStylesSuggestionState": { # The suggestion state of a NamedStyles message. # A mask that indicates which of the fields on the base NamedStyles have been changed in this suggestion. - "stylesSuggestionStates": [ # A mask that indicates which of the fields on the corresponding NamedStyle in styles have been changed in this suggestion. The order of these named style suggestion states matches the order of the corresponding named style within the named styles suggestion. - { # A suggestion state of a NamedStyle message. - "namedStyleType": "A String", # The named style type that this suggestion state corresponds to. This field is provided as a convenience for matching the NamedStyleSuggestionState with its corresponding NamedStyle. - "paragraphStyleSuggestionState": { # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in paragraph style have been changed in this suggestion. - "alignmentSuggested": True or False, # Indicates if there was a suggested change to alignment. - "avoidWidowAndOrphanSuggested": True or False, # Indicates if there was a suggested change to avoid_widow_and_orphan. - "borderBetweenSuggested": True or False, # Indicates if there was a suggested change to border_between. - "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. - "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. - "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. - "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. - "directionSuggested": True or False, # Indicates if there was a suggested change to direction. - "headingIdSuggested": True or False, # Indicates if there was a suggested change to heading_id. - "indentEndSuggested": True or False, # Indicates if there was a suggested change to indent_end. - "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line. - "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start. - "keepLinesTogetherSuggested": True or False, # Indicates if there was a suggested change to keep_lines_together. - "keepWithNextSuggested": True or False, # Indicates if there was a suggested change to keep_with_next. - "lineSpacingSuggested": True or False, # Indicates if there was a suggested change to line_spacing. - "namedStyleTypeSuggested": True or False, # Indicates if there was a suggested change to named_style_type. - "pageBreakBeforeSuggested": True or False, # Indicates if there was a suggested change to page_break_before. - "shadingSuggestionState": { # A mask that indicates which of the fields on the base Shading have been changed in this suggested change. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in shading have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to the Shading. - }, - "spaceAboveSuggested": True or False, # Indicates if there was a suggested change to space_above. - "spaceBelowSuggested": True or False, # Indicates if there was a suggested change to space_below. - "spacingModeSuggested": True or False, # Indicates if there was a suggested change to spacing_mode. - }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, - }, - ], - }, - }, - }, - "suggestionsViewMode": "A String", # Output only. The suggestions view mode applied to the document. Note: When editing a document, changes must be based on a document with SUGGESTIONS_INLINE. - "title": "A String", # The title of the document. -} -
- -
- get(documentId, suggestionsViewMode=None, x__xgafv=None) -
Gets the latest version of the specified document.
-
-Args:
-  documentId: string, The ID of the document to retrieve. (required)
-  suggestionsViewMode: string, The suggestions view mode to apply to the document. This allows viewing the document with all suggestions inline, accepted or rejected. If one is not specified, DEFAULT_FOR_CURRENT_ACCESS is used.
-    Allowed values
-      DEFAULT_FOR_CURRENT_ACCESS - The SuggestionsViewMode applied to the returned document depends on the user's current access level. If the user only has view access, PREVIEW_WITHOUT_SUGGESTIONS is applied. Otherwise, SUGGESTIONS_INLINE is applied. This is the default suggestions view mode.
-      SUGGESTIONS_INLINE - The returned document has suggestions inline. Suggested changes will be differentiated from base content within the document. Requests to retrieve a document using this mode will return a 403 error if the user does not have permission to view suggested changes.
-      PREVIEW_SUGGESTIONS_ACCEPTED - The returned document is a preview with all suggested changes accepted. Requests to retrieve a document using this mode will return a 403 error if the user does not have permission to view suggested changes.
-      PREVIEW_WITHOUT_SUGGESTIONS - The returned document is a preview with all suggested changes rejected if there are any suggestions in the document.
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # A Google Docs document.
-  "body": { # The document body. The body typically contains the full document contents except for headers, footers, and footnotes. # Output only. The main body of the document.
-    "content": [ # The contents of the body. The indexes for the body's content begin at zero.
-      { # A StructuralElement describes content that provides structure to the document.
-        "endIndex": 42, # The zero-based end index of this structural element, exclusive, in UTF-16 code units.
-        "paragraph": { # A StructuralElement representing a paragraph. A paragraph is a range of content that's terminated with a newline character. # A paragraph type of structural element.
-          "bullet": { # Describes the bullet of a paragraph. # The bullet for this paragraph. If not present, the paragraph does not belong to a list.
-            "listId": "A String", # The ID of the list this paragraph belongs to.
-            "nestingLevel": 42, # The nesting level of this paragraph in the list.
-            "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet.
-              "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
-                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
-                  "rgbColor": { # An RGB color. # The RGB color value.
-                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
-                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
-                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
-                  },
-                },
-              },
-              "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
-              "bold": True or False, # Whether or not the text is rendered as bold.
-              "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
-                "magnitude": 3.14, # The magnitude.
-                "unit": "A String", # The units for magnitude.
-              },
-              "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
-                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
-                  "rgbColor": { # An RGB color. # The RGB color value.
-                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
-                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
-                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
-                  },
-                },
-              },
-              "italic": True or False, # Whether or not the text is italicized.
-              "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
-                "bookmarkId": "A String", # The ID of a bookmark in this document.
-                "headingId": "A String", # The ID of a heading in this document.
-                "url": "A String", # An external URL.
-              },
-              "smallCaps": True or False, # Whether or not the text is in small capital letters.
-              "strikethrough": True or False, # Whether or not the text is struck through.
-              "underline": True or False, # Whether or not the text is underlined.
-              "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
-                "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
-                "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
-              },
+              "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+              "sectionType": "A String", # Output only. The type of section.
+              "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
             },
+            "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+              "A String",
+            ],
+            "suggestedInsertionIds": [ # The suggested insertion IDs. A SectionBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+              "A String",
+            ],
           },
-          "elements": [ # The content of the paragraph, broken down into its component parts.
-            { # A ParagraphElement describes content within a Paragraph.
-              "autoText": { # A ParagraphElement representing a spot in the text that's dynamically replaced with content that can change over time, like a page number. # An auto text paragraph element.
+          "startIndex": 42, # The zero-based start index of this structural element, in UTF-16 code units.
+          "table": { # A StructuralElement representing a table. # A table type of structural element.
+            "columns": 42, # Number of columns in the table. It's possible for a table to be non-rectangular, so some rows may have a different number of cells.
+            "rows": 42, # Number of rows in the table.
+            "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+              "A String",
+            ],
+            "suggestedInsertionIds": [ # The suggested insertion IDs. A Table may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+              "A String",
+            ],
+            "tableRows": [ # The contents and style of each row.
+              { # The contents and style of a row in a Table.
+                "endIndex": 42, # The zero-based end index of this row, exclusive, in UTF-16 code units.
+                "startIndex": 42, # The zero-based start index of this row, in UTF-16 code units.
                 "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
                   "A String",
                 ],
-                "suggestedInsertionIds": [ # The suggested insertion IDs. An AutoText may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                "suggestedInsertionIds": [ # The suggested insertion IDs. A TableRow may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
                   "A String",
                 ],
-                "suggestedTextStyleChanges": { # The suggested text style changes to this AutoText, keyed by suggestion ID.
-                  "a_key": { # A suggested change to a TextStyle.
-                    "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
-                      "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
-                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
-                          "rgbColor": { # An RGB color. # The RGB color value.
-                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
-                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
-                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
-                          },
-                        },
-                      },
-                      "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
-                      "bold": True or False, # Whether or not the text is rendered as bold.
-                      "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                "suggestedTableRowStyleChanges": { # The suggested style changes to this row, keyed by suggestion ID.
+                  "a_key": { # A suggested change to a TableRowStyle.
+                    "tableRowStyle": { # Styles that apply to a table row. # A TableRowStyle that only includes the changes made in this suggestion. This can be used along with the table_row_style_suggestion_state to see which fields have changed and their new values.
+                      "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells.
                         "magnitude": 3.14, # The magnitude.
                         "unit": "A String", # The units for magnitude.
                       },
-                      "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
-                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
-                          "rgbColor": { # An RGB color. # The RGB color value.
-                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
-                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
-                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
-                          },
-                        },
-                      },
-                      "italic": True or False, # Whether or not the text is italicized.
-                      "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
-                        "bookmarkId": "A String", # The ID of a bookmark in this document.
-                        "headingId": "A String", # The ID of a heading in this document.
-                        "url": "A String", # An external URL.
-                      },
-                      "smallCaps": True or False, # Whether or not the text is in small capital letters.
-                      "strikethrough": True or False, # Whether or not the text is struck through.
-                      "underline": True or False, # Whether or not the text is underlined.
-                      "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
-                        "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
-                        "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
-                      },
-                    },
-                    "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
-                      "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
-                      "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
-                      "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
-                      "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
-                      "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
-                      "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
-                      "linkSuggested": True or False, # Indicates if there was a suggested change to link.
-                      "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
-                      "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
-                      "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
-                      "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
-                    },
-                  },
-                },
-                "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this AutoText.
-                  "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
-                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
-                      "rgbColor": { # An RGB color. # The RGB color value.
-                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
-                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
-                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
-                      },
+                      "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries.
+                      "tableHeader": True or False, # Whether the row is a table header.
                     },
-                  },
-                  "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
-                  "bold": True or False, # Whether or not the text is rendered as bold.
-                  "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
-                    "magnitude": 3.14, # The magnitude.
-                    "unit": "A String", # The units for magnitude.
-                  },
-                  "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
-                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
-                      "rgbColor": { # An RGB color. # The RGB color value.
-                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
-                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
-                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
-                      },
+                    "tableRowStyleSuggestionState": { # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion.
+                      "minRowHeightSuggested": True or False, # Indicates if there was a suggested change to min_row_height.
                     },
                   },
-                  "italic": True or False, # Whether or not the text is italicized.
-                  "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
-                    "bookmarkId": "A String", # The ID of a bookmark in this document.
-                    "headingId": "A String", # The ID of a heading in this document.
-                    "url": "A String", # An external URL.
-                  },
-                  "smallCaps": True or False, # Whether or not the text is in small capital letters.
-                  "strikethrough": True or False, # Whether or not the text is struck through.
-                  "underline": True or False, # Whether or not the text is underlined.
-                  "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
-                    "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
-                    "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
-                  },
                 },
-                "type": "A String", # The type of this auto text.
-              },
-              "columnBreak": { # A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column. # A column break paragraph element.
-                "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
-                  "A String",
-                ],
-                "suggestedInsertionIds": [ # The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
-                  "A String",
-                ],
-                "suggestedTextStyleChanges": { # The suggested text style changes to this ColumnBreak, keyed by suggestion ID.
-                  "a_key": { # A suggested change to a TextStyle.
-                    "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
-                      "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                "tableCells": [ # The contents and style of each cell in this row. It's possible for a table to be non-rectangular, so some rows may have a different number of cells than other rows in the same table.
+                  { # The contents and style of a cell in a Table.
+                    "content": [ # The content of the cell.
+                      # Object with schema name: StructuralElement
+                    ],
+                    "endIndex": 42, # The zero-based end index of this cell, exclusive, in UTF-16 code units.
+                    "startIndex": 42, # The zero-based start index of this cell, in UTF-16 code units.
+                    "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                      "A String",
+                    ],
+                    "suggestedInsertionIds": [ # The suggested insertion IDs. A TableCell may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                      "A String",
+                    ],
+                    "suggestedTableCellStyleChanges": { # The suggested changes to the table cell style, keyed by suggestion ID.
+                      "a_key": { # A suggested change to a TableCellStyle.
+                        "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # A TableCellStyle that only includes the changes made in this suggestion. This can be used along with the table_cell_style_suggestion_state to see which fields have changed and their new values.
+                          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell.
+                            "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "dashStyle": "A String", # The dash style of the border.
+                            "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                          },
+                          "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell.
+                            "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "dashStyle": "A String", # The dash style of the border.
+                            "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                          },
+                          "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell.
+                            "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "dashStyle": "A String", # The dash style of the border.
+                            "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                          },
+                          "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell.
+                            "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "dashStyle": "A String", # The dash style of the border.
+                            "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                          },
+                          "columnSpan": 42, # The column span of the cell. This property is read-only.
+                          "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor.
+                          "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "rowSpan": 42, # The row span of the cell. This property is read-only.
+                        },
+                        "tableCellStyleSuggestionState": { # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion.
+                          "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                          "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom.
+                          "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left.
+                          "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right.
+                          "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top.
+                          "columnSpanSuggested": True or False, # Indicates if there was a suggested change to column_span.
+                          "contentAlignmentSuggested": True or False, # Indicates if there was a suggested change to content_alignment.
+                          "paddingBottomSuggested": True or False, # Indicates if there was a suggested change to padding_bottom.
+                          "paddingLeftSuggested": True or False, # Indicates if there was a suggested change to padding_left.
+                          "paddingRightSuggested": True or False, # Indicates if there was a suggested change to padding_right.
+                          "paddingTopSuggested": True or False, # Indicates if there was a suggested change to padding_top.
+                          "rowSpanSuggested": True or False, # Indicates if there was a suggested change to row_span.
+                        },
+                      },
+                    },
+                    "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # The style of the cell.
+                      "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell.
                         "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
                           "rgbColor": { # An RGB color. # The RGB color value.
                             "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
@@ -17575,1466 +22789,1562 @@ 

Method Details

}, }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. + "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, - }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "columnSpan": 42, # The column span of the cell. This property is read-only. + "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. + "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, + "rowSpan": 42, # The row span of the cell. This property is read-only. }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + ], + "tableRowStyle": { # Styles that apply to a table row. # The style of the table row. + "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries. + "tableHeader": True or False, # Whether the row is a table header. + }, + }, + ], + "tableStyle": { # Styles that apply to a table. # The style of the table. + "tableColumnProperties": [ # The properties of each column. Note that in Docs, tables contain rows and rows contain cells, similar to HTML. So the properties for a row can be found on the row's table_row_style. + { # The properties of a column in a table. + "width": { # A magnitude in a single direction in the specified units. # The width of the column. Set when the column's `width_type` is FIXED_WIDTH. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "widthType": "A String", # The width type of the column. + }, + ], + }, + }, + "tableOfContents": { # A StructuralElement representing a table of contents. # A table of contents type of structural element. + "content": [ # The content of the table of contents. + # Object with schema name: StructuralElement + ], + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TableOfContents may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + }, + }, + ], + "footerId": "A String", # The ID of the footer. + }, + }, + "footnotes": { # Output only. The footnotes in the document, keyed by footnote ID. + "a_key": { # A document footnote. + "content": [ # The contents of the footnote. The indexes for a footnote's content begin at zero. + { # A StructuralElement describes content that provides structure to the document. + "endIndex": 42, # The zero-based end index of this structural element, exclusive, in UTF-16 code units. + "paragraph": { # A StructuralElement representing a paragraph. A paragraph is a range of content that's terminated with a newline character. # A paragraph type of structural element. + "bullet": { # Describes the bullet of a paragraph. # The bullet for this paragraph. If not present, the paragraph does not belong to a list. + "listId": "A String", # The ID of the list this paragraph belongs to. + "nestingLevel": 42, # The nesting level of this paragraph in the list. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, - "endIndex": 42, # The zero-base end index of this paragraph element, exclusive, in UTF-16 code units. - "equation": { # A ParagraphElement representing an equation. # An equation paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. An Equation may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - }, - "footnoteReference": { # A ParagraphElement representing a footnote reference. A footnote reference is the inline content rendered with a number and is used to identify the footnote. # A footnote reference paragraph element. - "footnoteId": "A String", # The ID of the footnote that contains the content of this footnote reference. - "footnoteNumber": "A String", # The rendered number of this footnote. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this FootnoteReference, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "elements": [ # The content of the paragraph, broken down into its component parts. + { # A ParagraphElement describes content within a Paragraph. + "autoText": { # A ParagraphElement representing a spot in the text that's dynamically replaced with content that can change over time, like a page number. # An auto text paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. An AutoText may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this AutoText, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this AutoText. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, + "type": "A String", # The type of this auto text. }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this FootnoteReference. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - "horizontalRule": { # A ParagraphElement representing a horizontal line. # A horizontal rule paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A HorizontalRule may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this HorizontalRule, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "columnBreak": { # A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column. # A column break paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this ColumnBreak, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. }, }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this HorizontalRule. Similar to text content, like text runs and footnote references, the text style of a horizontal rule can affect content layout as well as the styling of text inserted next to it. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - "inlineObjectElement": { # A ParagraphElement that contains an InlineObject. # An inline object paragraph element. - "inlineObjectId": "A String", # The ID of the InlineObject this element contains. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. An InlineObjectElement may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this InlineObject, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this InlineObjectElement. Similar to text content, like text runs and footnote references, the text style of an inline object element can affect content layout as well as the styling of text inserted next to it. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, + "endIndex": 42, # The zero-base end index of this paragraph element, exclusive, in UTF-16 code units. + "equation": { # A ParagraphElement representing an equation. # An equation paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. An Equation may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], }, - }, - "pageBreak": { # A ParagraphElement representing a page break. A page break makes the subsequent text start at the top of the next page. # A page break paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A PageBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this PageBreak, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "footnoteReference": { # A ParagraphElement representing a footnote reference. A footnote reference is the inline content rendered with a number and is used to identify the footnote. # A footnote reference paragraph element. + "footnoteId": "A String", # The ID of the footnote that contains the content of this footnote reference. + "footnoteNumber": "A String", # The rendered number of this footnote. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this FootnoteReference, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this FootnoteReference. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this PageBreak. Similar to text content, like text runs and footnote references, the text style of a page break can affect content layout as well as the styling of text inserted next to it. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - "person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address. - "personId": "A String", # Output only. The unique ID of this link. - "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present. - "email": "A String", # Output only. The email address linked to this Person. This field is always present. - "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address. }, - "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. - "A String", - ], - "suggestedInsertionIds": [ # IDs for suggestions that insert this person link into the document. A Person might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this Person, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "horizontalRule": { # A ParagraphElement representing a horizontal line. # A horizontal rule paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A HorizontalRule may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this HorizontalRule, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. }, }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this Person. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this HorizontalRule. Similar to text content, like text runs and footnote references, the text style of a horizontal rule can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - "richLink": { # A link to a Google resource (such as a file in Drive, a YouTube video, or a Calendar event). # A paragraph element that links to a Google resource (such as a file in Google Drive, a YouTube video, or a Calendar event.) - "richLinkId": "A String", # Output only. The ID of this link. - "richLinkProperties": { # Properties specific to a RichLink. # Output only. The properties of this RichLink. This field is always present. - "mimeType": "A String", # Output only. The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the RichLink, if there's one (for example, when it's a file in Drive). - "title": "A String", # Output only. The title of the RichLink as displayed in the link. This title matches the title of the linked resource at the time of the insertion or last update of the link. This field is always present. - "uri": "A String", # Output only. The URI to the RichLink. This is always present. - }, - "suggestedDeletionIds": [ # IDs for suggestions that remove this link from the document. A RichLink might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. - "A String", - ], - "suggestedInsertionIds": [ # IDs for suggestions that insert this link into the document. A RichLink might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this RichLink, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this RichLink. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "inlineObjectElement": { # A ParagraphElement that contains an InlineObject. # An inline object paragraph element. + "inlineObjectId": "A String", # The ID of the InlineObject this element contains. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. An InlineObjectElement may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this InlineObject, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. }, }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - "startIndex": 42, # The zero-based start index of this paragraph element, in UTF-16 code units. - "textRun": { # A ParagraphElement that represents a run of text that all has the same styling. # A text run paragraph element. - "content": "A String", # The text of this run. Any non-text elements in the run are replaced with the Unicode character U+E907. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A TextRun may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this run, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this InlineObjectElement. Similar to text content, like text runs and footnote references, the text style of an inline object element can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this run. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "pageBreak": { # A ParagraphElement representing a page break. A page break makes the subsequent text start at the top of the next page. # A page break paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A PageBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this PageBreak, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. }, }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - }, - ], - "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The style of this paragraph. - "alignment": "A String", # The text alignment for this paragraph. - "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. - "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this PageBreak. Similar to text content, like text runs and footnote references, the text style of a page break can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, }, }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address. + "personId": "A String", # Output only. The unique ID of this link. + "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present. + "email": "A String", # Output only. The email address linked to this Person. This field is always present. + "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address. }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. + "A String", + ], + "suggestedInsertionIds": [ # IDs for suggestions that insert this person link into the document. A Person might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this Person, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this Person. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, }, }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "richLink": { # A link to a Google resource (such as a file in Drive, a YouTube video, or a Calendar event). # A paragraph element that links to a Google resource (such as a file in Google Drive, a YouTube video, or a Calendar event.) + "richLinkId": "A String", # Output only. The ID of this link. + "richLinkProperties": { # Properties specific to a RichLink. # Output only. The properties of this RichLink. This field is always present. + "mimeType": "A String", # Output only. The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the RichLink, if there's one (for example, when it's a file in Drive). + "title": "A String", # Output only. The title of the RichLink as displayed in the link. This title matches the title of the linked resource at the time of the insertion or last update of the link. This field is always present. + "uri": "A String", # Output only. The URI to the RichLink. This is always present. }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. - "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. - "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. - "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. - "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. - "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. - "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. - "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - }, - "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "spacingMode": "A String", # The spacing mode for the paragraph. - "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. - { # A tab stop within a paragraph. - "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. - "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - ], - }, - "positionedObjectIds": [ # The IDs of the positioned objects tethered to this paragraph. - "A String", - ], - "suggestedBulletChanges": { # The suggested changes to this paragraph's bullet. - "a_key": { # A suggested change to a Bullet. - "bullet": { # Describes the bullet of a paragraph. # A Bullet that only includes the changes made in this suggestion. This can be used along with the bullet_suggestion_state to see which fields have changed and their new values. - "listId": "A String", # The ID of the list this paragraph belongs to. - "nestingLevel": 42, # The nesting level of this paragraph in the list. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "suggestedDeletionIds": [ # IDs for suggestions that remove this link from the document. A RichLink might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. + "A String", + ], + "suggestedInsertionIds": [ # IDs for suggestions that insert this link into the document. A RichLink might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this RichLink, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. }, }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this RichLink. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - "bulletSuggestionState": { # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. - "listIdSuggested": True or False, # Indicates if there was a suggested change to the list_id. - "nestingLevelSuggested": True or False, # Indicates if there was a suggested change to the nesting_level. - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, - }, - }, - }, - "suggestedParagraphStyleChanges": { # The suggested paragraph style changes to this paragraph, keyed by suggestion ID. - "a_key": { # A suggested change to a ParagraphStyle. - "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A ParagraphStyle that only includes the changes made in this suggestion. This can be used along with the paragraph_style_suggestion_state to see which fields have changed and their new values. - "alignment": "A String", # The text alignment for this paragraph. - "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. - "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. }, }, - "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "startIndex": 42, # The zero-based start index of this paragraph element, in UTF-16 code units. + "textRun": { # A ParagraphElement that represents a run of text that all has the same styling. # A text run paragraph element. + "content": "A String", # The text of this run. Any non-text elements in the run are replaced with the Unicode character U+E907. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TextRun may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this run, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. }, }, }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this run. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, }, }, - "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. - "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. - "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + }, + ], + "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The style of this paragraph. + "alignment": "A String", # The text alignment for this paragraph. + "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. + "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, }, - "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. - "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. - "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. - "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. - "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. - "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + }, + "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, }, - "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "spacingMode": "A String", # The spacing mode for the paragraph. - "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. - { # A tab stop within a paragraph. - "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. - "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + }, + "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - ], - }, - "paragraphStyleSuggestionState": { # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. - "alignmentSuggested": True or False, # Indicates if there was a suggested change to alignment. - "avoidWidowAndOrphanSuggested": True or False, # Indicates if there was a suggested change to avoid_widow_and_orphan. - "borderBetweenSuggested": True or False, # Indicates if there was a suggested change to border_between. - "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. - "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. - "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. - "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. - "directionSuggested": True or False, # Indicates if there was a suggested change to direction. - "headingIdSuggested": True or False, # Indicates if there was a suggested change to heading_id. - "indentEndSuggested": True or False, # Indicates if there was a suggested change to indent_end. - "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line. - "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start. - "keepLinesTogetherSuggested": True or False, # Indicates if there was a suggested change to keep_lines_together. - "keepWithNextSuggested": True or False, # Indicates if there was a suggested change to keep_with_next. - "lineSpacingSuggested": True or False, # Indicates if there was a suggested change to line_spacing. - "namedStyleTypeSuggested": True or False, # Indicates if there was a suggested change to named_style_type. - "pageBreakBeforeSuggested": True or False, # Indicates if there was a suggested change to page_break_before. - "shadingSuggestionState": { # A mask that indicates which of the fields on the base Shading have been changed in this suggested change. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in shading have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to the Shading. }, - "spaceAboveSuggested": True or False, # Indicates if there was a suggested change to space_above. - "spaceBelowSuggested": True or False, # Indicates if there was a suggested change to space_below. - "spacingModeSuggested": True or False, # Indicates if there was a suggested change to spacing_mode. - }, - }, - }, - "suggestedPositionedObjectIds": { # The IDs of the positioned objects suggested to be attached to this paragraph, keyed by suggestion ID. - "a_key": { # A collection of object IDs. - "objectIds": [ # The object IDs. - "A String", - ], - }, - }, - }, - "sectionBreak": { # A StructuralElement representing a section break. A section is a range of content that has the same SectionStyle. A section break represents the start of a new section, and the section style applies to the section after the section break. The document body always begins with a section break. # A section break type of structural element. - "sectionStyle": { # The styling that applies to a section. # The style of the section after this section break. - "columnProperties": [ # The section's columns properties. If empty, the section contains one column with the default properties in the Docs editor. A section can be updated to have no more than 3 columns. When updating this property, setting a concrete value is required. Unsetting this property will result in a 400 bad request error. - { # Properties that apply to a section's column. - "paddingEnd": { # A magnitude in a single direction in the specified units. # The padding at the end of the column. + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "width": { # A magnitude in a single direction in the specified units. # Output only. The width of the column. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, }, - ], - "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only. - "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only. - "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only. - "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only. - "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only. - "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only. - "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "sectionType": "A String", # Output only. The type of section. - "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - }, - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A SectionBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - }, - "startIndex": 42, # The zero-based start index of this structural element, in UTF-16 code units. - "table": { # A StructuralElement representing a table. # A table type of structural element. - "columns": 42, # Number of columns in the table. It's possible for a table to be non-rectangular, so some rows may have a different number of cells. - "rows": 42, # Number of rows in the table. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A Table may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "tableRows": [ # The contents and style of each row. - { # The contents and style of a row in a Table. - "endIndex": 42, # The zero-based end index of this row, exclusive, in UTF-16 code units. - "startIndex": 42, # The zero-based start index of this row, in UTF-16 code units. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A TableRow may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", + "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. + "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. + "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. + "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. + "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. + "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. + "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. + "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + }, + "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spacingMode": "A String", # The spacing mode for the paragraph. + "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. + { # A tab stop within a paragraph. + "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. + "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, ], - "suggestedTableRowStyleChanges": { # The suggested style changes to this row, keyed by suggestion ID. - "a_key": { # A suggested change to a TableRowStyle. - "tableRowStyle": { # Styles that apply to a table row. # A TableRowStyle that only includes the changes made in this suggestion. This can be used along with the table_row_style_suggestion_state to see which fields have changed and their new values. - "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. + }, + "positionedObjectIds": [ # The IDs of the positioned objects tethered to this paragraph. + "A String", + ], + "suggestedBulletChanges": { # The suggested changes to this paragraph's bullet. + "a_key": { # A suggested change to a Bullet. + "bullet": { # Describes the bullet of a paragraph. # A Bullet that only includes the changes made in this suggestion. This can be used along with the bullet_suggestion_state to see which fields have changed and their new values. + "listId": "A String", # The ID of the list this paragraph belongs to. + "nestingLevel": 42, # The nesting level of this paragraph in the list. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries. - "tableHeader": True or False, # Whether the row is a table header. + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, }, - "tableRowStyleSuggestionState": { # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. - "minRowHeightSuggested": True or False, # Indicates if there was a suggested change to min_row_height. + }, + "bulletSuggestionState": { # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. + "listIdSuggested": True or False, # Indicates if there was a suggested change to the list_id. + "nestingLevelSuggested": True or False, # Indicates if there was a suggested change to the nesting_level. + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. }, }, }, - "tableCells": [ # The contents and style of each cell in this row. It's possible for a table to be non-rectangular, so some rows may have a different number of cells than other rows in the same table. - { # The contents and style of a cell in a Table. - "content": [ # The content of the cell. - # Object with schema name: StructuralElement - ], - "endIndex": 42, # The zero-based end index of this cell, exclusive, in UTF-16 code units. - "startIndex": 42, # The zero-based start index of this cell, in UTF-16 code units. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A TableCell may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTableCellStyleChanges": { # The suggested changes to the table cell style, keyed by suggestion ID. - "a_key": { # A suggested change to a TableCellStyle. - "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # A TableCellStyle that only includes the changes made in this suggestion. This can be used along with the table_cell_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "columnSpan": 42, # The column span of the cell. This property is read-only. - "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. - "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + }, + "suggestedParagraphStyleChanges": { # The suggested paragraph style changes to this paragraph, keyed by suggestion ID. + "a_key": { # A suggested change to a ParagraphStyle. + "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A ParagraphStyle that only includes the changes made in this suggestion. This can be used along with the paragraph_style_suggestion_state to see which fields have changed and their new values. + "alignment": "A String", # The text alignment for this paragraph. + "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. + "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, - "rowSpan": 42, # The row span of the cell. This property is read-only. - }, - "tableCellStyleSuggestionState": { # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. - "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. - "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. - "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. - "columnSpanSuggested": True or False, # Indicates if there was a suggested change to column_span. - "contentAlignmentSuggested": True or False, # Indicates if there was a suggested change to content_alignment. - "paddingBottomSuggested": True or False, # Indicates if there was a suggested change to padding_bottom. - "paddingLeftSuggested": True or False, # Indicates if there was a suggested change to padding_left. - "paddingRightSuggested": True or False, # Indicates if there was a suggested change to padding_right. - "paddingTopSuggested": True or False, # Indicates if there was a suggested change to padding_top. - "rowSpanSuggested": True or False, # Indicates if there was a suggested change to row_span. }, }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # The style of the cell. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell. + "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -19043,303 +24353,97 @@

Method Details

}, }, }, - "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + }, + "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, }, - "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, }, - "columnSpan": 42, # The column span of the cell. This property is read-only. - "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. - "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell. + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell. + }, + "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "rowSpan": 42, # The row span of the cell. This property is read-only. }, - }, - ], - "tableRowStyle": { # Styles that apply to a table row. # The style of the table row. - "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries. - "tableHeader": True or False, # Whether the row is a table header. - }, - }, - ], - "tableStyle": { # Styles that apply to a table. # The style of the table. - "tableColumnProperties": [ # The properties of each column. Note that in Docs, tables contain rows and rows contain cells, similar to HTML. So the properties for a row can be found on the row's table_row_style. - { # The properties of a column in a table. - "width": { # A magnitude in a single direction in the specified units. # The width of the column. Set when the column's `width_type` is FIXED_WIDTH. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "widthType": "A String", # The width type of the column. - }, - ], - }, - }, - "tableOfContents": { # A StructuralElement representing a table of contents. # A table of contents type of structural element. - "content": [ # The content of the table of contents. - # Object with schema name: StructuralElement - ], - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A TableOfContents may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - }, - }, - ], - }, - "documentId": "A String", # Output only. The ID of the document. - "documentStyle": { # The style of the document. # Output only. The style of the document. - "background": { # Represents the background of a document. # The background of the document. Documents cannot have a transparent background color. - "color": { # A color that can either be fully opaque or fully transparent. # The background color. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - }, - "defaultFooterId": "A String", # The ID of the default footer. If not set, there's no default footer. This property is read-only. - "defaultHeaderId": "A String", # The ID of the default header. If not set, there's no default header. This property is read-only. - "evenPageFooterId": "A String", # The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. This property is read-only. - "evenPageHeaderId": "A String", # The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. This property is read-only. - "firstPageFooterId": "A String", # The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. This property is read-only. - "firstPageHeaderId": "A String", # The ID of the header used only for the first page. If not set then a unique header for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_header_id or this value for the header on the first page. If not set, there's no first page header. This property is read-only. - "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of the page_size, which allows changing the page orientation between portrait and landscape. - "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin. Updating the bottom page margin on the document style clears the bottom page margin on all section styles. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginFooter": { # A magnitude in a single direction in the specified units. # The amount of space between the bottom of the page and the contents of the footer. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginHeader": { # A magnitude in a single direction in the specified units. # The amount of space between the top of the page and the contents of the header. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin. Updating the left page margin on the document style clears the left page margin on all section styles. It may also cause columns to resize in all sections. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin. Updating the right page margin on the document style clears the right page margin on all section styles. It may also cause columns to resize in all sections. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin. Updating the top page margin on the document style clears the top page margin on all section styles. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "pageNumberStart": 42, # The page number from which to start counting the number of pages. - "pageSize": { # A width and height. # The size of a page in the document. - "height": { # A magnitude in a single direction in the specified units. # The height of the object. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the object. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "useCustomHeaderFooterMargins": True or False, # Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected. When false, the default values in the Docs editor for header and footer margin are used. This property is read-only. - "useEvenPageHeaderFooter": True or False, # Indicates whether to use the even page header / footer IDs for the even pages. - "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page. - }, - "footers": { # Output only. The footers in the document, keyed by footer ID. - "a_key": { # A document footer. - "content": [ # The contents of the footer. The indexes for a footer's content begin at zero. - { # A StructuralElement describes content that provides structure to the document. - "endIndex": 42, # The zero-based end index of this structural element, exclusive, in UTF-16 code units. - "paragraph": { # A StructuralElement representing a paragraph. A paragraph is a range of content that's terminated with a newline character. # A paragraph type of structural element. - "bullet": { # Describes the bullet of a paragraph. # The bullet for this paragraph. If not present, the paragraph does not belong to a list. - "listId": "A String", # The ID of the list this paragraph belongs to. - "nestingLevel": 42, # The nesting level of this paragraph in the list. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. + "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. + "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - "elements": [ # The content of the paragraph, broken down into its component parts. - { # A ParagraphElement describes content within a Paragraph. - "autoText": { # A ParagraphElement representing a spot in the text that's dynamically replaced with content that can change over time, like a page number. # An auto text paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. An AutoText may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this AutoText, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, - }, + "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this AutoText. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. + "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. + "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. + "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. + "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. + "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -19348,177 +24452,291 @@

Method Details

}, }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + }, + "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spacingMode": "A String", # The spacing mode for the paragraph. + "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. + { # A tab stop within a paragraph. + "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. + "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - "type": "A String", # The type of this auto text. - }, - "columnBreak": { # A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column. # A column break paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", ], - "suggestedTextStyleChanges": { # The suggested text style changes to this ColumnBreak, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, - }, + }, + "paragraphStyleSuggestionState": { # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. + "alignmentSuggested": True or False, # Indicates if there was a suggested change to alignment. + "avoidWidowAndOrphanSuggested": True or False, # Indicates if there was a suggested change to avoid_widow_and_orphan. + "borderBetweenSuggested": True or False, # Indicates if there was a suggested change to border_between. + "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. + "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. + "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. + "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. + "directionSuggested": True or False, # Indicates if there was a suggested change to direction. + "headingIdSuggested": True or False, # Indicates if there was a suggested change to heading_id. + "indentEndSuggested": True or False, # Indicates if there was a suggested change to indent_end. + "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line. + "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start. + "keepLinesTogetherSuggested": True or False, # Indicates if there was a suggested change to keep_lines_together. + "keepWithNextSuggested": True or False, # Indicates if there was a suggested change to keep_with_next. + "lineSpacingSuggested": True or False, # Indicates if there was a suggested change to line_spacing. + "namedStyleTypeSuggested": True or False, # Indicates if there was a suggested change to named_style_type. + "pageBreakBeforeSuggested": True or False, # Indicates if there was a suggested change to page_break_before. + "shadingSuggestionState": { # A mask that indicates which of the fields on the base Shading have been changed in this suggested change. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in shading have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to the Shading. }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + "spaceAboveSuggested": True or False, # Indicates if there was a suggested change to space_above. + "spaceBelowSuggested": True or False, # Indicates if there was a suggested change to space_below. + "spacingModeSuggested": True or False, # Indicates if there was a suggested change to spacing_mode. + }, + }, + }, + "suggestedPositionedObjectIds": { # The IDs of the positioned objects suggested to be attached to this paragraph, keyed by suggestion ID. + "a_key": { # A collection of object IDs. + "objectIds": [ # The object IDs. + "A String", + ], + }, + }, + }, + "sectionBreak": { # A StructuralElement representing a section break. A section is a range of content that has the same SectionStyle. A section break represents the start of a new section, and the section style applies to the section after the section break. The document body always begins with a section break. # A section break type of structural element. + "sectionStyle": { # The styling that applies to a section. # The style of the section after this section break. + "columnProperties": [ # The section's columns properties. If empty, the section contains one column with the default properties in the Docs editor. A section can be updated to have no more than 3 columns. When updating this property, setting a concrete value is required. Unsetting this property will result in a 400 bad request error. + { # Properties that apply to a section's column. + "paddingEnd": { # A magnitude in a single direction in the specified units. # The padding at the end of the column. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # Output only. The width of the column. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + ], + "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only. + "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only. + "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only. + "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only. + "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only. + "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only. + "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "sectionType": "A String", # Output only. The type of section. + "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + }, + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A SectionBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + }, + "startIndex": 42, # The zero-based start index of this structural element, in UTF-16 code units. + "table": { # A StructuralElement representing a table. # A table type of structural element. + "columns": 42, # Number of columns in the table. It's possible for a table to be non-rectangular, so some rows may have a different number of cells. + "rows": 42, # Number of rows in the table. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A Table may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "tableRows": [ # The contents and style of each row. + { # The contents and style of a row in a Table. + "endIndex": 42, # The zero-based end index of this row, exclusive, in UTF-16 code units. + "startIndex": 42, # The zero-based start index of this row, in UTF-16 code units. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TableRow may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTableRowStyleChanges": { # The suggested style changes to this row, keyed by suggestion ID. + "a_key": { # A suggested change to a TableRowStyle. + "tableRowStyle": { # Styles that apply to a table row. # A TableRowStyle that only includes the changes made in this suggestion. This can be used along with the table_row_style_suggestion_state to see which fields have changed and their new values. + "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, + "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries. + "tableHeader": True or False, # Whether the row is a table header. }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "tableRowStyleSuggestionState": { # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. + "minRowHeightSuggested": True or False, # Indicates if there was a suggested change to min_row_height. }, }, }, - "endIndex": 42, # The zero-base end index of this paragraph element, exclusive, in UTF-16 code units. - "equation": { # A ParagraphElement representing an equation. # An equation paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. An Equation may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - }, - "footnoteReference": { # A ParagraphElement representing a footnote reference. A footnote reference is the inline content rendered with a number and is used to identify the footnote. # A footnote reference paragraph element. - "footnoteId": "A String", # The ID of the footnote that contains the content of this footnote reference. - "footnoteNumber": "A String", # The rendered number of this footnote. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this FootnoteReference, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "tableCells": [ # The contents and style of each cell in this row. It's possible for a table to be non-rectangular, so some rows may have a different number of cells than other rows in the same table. + { # The contents and style of a cell in a Table. + "content": [ # The content of the cell. + # Object with schema name: StructuralElement + ], + "endIndex": 42, # The zero-based end index of this cell, exclusive, in UTF-16 code units. + "startIndex": 42, # The zero-based start index of this cell, in UTF-16 code units. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TableCell may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTableCellStyleChanges": { # The suggested changes to the table cell style, keyed by suggestion ID. + "a_key": { # A suggested change to a TableCellStyle. + "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # A TableCellStyle that only includes the changes made in this suggestion. This can be used along with the table_cell_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, + "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "columnSpan": 42, # The column span of the cell. This property is read-only. + "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. + "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "rowSpan": 42, # The row span of the cell. This property is read-only. }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "tableCellStyleSuggestionState": { # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. + "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. + "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. + "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. + "columnSpanSuggested": True or False, # Indicates if there was a suggested change to column_span. + "contentAlignmentSuggested": True or False, # Indicates if there was a suggested change to content_alignment. + "paddingBottomSuggested": True or False, # Indicates if there was a suggested change to padding_bottom. + "paddingLeftSuggested": True or False, # Indicates if there was a suggested change to padding_left. + "paddingRightSuggested": True or False, # Indicates if there was a suggested change to padding_right. + "paddingTopSuggested": True or False, # Indicates if there was a suggested change to padding_top. + "rowSpanSuggested": True or False, # Indicates if there was a suggested change to row_span. + }, + }, + }, + "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # The style of the cell. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -19527,86 +24745,30 @@

Method Details

}, }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, - }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this FootnoteReference. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - "horizontalRule": { # A ParagraphElement representing a horizontal line. # A horizontal rule paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A HorizontalRule may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this HorizontalRule, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -19615,13 +24777,14 @@

Method Details

}, }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + }, + "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -19630,84 +24793,140 @@

Method Details

}, }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + "columnSpan": 42, # The column span of the cell. This property is read-only. + "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. + "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this HorizontalRule. Similar to text content, like text runs and footnote references, the text style of a horizontal rule can affect content layout as well as the styling of text inserted next to it. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, + "rowSpan": 42, # The row span of the cell. This property is read-only. }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. + }, + ], + "tableRowStyle": { # Styles that apply to a table row. # The style of the table row. + "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries. + "tableHeader": True or False, # Whether the row is a table header. + }, + }, + ], + "tableStyle": { # Styles that apply to a table. # The style of the table. + "tableColumnProperties": [ # The properties of each column. Note that in Docs, tables contain rows and rows contain cells, similar to HTML. So the properties for a row can be found on the row's table_row_style. + { # The properties of a column in a table. + "width": { # A magnitude in a single direction in the specified units. # The width of the column. Set when the column's `width_type` is FIXED_WIDTH. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "widthType": "A String", # The width type of the column. + }, + ], + }, + }, + "tableOfContents": { # A StructuralElement representing a table of contents. # A table of contents type of structural element. + "content": [ # The content of the table of contents. + # Object with schema name: StructuralElement + ], + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TableOfContents may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + }, + }, + ], + "footnoteId": "A String", # The ID of the footnote. + }, + }, + "headers": { # Output only. The headers in the document, keyed by header ID. + "a_key": { # A document header. + "content": [ # The contents of the header. The indexes for a header's content begin at zero. + { # A StructuralElement describes content that provides structure to the document. + "endIndex": 42, # The zero-based end index of this structural element, exclusive, in UTF-16 code units. + "paragraph": { # A StructuralElement representing a paragraph. A paragraph is a range of content that's terminated with a newline character. # A paragraph type of structural element. + "bullet": { # Describes the bullet of a paragraph. # The bullet for this paragraph. If not present, the paragraph does not belong to a list. + "listId": "A String", # The ID of the list this paragraph belongs to. + "nestingLevel": 42, # The nesting level of this paragraph in the list. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, }, - "inlineObjectElement": { # A ParagraphElement that contains an InlineObject. # An inline object paragraph element. - "inlineObjectId": "A String", # The ID of the InlineObject this element contains. + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "elements": [ # The content of the paragraph, broken down into its component parts. + { # A ParagraphElement describes content within a Paragraph. + "autoText": { # A ParagraphElement representing a spot in the text that's dynamically replaced with content that can change over time, like a page number. # An auto text paragraph element. "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. "A String", ], - "suggestedInsertionIds": [ # The suggested insertion IDs. An InlineObjectElement may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "suggestedInsertionIds": [ # The suggested insertion IDs. An AutoText may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. "A String", ], - "suggestedTextStyleChanges": { # The suggested text style changes to this InlineObject, keyed by suggestion ID. + "suggestedTextStyleChanges": { # The suggested text style changes to this AutoText, keyed by suggestion ID. "a_key": { # A suggested change to a TextStyle. "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. @@ -19736,8 +24955,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -19763,7 +24991,7 @@

Method Details

}, }, }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this InlineObjectElement. Similar to text content, like text runs and footnote references, the text style of an inline object element can affect content layout as well as the styling of text inserted next to it. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this AutoText. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. @@ -19790,8 +25018,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -19802,15 +25039,16 @@

Method Details

"weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, + "type": "A String", # The type of this auto text. }, - "pageBreak": { # A ParagraphElement representing a page break. A page break makes the subsequent text start at the top of the next page. # A page break paragraph element. + "columnBreak": { # A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column. # A column break paragraph element. "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. "A String", ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A PageBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "suggestedInsertionIds": [ # The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. "A String", ], - "suggestedTextStyleChanges": { # The suggested text style changes to this PageBreak, keyed by suggestion ID. + "suggestedTextStyleChanges": { # The suggested text style changes to this ColumnBreak, keyed by suggestion ID. "a_key": { # A suggested change to a TextStyle. "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. @@ -19839,8 +25077,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -19866,7 +25113,7 @@

Method Details

}, }, }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this PageBreak. Similar to text content, like text runs and footnote references, the text style of a page break can affect content layout as well as the styling of text inserted next to it. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. @@ -19893,8 +25140,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -19906,19 +25162,25 @@

Method Details

}, }, }, - "person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address. - "personId": "A String", # Output only. The unique ID of this link. - "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present. - "email": "A String", # Output only. The email address linked to this Person. This field is always present. - "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address. - }, - "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. + "endIndex": 42, # The zero-base end index of this paragraph element, exclusive, in UTF-16 code units. + "equation": { # A ParagraphElement representing an equation. # An equation paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. "A String", ], - "suggestedInsertionIds": [ # IDs for suggestions that insert this person link into the document. A Person might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. + "suggestedInsertionIds": [ # The suggested insertion IDs. An Equation may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. "A String", ], - "suggestedTextStyleChanges": { # The suggested text style changes to this Person, keyed by suggestion ID. + }, + "footnoteReference": { # A ParagraphElement representing a footnote reference. A footnote reference is the inline content rendered with a number and is used to identify the footnote. # A footnote reference paragraph element. + "footnoteId": "A String", # The ID of the footnote that contains the content of this footnote reference. + "footnoteNumber": "A String", # The rendered number of this footnote. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this FootnoteReference, keyed by suggestion ID. "a_key": { # A suggested change to a TextStyle. "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. @@ -19947,8 +25209,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -19974,7 +25245,7 @@

Method Details

}, }, }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this Person. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this FootnoteReference. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. @@ -20001,8 +25272,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -20014,20 +25294,14 @@

Method Details

}, }, }, - "richLink": { # A link to a Google resource (such as a file in Drive, a YouTube video, or a Calendar event). # A paragraph element that links to a Google resource (such as a file in Google Drive, a YouTube video, or a Calendar event.) - "richLinkId": "A String", # Output only. The ID of this link. - "richLinkProperties": { # Properties specific to a RichLink. # Output only. The properties of this RichLink. This field is always present. - "mimeType": "A String", # Output only. The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the RichLink, if there's one (for example, when it's a file in Drive). - "title": "A String", # Output only. The title of the RichLink as displayed in the link. This title matches the title of the linked resource at the time of the insertion or last update of the link. This field is always present. - "uri": "A String", # Output only. The URI to the RichLink. This is always present. - }, - "suggestedDeletionIds": [ # IDs for suggestions that remove this link from the document. A RichLink might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. + "horizontalRule": { # A ParagraphElement representing a horizontal line. # A horizontal rule paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. "A String", ], - "suggestedInsertionIds": [ # IDs for suggestions that insert this link into the document. A RichLink might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. + "suggestedInsertionIds": [ # The suggested insertion IDs. A HorizontalRule may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. "A String", ], - "suggestedTextStyleChanges": { # The suggested text style changes to this RichLink, keyed by suggestion ID. + "suggestedTextStyleChanges": { # The suggested text style changes to this HorizontalRule, keyed by suggestion ID. "a_key": { # A suggested change to a TextStyle. "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. @@ -20056,8 +25330,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -20083,7 +25366,7 @@

Method Details

}, }, }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this RichLink. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this HorizontalRule. Similar to text content, like text runs and footnote references, the text style of a horizontal rule can affect content layout as well as the styling of text inserted next to it. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. @@ -20110,8 +25393,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -20123,16 +25415,15 @@

Method Details

}, }, }, - "startIndex": 42, # The zero-based start index of this paragraph element, in UTF-16 code units. - "textRun": { # A ParagraphElement that represents a run of text that all has the same styling. # A text run paragraph element. - "content": "A String", # The text of this run. Any non-text elements in the run are replaced with the Unicode character U+E907. + "inlineObjectElement": { # A ParagraphElement that contains an InlineObject. # An inline object paragraph element. + "inlineObjectId": "A String", # The ID of the InlineObject this element contains. "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. "A String", ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A TextRun may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "suggestedInsertionIds": [ # The suggested insertion IDs. An InlineObjectElement may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. "A String", ], - "suggestedTextStyleChanges": { # The suggested text style changes to this run, keyed by suggestion ID. + "suggestedTextStyleChanges": { # The suggested text style changes to this InlineObject, keyed by suggestion ID. "a_key": { # A suggested change to a TextStyle. "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. @@ -20161,8 +25452,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -20188,7 +25488,7 @@

Method Details

}, }, }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this run. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this InlineObjectElement. Similar to text content, like text runs and footnote references, the text style of an inline object element can affect content layout as well as the styling of text inserted next to it. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. @@ -20215,8 +25515,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -20228,169 +25537,79 @@

Method Details

}, }, }, - }, - ], - "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The style of this paragraph. - "alignment": "A String", # The text alignment for this paragraph. - "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. - "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. - "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. - "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. - "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. - "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. - "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. - "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. - "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "pageBreak": { # A ParagraphElement representing a page break. A page break makes the subsequent text start at the top of the next page. # A page break paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A PageBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this PageBreak, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, }, }, - }, - }, - "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "spacingMode": "A String", # The spacing mode for the paragraph. - "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. - { # A tab stop within a paragraph. - "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. - "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - ], - }, - "positionedObjectIds": [ # The IDs of the positioned objects tethered to this paragraph. - "A String", - ], - "suggestedBulletChanges": { # The suggested changes to this paragraph's bullet. - "a_key": { # A suggested change to a Bullet. - "bullet": { # Describes the bullet of a paragraph. # A Bullet that only includes the changes made in this suggestion. This can be used along with the bullet_suggestion_state to see which fields have changed and their new values. - "listId": "A String", # The ID of the list this paragraph belongs to. - "nestingLevel": 42, # The nesting level of this paragraph in the list. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this PageBreak. Similar to text content, like text runs and footnote references, the text style of a page break can affect content layout as well as the styling of text inserted next to it. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. @@ -20417,8 +25636,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -20430,72 +25658,85 @@

Method Details

}, }, }, - "bulletSuggestionState": { # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. - "listIdSuggested": True or False, # Indicates if there was a suggested change to the list_id. - "nestingLevelSuggested": True or False, # Indicates if there was a suggested change to the nesting_level. - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + "person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address. + "personId": "A String", # Output only. The unique ID of this link. + "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present. + "email": "A String", # Output only. The email address linked to this Person. This field is always present. + "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address. }, - }, - }, - }, - "suggestedParagraphStyleChanges": { # The suggested paragraph style changes to this paragraph, keyed by suggestion ID. - "a_key": { # A suggested change to a ParagraphStyle. - "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A ParagraphStyle that only includes the changes made in this suggestion. This can be used along with the paragraph_style_suggestion_state to see which fields have changed and their new values. - "alignment": "A String", # The text alignment for this paragraph. - "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. - "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. + "A String", + ], + "suggestedInsertionIds": [ # IDs for suggestions that insert this person link into the document. A Person might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this Person, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, }, }, - "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this Person. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -20504,18 +25745,13 @@

Method Details

}, }, }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - }, - "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -20524,18 +25760,110 @@

Method Details

}, }, }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, - "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + }, + "richLink": { # A link to a Google resource (such as a file in Drive, a YouTube video, or a Calendar event). # A paragraph element that links to a Google resource (such as a file in Google Drive, a YouTube video, or a Calendar event.) + "richLinkId": "A String", # Output only. The ID of this link. + "richLinkProperties": { # Properties specific to a RichLink. # Output only. The properties of this RichLink. This field is always present. + "mimeType": "A String", # Output only. The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the RichLink, if there's one (for example, when it's a file in Drive). + "title": "A String", # Output only. The title of the RichLink as displayed in the link. This title matches the title of the linked resource at the time of the insertion or last update of the link. This field is always present. + "uri": "A String", # Output only. The URI to the RichLink. This is always present. + }, + "suggestedDeletionIds": [ # IDs for suggestions that remove this link from the document. A RichLink might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. + "A String", + ], + "suggestedInsertionIds": [ # IDs for suggestions that insert this link into the document. A RichLink might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this RichLink, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this RichLink. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -20544,37 +25872,13 @@

Method Details

}, }, }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - }, - "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. - "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. - "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. - "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. - "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. - "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. - "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. - "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -20583,529 +25887,390 @@

Method Details

}, }, }, - }, - "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "spacingMode": "A String", # The spacing mode for the paragraph. - "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. - { # A tab stop within a paragraph. - "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. - "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "startIndex": 42, # The zero-based start index of this paragraph element, in UTF-16 code units. + "textRun": { # A ParagraphElement that represents a run of text that all has the same styling. # A text run paragraph element. + "content": "A String", # The text of this run. Any non-text elements in the run are replaced with the Unicode character U+E907. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TextRun may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this run, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this run. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, - ], - }, - "paragraphStyleSuggestionState": { # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. - "alignmentSuggested": True or False, # Indicates if there was a suggested change to alignment. - "avoidWidowAndOrphanSuggested": True or False, # Indicates if there was a suggested change to avoid_widow_and_orphan. - "borderBetweenSuggested": True or False, # Indicates if there was a suggested change to border_between. - "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. - "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. - "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. - "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. - "directionSuggested": True or False, # Indicates if there was a suggested change to direction. - "headingIdSuggested": True or False, # Indicates if there was a suggested change to heading_id. - "indentEndSuggested": True or False, # Indicates if there was a suggested change to indent_end. - "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line. - "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start. - "keepLinesTogetherSuggested": True or False, # Indicates if there was a suggested change to keep_lines_together. - "keepWithNextSuggested": True or False, # Indicates if there was a suggested change to keep_with_next. - "lineSpacingSuggested": True or False, # Indicates if there was a suggested change to line_spacing. - "namedStyleTypeSuggested": True or False, # Indicates if there was a suggested change to named_style_type. - "pageBreakBeforeSuggested": True or False, # Indicates if there was a suggested change to page_break_before. - "shadingSuggestionState": { # A mask that indicates which of the fields on the base Shading have been changed in this suggested change. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in shading have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to the Shading. }, - "spaceAboveSuggested": True or False, # Indicates if there was a suggested change to space_above. - "spaceBelowSuggested": True or False, # Indicates if there was a suggested change to space_below. - "spacingModeSuggested": True or False, # Indicates if there was a suggested change to spacing_mode. }, }, - }, - "suggestedPositionedObjectIds": { # The IDs of the positioned objects suggested to be attached to this paragraph, keyed by suggestion ID. - "a_key": { # A collection of object IDs. - "objectIds": [ # The object IDs. - "A String", - ], + ], + "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The style of this paragraph. + "alignment": "A String", # The text alignment for this paragraph. + "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. + "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - }, - }, - "sectionBreak": { # A StructuralElement representing a section break. A section is a range of content that has the same SectionStyle. A section break represents the start of a new section, and the section style applies to the section after the section break. The document body always begins with a section break. # A section break type of structural element. - "sectionStyle": { # The styling that applies to a section. # The style of the section after this section break. - "columnProperties": [ # The section's columns properties. If empty, the section contains one column with the default properties in the Docs editor. A section can be updated to have no more than 3 columns. When updating this property, setting a concrete value is required. Unsetting this property will result in a 400 bad request error. - { # Properties that apply to a section's column. - "paddingEnd": { # A magnitude in a single direction in the specified units. # The padding at the end of the column. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, - "width": { # A magnitude in a single direction in the specified units. # Output only. The width of the column. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, - ], - "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only. - "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only. - "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only. - "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only. - "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only. - "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only. - "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. + "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. + "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "sectionType": "A String", # Output only. The type of section. - "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - }, - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A SectionBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - }, - "startIndex": 42, # The zero-based start index of this structural element, in UTF-16 code units. - "table": { # A StructuralElement representing a table. # A table type of structural element. - "columns": 42, # Number of columns in the table. It's possible for a table to be non-rectangular, so some rows may have a different number of cells. - "rows": 42, # Number of rows in the table. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A Table may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. + "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. + "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. + "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. + "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. + "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + }, + "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spacingMode": "A String", # The spacing mode for the paragraph. + "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. + { # A tab stop within a paragraph. + "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. + "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + ], + }, + "positionedObjectIds": [ # The IDs of the positioned objects tethered to this paragraph. "A String", ], - "tableRows": [ # The contents and style of each row. - { # The contents and style of a row in a Table. - "endIndex": 42, # The zero-based end index of this row, exclusive, in UTF-16 code units. - "startIndex": 42, # The zero-based start index of this row, in UTF-16 code units. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A TableRow may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTableRowStyleChanges": { # The suggested style changes to this row, keyed by suggestion ID. - "a_key": { # A suggested change to a TableRowStyle. - "tableRowStyle": { # Styles that apply to a table row. # A TableRowStyle that only includes the changes made in this suggestion. This can be used along with the table_row_style_suggestion_state to see which fields have changed and their new values. - "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "suggestedBulletChanges": { # The suggested changes to this paragraph's bullet. + "a_key": { # A suggested change to a Bullet. + "bullet": { # Describes the bullet of a paragraph. # A Bullet that only includes the changes made in this suggestion. This can be used along with the bullet_suggestion_state to see which fields have changed and their new values. + "listId": "A String", # The ID of the list this paragraph belongs to. + "nestingLevel": 42, # The nesting level of this paragraph in the list. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, - "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries. - "tableHeader": True or False, # Whether the row is a table header. }, - "tableRowStyleSuggestionState": { # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. - "minRowHeightSuggested": True or False, # Indicates if there was a suggested change to min_row_height. + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - }, - }, - "tableCells": [ # The contents and style of each cell in this row. It's possible for a table to be non-rectangular, so some rows may have a different number of cells than other rows in the same table. - { # The contents and style of a cell in a Table. - "content": [ # The content of the cell. - # Object with schema name: StructuralElement - ], - "endIndex": 42, # The zero-based end index of this cell, exclusive, in UTF-16 code units. - "startIndex": 42, # The zero-based start index of this cell, in UTF-16 code units. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A TableCell may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTableCellStyleChanges": { # The suggested changes to the table cell style, keyed by suggestion ID. - "a_key": { # A suggested change to a TableCellStyle. - "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # A TableCellStyle that only includes the changes made in this suggestion. This can be used along with the table_cell_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "columnSpan": 42, # The column span of the cell. This property is read-only. - "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. - "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "rowSpan": 42, # The row span of the cell. This property is read-only. - }, - "tableCellStyleSuggestionState": { # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. - "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. - "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. - "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. - "columnSpanSuggested": True or False, # Indicates if there was a suggested change to column_span. - "contentAlignmentSuggested": True or False, # Indicates if there was a suggested change to content_alignment. - "paddingBottomSuggested": True or False, # Indicates if there was a suggested change to padding_bottom. - "paddingLeftSuggested": True or False, # Indicates if there was a suggested change to padding_left. - "paddingRightSuggested": True or False, # Indicates if there was a suggested change to padding_right. - "paddingTopSuggested": True or False, # Indicates if there was a suggested change to padding_top. - "rowSpanSuggested": True or False, # Indicates if there was a suggested change to row_span. + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, }, - "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # The style of the cell. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. }, - "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. }, - "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "columnSpan": 42, # The column span of the cell. This property is read-only. - "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. - "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "rowSpan": 42, # The row span of the cell. This property is read-only. + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. }, - }, - ], - "tableRowStyle": { # Styles that apply to a table row. # The style of the table row. - "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries. - "tableHeader": True or False, # Whether the row is a table header. - }, - }, - ], - "tableStyle": { # Styles that apply to a table. # The style of the table. - "tableColumnProperties": [ # The properties of each column. Note that in Docs, tables contain rows and rows contain cells, similar to HTML. So the properties for a row can be found on the row's table_row_style. - { # The properties of a column in a table. - "width": { # A magnitude in a single direction in the specified units. # The width of the column. Set when the column's `width_type` is FIXED_WIDTH. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "widthType": "A String", # The width type of the column. - }, - ], - }, - }, - "tableOfContents": { # A StructuralElement representing a table of contents. # A table of contents type of structural element. - "content": [ # The content of the table of contents. - # Object with schema name: StructuralElement - ], - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A TableOfContents may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - }, - }, - ], - "footerId": "A String", # The ID of the footer. - }, - }, - "footnotes": { # Output only. The footnotes in the document, keyed by footnote ID. - "a_key": { # A document footnote. - "content": [ # The contents of the footnote. The indexes for a footnote's content begin at zero. - { # A StructuralElement describes content that provides structure to the document. - "endIndex": 42, # The zero-based end index of this structural element, exclusive, in UTF-16 code units. - "paragraph": { # A StructuralElement representing a paragraph. A paragraph is a range of content that's terminated with a newline character. # A paragraph type of structural element. - "bullet": { # Describes the bullet of a paragraph. # The bullet for this paragraph. If not present, the paragraph does not belong to a list. - "listId": "A String", # The ID of the list this paragraph belongs to. - "nestingLevel": 42, # The nesting level of this paragraph in the list. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + "bulletSuggestionState": { # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. + "listIdSuggested": True or False, # Indicates if there was a suggested change to the list_id. + "nestingLevelSuggested": True or False, # Indicates if there was a suggested change to the nesting_level. + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, }, }, - "elements": [ # The content of the paragraph, broken down into its component parts. - { # A ParagraphElement describes content within a Paragraph. - "autoText": { # A ParagraphElement representing a spot in the text that's dynamically replaced with content that can change over time, like a page number. # An auto text paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. An AutoText may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this AutoText, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, - }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this AutoText. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "suggestedParagraphStyleChanges": { # The suggested paragraph style changes to this paragraph, keyed by suggestion ID. + "a_key": { # A suggested change to a ParagraphStyle. + "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A ParagraphStyle that only includes the changes made in this suggestion. This can be used along with the paragraph_style_suggestion_state to see which fields have changed and their new values. + "alignment": "A String", # The text alignment for this paragraph. + "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. + "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -21114,13 +26279,18 @@

Method Details

}, }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -21129,87 +26299,18 @@

Method Details

}, }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - }, - "type": "A String", # The type of this auto text. - }, - "columnBreak": { # A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column. # A column break paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this ColumnBreak, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -21218,13 +26319,18 @@

Method Details

}, }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -21233,97 +26339,18 @@

Method Details

}, }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - }, - }, - "endIndex": 42, # The zero-base end index of this paragraph element, exclusive, in UTF-16 code units. - "equation": { # A ParagraphElement representing an equation. # An equation paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. An Equation may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - }, - "footnoteReference": { # A ParagraphElement representing a footnote reference. A footnote reference is the inline content rendered with a number and is used to identify the footnote. # A footnote reference paragraph element. - "footnoteId": "A String", # The ID of the footnote that contains the content of this footnote reference. - "footnoteNumber": "A String", # The rendered number of this footnote. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this FootnoteReference, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this FootnoteReference. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -21332,13 +26359,37 @@

Method Details

}, }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. + "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. + "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. + "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. + "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. + "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. + "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. + "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -21347,151 +26398,291 @@

Method Details

}, }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, }, - }, - "horizontalRule": { # A ParagraphElement representing a horizontal line. # A horizontal rule paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", + "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spacingMode": "A String", # The spacing mode for the paragraph. + "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. + { # A tab stop within a paragraph. + "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. + "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A HorizontalRule may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this HorizontalRule, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, - }, + }, + "paragraphStyleSuggestionState": { # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. + "alignmentSuggested": True or False, # Indicates if there was a suggested change to alignment. + "avoidWidowAndOrphanSuggested": True or False, # Indicates if there was a suggested change to avoid_widow_and_orphan. + "borderBetweenSuggested": True or False, # Indicates if there was a suggested change to border_between. + "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. + "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. + "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. + "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. + "directionSuggested": True or False, # Indicates if there was a suggested change to direction. + "headingIdSuggested": True or False, # Indicates if there was a suggested change to heading_id. + "indentEndSuggested": True or False, # Indicates if there was a suggested change to indent_end. + "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line. + "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start. + "keepLinesTogetherSuggested": True or False, # Indicates if there was a suggested change to keep_lines_together. + "keepWithNextSuggested": True or False, # Indicates if there was a suggested change to keep_with_next. + "lineSpacingSuggested": True or False, # Indicates if there was a suggested change to line_spacing. + "namedStyleTypeSuggested": True or False, # Indicates if there was a suggested change to named_style_type. + "pageBreakBeforeSuggested": True or False, # Indicates if there was a suggested change to page_break_before. + "shadingSuggestionState": { # A mask that indicates which of the fields on the base Shading have been changed in this suggested change. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in shading have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to the Shading. }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this HorizontalRule. Similar to text content, like text runs and footnote references, the text style of a horizontal rule can affect content layout as well as the styling of text inserted next to it. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + "spaceAboveSuggested": True or False, # Indicates if there was a suggested change to space_above. + "spaceBelowSuggested": True or False, # Indicates if there was a suggested change to space_below. + "spacingModeSuggested": True or False, # Indicates if there was a suggested change to spacing_mode. + }, + }, + }, + "suggestedPositionedObjectIds": { # The IDs of the positioned objects suggested to be attached to this paragraph, keyed by suggestion ID. + "a_key": { # A collection of object IDs. + "objectIds": [ # The object IDs. + "A String", + ], + }, + }, + }, + "sectionBreak": { # A StructuralElement representing a section break. A section is a range of content that has the same SectionStyle. A section break represents the start of a new section, and the section style applies to the section after the section break. The document body always begins with a section break. # A section break type of structural element. + "sectionStyle": { # The styling that applies to a section. # The style of the section after this section break. + "columnProperties": [ # The section's columns properties. If empty, the section contains one column with the default properties in the Docs editor. A section can be updated to have no more than 3 columns. When updating this property, setting a concrete value is required. Unsetting this property will result in a 400 bad request error. + { # Properties that apply to a section's column. + "paddingEnd": { # A magnitude in a single direction in the specified units. # The padding at the end of the column. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # Output only. The width of the column. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + ], + "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only. + "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only. + "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only. + "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only. + "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only. + "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only. + "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "sectionType": "A String", # Output only. The type of section. + "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + }, + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A SectionBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + }, + "startIndex": 42, # The zero-based start index of this structural element, in UTF-16 code units. + "table": { # A StructuralElement representing a table. # A table type of structural element. + "columns": 42, # Number of columns in the table. It's possible for a table to be non-rectangular, so some rows may have a different number of cells. + "rows": 42, # Number of rows in the table. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A Table may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "tableRows": [ # The contents and style of each row. + { # The contents and style of a row in a Table. + "endIndex": 42, # The zero-based end index of this row, exclusive, in UTF-16 code units. + "startIndex": 42, # The zero-based start index of this row, in UTF-16 code units. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TableRow may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTableRowStyleChanges": { # The suggested style changes to this row, keyed by suggestion ID. + "a_key": { # A suggested change to a TableRowStyle. + "tableRowStyle": { # Styles that apply to a table row. # A TableRowStyle that only includes the changes made in this suggestion. This can be used along with the table_row_style_suggestion_state to see which fields have changed and their new values. + "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, + "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries. + "tableHeader": True or False, # Whether the row is a table header. }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "tableRowStyleSuggestionState": { # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. + "minRowHeightSuggested": True or False, # Indicates if there was a suggested change to min_row_height. }, }, }, - "inlineObjectElement": { # A ParagraphElement that contains an InlineObject. # An inline object paragraph element. - "inlineObjectId": "A String", # The ID of the InlineObject this element contains. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. An InlineObjectElement may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this InlineObject, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "tableCells": [ # The contents and style of each cell in this row. It's possible for a table to be non-rectangular, so some rows may have a different number of cells than other rows in the same table. + { # The contents and style of a cell in a Table. + "content": [ # The content of the cell. + # Object with schema name: StructuralElement + ], + "endIndex": 42, # The zero-based end index of this cell, exclusive, in UTF-16 code units. + "startIndex": 42, # The zero-based start index of this cell, in UTF-16 code units. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TableCell may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTableCellStyleChanges": { # The suggested changes to the table cell style, keyed by suggestion ID. + "a_key": { # A suggested change to a TableCellStyle. + "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # A TableCellStyle that only includes the changes made in this suggestion. This can be used along with the table_cell_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, + "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "columnSpan": 42, # The column span of the cell. This property is read-only. + "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. + "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "rowSpan": 42, # The row span of the cell. This property is read-only. }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "tableCellStyleSuggestionState": { # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. + "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. + "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. + "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. + "columnSpanSuggested": True or False, # Indicates if there was a suggested change to column_span. + "contentAlignmentSuggested": True or False, # Indicates if there was a suggested change to content_alignment. + "paddingBottomSuggested": True or False, # Indicates if there was a suggested change to padding_bottom. + "paddingLeftSuggested": True or False, # Indicates if there was a suggested change to padding_left. + "paddingRightSuggested": True or False, # Indicates if there was a suggested change to padding_right. + "paddingTopSuggested": True or False, # Indicates if there was a suggested change to padding_top. + "rowSpanSuggested": True or False, # Indicates if there was a suggested change to row_span. }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + }, + }, + "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # The style of the cell. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -21500,86 +26691,30 @@

Method Details

}, }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, - }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this InlineObjectElement. Similar to text content, like text runs and footnote references, the text style of an inline object element can affect content layout as well as the styling of text inserted next to it. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - "pageBreak": { # A ParagraphElement representing a page break. A page break makes the subsequent text start at the top of the next page. # A page break paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A PageBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this PageBreak, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -21588,13 +26723,14 @@

Method Details

}, }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + }, + "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -21603,423 +26739,158 @@

Method Details

}, }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + "columnSpan": 42, # The column span of the cell. This property is read-only. + "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. + "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this PageBreak. Similar to text content, like text runs and footnote references, the text style of a page break can affect content layout as well as the styling of text inserted next to it. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - "person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address. - "personId": "A String", # Output only. The unique ID of this link. - "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present. - "email": "A String", # Output only. The email address linked to this Person. This field is always present. - "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address. - }, - "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. - "A String", - ], - "suggestedInsertionIds": [ # IDs for suggestions that insert this person link into the document. A Person might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this Person, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, + "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, + "rowSpan": 42, # The row span of the cell. This property is read-only. }, }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this Person. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, + ], + "tableRowStyle": { # Styles that apply to a table row. # The style of the table row. + "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, + "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries. + "tableHeader": True or False, # Whether the row is a table header. }, - "richLink": { # A link to a Google resource (such as a file in Drive, a YouTube video, or a Calendar event). # A paragraph element that links to a Google resource (such as a file in Google Drive, a YouTube video, or a Calendar event.) - "richLinkId": "A String", # Output only. The ID of this link. - "richLinkProperties": { # Properties specific to a RichLink. # Output only. The properties of this RichLink. This field is always present. - "mimeType": "A String", # Output only. The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the RichLink, if there's one (for example, when it's a file in Drive). - "title": "A String", # Output only. The title of the RichLink as displayed in the link. This title matches the title of the linked resource at the time of the insertion or last update of the link. This field is always present. - "uri": "A String", # Output only. The URI to the RichLink. This is always present. - }, - "suggestedDeletionIds": [ # IDs for suggestions that remove this link from the document. A RichLink might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. - "A String", - ], - "suggestedInsertionIds": [ # IDs for suggestions that insert this link into the document. A RichLink might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this RichLink, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, - }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this RichLink. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - "startIndex": 42, # The zero-based start index of this paragraph element, in UTF-16 code units. - "textRun": { # A ParagraphElement that represents a run of text that all has the same styling. # A text run paragraph element. - "content": "A String", # The text of this run. Any non-text elements in the run are replaced with the Unicode character U+E907. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A TextRun may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this run, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, - }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this run. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, + }, + ], + "tableStyle": { # Styles that apply to a table. # The style of the table. + "tableColumnProperties": [ # The properties of each column. Note that in Docs, tables contain rows and rows contain cells, similar to HTML. So the properties for a row can be found on the row's table_row_style. + { # The properties of a column in a table. + "width": { # A magnitude in a single direction in the specified units. # The width of the column. Set when the column's `width_type` is FIXED_WIDTH. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, + "widthType": "A String", # The width type of the column. }, - }, + ], + }, + }, + "tableOfContents": { # A StructuralElement representing a table of contents. # A table of contents type of structural element. + "content": [ # The content of the table of contents. + # Object with schema name: StructuralElement ], - "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The style of this paragraph. - "alignment": "A String", # The text alignment for this paragraph. - "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. - "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TableOfContents may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + }, + }, + ], + "headerId": "A String", # The ID of the header. + }, + }, + "inlineObjects": { # Output only. The inline objects in the document, keyed by object ID. + "a_key": { # An object that appears inline with text. An InlineObject contains an EmbeddedObject such as an image. + "inlineObjectProperties": { # Properties of an InlineObject. # The properties of this inline object. + "embeddedObject": { # An embedded object in the document. # The embedded object of this inline object. + "description": "A String", # The description of the embedded object. The `title` and `description` are both combined to display alt text. + "embeddedDrawingProperties": { # The properties of an embedded drawing and used to differentiate the object type. An embedded drawing is one that's created and edited within a document. Note that extensive details are not supported. # The properties of an embedded drawing. + }, + "embeddedObjectBorder": { # A border around an EmbeddedObject. # The border of the embedded object. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + }, + "dashStyle": "A String", # The dash style of the border. + "propertyState": "A String", # The property state of the border property. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "imageProperties": { # The properties of an image. # The properties of an image. + "angle": 3.14, # The clockwise rotation angle of the image, in radians. + "brightness": 3.14, # The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. + "contentUri": "A String", # A URI to the image with a default lifetime of 30 minutes. This URI is tagged with the account of the requester. Anyone with the URI effectively accesses the image as the original requester. Access to the image may be lost if the document's sharing settings change. + "contrast": 3.14, # The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. + "cropProperties": { # The crop properties of an image. The crop rectangle is represented using fractional offsets from the original content's 4 edges. - If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the image's original bounding rectangle. - If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the image's original bounding rectangle. - If all offsets and rotation angle are 0, the image is not cropped. # The crop properties of the image. + "angle": 3.14, # The clockwise rotation angle of the crop rectangle around its center, in radians. Rotation is applied after the offsets. + "offsetBottom": 3.14, # The offset specifies how far inwards the bottom edge of the crop rectangle is from the bottom edge of the original content as a fraction of the original content's height. + "offsetLeft": 3.14, # The offset specifies how far inwards the left edge of the crop rectangle is from the left edge of the original content as a fraction of the original content's width. + "offsetRight": 3.14, # The offset specifies how far inwards the right edge of the crop rectangle is from the right edge of the original content as a fraction of the original content's width. + "offsetTop": 3.14, # The offset specifies how far inwards the top edge of the crop rectangle is from the top edge of the original content as a fraction of the original content's height. + }, + "sourceUri": "A String", # The source URI is the URI used to insert the image. The source URI can be empty. + "transparency": 3.14, # The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means transparent. + }, + "linkedContentReference": { # A reference to the external linked source content. # A reference to the external linked source content. For example, it contains a reference to the source Google Sheets chart when the embedded object is a linked chart. If unset, then the embedded object is not linked. + "sheetsChartReference": { # A reference to a linked chart embedded from Google Sheets. # A reference to the linked chart. + "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that's embedded. + "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart. + }, + }, + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginLeft": { # A magnitude in a single direction in the specified units. # The left margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginRight": { # A magnitude in a single direction in the specified units. # The right margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginTop": { # A magnitude in a single direction in the specified units. # The top margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "size": { # A width and height. # The visible size of the image after cropping. + "height": { # A magnitude in a single direction in the specified units. # The height of the object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "title": "A String", # The title of the embedded object. The `title` and `description` are both combined to display alt text. + }, + }, + "objectId": "A String", # The ID of this inline object. Can be used to update an object’s properties. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInlineObjectPropertiesChanges": { # The suggested changes to the inline object properties, keyed by suggestion ID. + "a_key": { # A suggested change to InlineObjectProperties. + "inlineObjectProperties": { # Properties of an InlineObject. # An InlineObjectProperties that only includes the changes made in this suggestion. This can be used along with the inline_object_properties_suggestion_state to see which fields have changed and their new values. + "embeddedObject": { # An embedded object in the document. # The embedded object of this inline object. + "description": "A String", # The description of the embedded object. The `title` and `description` are both combined to display alt text. + "embeddedDrawingProperties": { # The properties of an embedded drawing and used to differentiate the object type. An embedded drawing is one that's created and edited within a document. Note that extensive details are not supported. # The properties of an embedded drawing. + }, + "embeddedObjectBorder": { # A border around an EmbeddedObject. # The border of the embedded object. "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. @@ -22030,857 +26901,1106 @@

Method Details

}, }, "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, + "propertyState": "A String", # The property state of the border property. "width": { # A magnitude in a single direction in the specified units. # The width of the border. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, }, - "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "imageProperties": { # The properties of an image. # The properties of an image. + "angle": 3.14, # The clockwise rotation angle of the image, in radians. + "brightness": 3.14, # The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. + "contentUri": "A String", # A URI to the image with a default lifetime of 30 minutes. This URI is tagged with the account of the requester. Anyone with the URI effectively accesses the image as the original requester. Access to the image may be lost if the document's sharing settings change. + "contrast": 3.14, # The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. + "cropProperties": { # The crop properties of an image. The crop rectangle is represented using fractional offsets from the original content's 4 edges. - If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the image's original bounding rectangle. - If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the image's original bounding rectangle. - If all offsets and rotation angle are 0, the image is not cropped. # The crop properties of the image. + "angle": 3.14, # The clockwise rotation angle of the crop rectangle around its center, in radians. Rotation is applied after the offsets. + "offsetBottom": 3.14, # The offset specifies how far inwards the bottom edge of the crop rectangle is from the bottom edge of the original content as a fraction of the original content's height. + "offsetLeft": 3.14, # The offset specifies how far inwards the left edge of the crop rectangle is from the left edge of the original content as a fraction of the original content's width. + "offsetRight": 3.14, # The offset specifies how far inwards the right edge of the crop rectangle is from the right edge of the original content as a fraction of the original content's width. + "offsetTop": 3.14, # The offset specifies how far inwards the top edge of the crop rectangle is from the top edge of the original content as a fraction of the original content's height. }, + "sourceUri": "A String", # The source URI is the URI used to insert the image. The source URI can be empty. + "transparency": 3.14, # The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means transparent. }, - "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, + "linkedContentReference": { # A reference to the external linked source content. # A reference to the external linked source content. For example, it contains a reference to the source Google Sheets chart when the embedded object is a linked chart. If unset, then the embedded object is not linked. + "sheetsChartReference": { # A reference to a linked chart embedded from Google Sheets. # A reference to the linked chart. + "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that's embedded. + "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart. }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + }, + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginLeft": { # A magnitude in a single direction in the specified units. # The left margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginRight": { # A magnitude in a single direction in the specified units. # The right margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginTop": { # A magnitude in a single direction in the specified units. # The top margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "size": { # A width and height. # The visible size of the image after cropping. + "height": { # A magnitude in a single direction in the specified units. # The height of the object. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the object. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, }, - "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "title": "A String", # The title of the embedded object. The `title` and `description` are both combined to display alt text. + }, + }, + "inlineObjectPropertiesSuggestionState": { # A mask that indicates which of the fields on the base InlineObjectProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base InlineObjectProperties have been changed in this suggestion. + "embeddedObjectSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedObject have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_object have been changed in this suggestion. + "descriptionSuggested": True or False, # Indicates if there was a suggested change to description. + "embeddedDrawingPropertiesSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedDrawingProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_drawing_properties have been changed in this suggestion. + }, + "embeddedObjectBorderSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedObjectBorder have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_object_border have been changed in this suggestion. + "colorSuggested": True or False, # Indicates if there was a suggested change to color. + "dashStyleSuggested": True or False, # Indicates if there was a suggested change to dash_style. + "propertyStateSuggested": True or False, # Indicates if there was a suggested change to property_state. + "widthSuggested": True or False, # Indicates if there was a suggested change to width. + }, + "imagePropertiesSuggestionState": { # A mask that indicates which of the fields on the base ImageProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in image_properties have been changed in this suggestion. + "angleSuggested": True or False, # Indicates if there was a suggested change to angle. + "brightnessSuggested": True or False, # Indicates if there was a suggested change to brightness. + "contentUriSuggested": True or False, # Indicates if there was a suggested change to content_uri. + "contrastSuggested": True or False, # Indicates if there was a suggested change to contrast. + "cropPropertiesSuggestionState": { # A mask that indicates which of the fields on the base CropProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in crop_properties have been changed in this suggestion. + "angleSuggested": True or False, # Indicates if there was a suggested change to angle. + "offsetBottomSuggested": True or False, # Indicates if there was a suggested change to offset_bottom. + "offsetLeftSuggested": True or False, # Indicates if there was a suggested change to offset_left. + "offsetRightSuggested": True or False, # Indicates if there was a suggested change to offset_right. + "offsetTopSuggested": True or False, # Indicates if there was a suggested change to offset_top. }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "sourceUriSuggested": True or False, # Indicates if there was a suggested change to source_uri. + "transparencySuggested": True or False, # Indicates if there was a suggested change to transparency. + }, + "linkedContentReferenceSuggestionState": { # A mask that indicates which of the fields on the base LinkedContentReference have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in linked_content_reference have been changed in this suggestion. + "sheetsChartReferenceSuggestionState": { # A mask that indicates which of the fields on the base SheetsChartReference have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in sheets_chart_reference have been changed in this suggestion. + "chartIdSuggested": True or False, # Indicates if there was a suggested change to chart_id. + "spreadsheetIdSuggested": True or False, # Indicates if there was a suggested change to spreadsheet_id. }, }, - "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. - "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. - "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "marginBottomSuggested": True or False, # Indicates if there was a suggested change to margin_bottom. + "marginLeftSuggested": True or False, # Indicates if there was a suggested change to margin_left. + "marginRightSuggested": True or False, # Indicates if there was a suggested change to margin_right. + "marginTopSuggested": True or False, # Indicates if there was a suggested change to margin_top. + "sizeSuggestionState": { # A mask that indicates which of the fields on the base Size have been changed in this suggestion. For any field set to true, the Size has a new suggested value. # A mask that indicates which of the fields in size have been changed in this suggestion. + "heightSuggested": True or False, # Indicates if there was a suggested change to height. + "widthSuggested": True or False, # Indicates if there was a suggested change to width. }, - "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "titleSuggested": True or False, # Indicates if there was a suggested change to title. + }, + }, + }, + }, + "suggestedInsertionId": "A String", # The suggested insertion ID. If empty, then this is not a suggested insertion. + }, + }, + "lists": { # Output only. The lists in the document, keyed by list ID. + "a_key": { # A List represents the list attributes for a group of paragraphs that all belong to the same list. A paragraph that's part of a list has a reference to the list's ID in its bullet. + "listProperties": { # The properties of a list that describe the look and feel of bullets belonging to paragraphs associated with a list. # The properties of the list. + "nestingLevels": [ # Describes the properties of the bullets at the associated level. A list has at most 9 levels of nesting with nesting level 0 corresponding to the top-most level and nesting level 8 corresponding to the most nested level. The nesting levels are returned in ascending order with the least nested returned first. + { # Contains properties describing the look and feel of a list bullet at a given level of nesting. + "bulletAlignment": "A String", # The alignment of the bullet within the space allotted for rendering the bullet. + "glyphFormat": "A String", # The format string used by bullets at this level of nesting. The glyph format contains one or more placeholders, and these placeholders are replaced with the appropriate values depending on the glyph_type or glyph_symbol. The placeholders follow the pattern `%[nesting_level]`. Furthermore, placeholders can have prefixes and suffixes. Thus, the glyph format follows the pattern `%[nesting_level]`. Note that the prefix and suffix are optional and can be arbitrary strings. For example, the glyph format `%0.` indicates that the rendered glyph will replace the placeholder with the corresponding glyph for nesting level 0 followed by a period as the suffix. So a list with a glyph type of UPPER_ALPHA and glyph format `%0.` at nesting level 0 will result in a list with rendered glyphs `A.` `B.` `C.` The glyph format can contain placeholders for the current nesting level as well as placeholders for parent nesting levels. For example, a list can have a glyph format of `%0.` at nesting level 0 and a glyph format of `%0.%1.` at nesting level 1. Assuming both nesting levels have DECIMAL glyph types, this would result in a list with rendered glyphs `1.` `2.` ` 2.1.` ` 2.2.` `3.` For nesting levels that are ordered, the string that replaces a placeholder in the glyph format for a particular paragraph depends on the paragraph's order within the list. + "glyphSymbol": "A String", # A custom glyph symbol used by bullets when paragraphs at this level of nesting are unordered. The glyph symbol replaces placeholders within the glyph_format. For example, if the glyph_symbol is the solid circle corresponding to Unicode U+25cf code point and the glyph_format is `%0`, the rendered glyph would be the solid circle. + "glyphType": "A String", # The type of glyph used by bullets when paragraphs at this level of nesting are ordered. The glyph type determines the type of glyph used to replace placeholders within the glyph_format when paragraphs at this level of nesting are ordered. For example, if the nesting level is 0, the glyph_format is `%0.` and the glyph type is DECIMAL, then the rendered glyph would replace the placeholder `%0` in the glyph format with a number corresponding to list item's order within the list. + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of paragraphs at this level of nesting. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for paragraphs at this level of nesting. Applied to the side that corresponds to the start of the text, based on the paragraph's content direction. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "startNumber": 42, # The number of the first list item at this nesting level. A value of 0 is treated as a value of 1 for lettered lists and Roman numeral lists. For values of both 0 and 1, lettered and Roman numeral lists will begin at `a` and `i` respectively. This value is ignored for nesting levels with unordered glyphs. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of bullets at this level of nesting. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, }, - "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. - "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. - "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. - "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. - "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. - "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, }, - "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. }, - "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, - "spacingMode": "A String", # The spacing mode for the paragraph. - "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. - { # A tab stop within a paragraph. - "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. - "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. + }, + }, + ], + }, + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this list. + "A String", + ], + "suggestedInsertionId": "A String", # The suggested insertion ID. If empty, then this is not a suggested insertion. + "suggestedListPropertiesChanges": { # The suggested changes to the list properties, keyed by suggestion ID. + "a_key": { # A suggested change to ListProperties. + "listProperties": { # The properties of a list that describe the look and feel of bullets belonging to paragraphs associated with a list. # A ListProperties that only includes the changes made in this suggestion. This can be used along with the list_properties_suggestion_state to see which fields have changed and their new values. + "nestingLevels": [ # Describes the properties of the bullets at the associated level. A list has at most 9 levels of nesting with nesting level 0 corresponding to the top-most level and nesting level 8 corresponding to the most nested level. The nesting levels are returned in ascending order with the least nested returned first. + { # Contains properties describing the look and feel of a list bullet at a given level of nesting. + "bulletAlignment": "A String", # The alignment of the bullet within the space allotted for rendering the bullet. + "glyphFormat": "A String", # The format string used by bullets at this level of nesting. The glyph format contains one or more placeholders, and these placeholders are replaced with the appropriate values depending on the glyph_type or glyph_symbol. The placeholders follow the pattern `%[nesting_level]`. Furthermore, placeholders can have prefixes and suffixes. Thus, the glyph format follows the pattern `%[nesting_level]`. Note that the prefix and suffix are optional and can be arbitrary strings. For example, the glyph format `%0.` indicates that the rendered glyph will replace the placeholder with the corresponding glyph for nesting level 0 followed by a period as the suffix. So a list with a glyph type of UPPER_ALPHA and glyph format `%0.` at nesting level 0 will result in a list with rendered glyphs `A.` `B.` `C.` The glyph format can contain placeholders for the current nesting level as well as placeholders for parent nesting levels. For example, a list can have a glyph format of `%0.` at nesting level 0 and a glyph format of `%0.%1.` at nesting level 1. Assuming both nesting levels have DECIMAL glyph types, this would result in a list with rendered glyphs `1.` `2.` ` 2.1.` ` 2.2.` `3.` For nesting levels that are ordered, the string that replaces a placeholder in the glyph format for a particular paragraph depends on the paragraph's order within the list. + "glyphSymbol": "A String", # A custom glyph symbol used by bullets when paragraphs at this level of nesting are unordered. The glyph symbol replaces placeholders within the glyph_format. For example, if the glyph_symbol is the solid circle corresponding to Unicode U+25cf code point and the glyph_format is `%0`, the rendered glyph would be the solid circle. + "glyphType": "A String", # The type of glyph used by bullets when paragraphs at this level of nesting are ordered. The glyph type determines the type of glyph used to replace placeholders within the glyph_format when paragraphs at this level of nesting are ordered. For example, if the nesting level is 0, the glyph_format is `%0.` and the glyph type is DECIMAL, then the rendered glyph would replace the placeholder `%0` in the glyph format with a number corresponding to list item's order within the list. + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of paragraphs at this level of nesting. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for paragraphs at this level of nesting. Applied to the side that corresponds to the start of the text, based on the paragraph's content direction. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "startNumber": 42, # The number of the first list item at this nesting level. A value of 0 is treated as a value of 1 for lettered lists and Roman numeral lists. For values of both 0 and 1, lettered and Roman numeral lists will begin at `a` and `i` respectively. This value is ignored for nesting levels with unordered glyphs. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of bullets at this level of nesting. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - }, - ], - }, - "positionedObjectIds": [ # The IDs of the positioned objects tethered to this paragraph. - "A String", - ], - "suggestedBulletChanges": { # The suggested changes to this paragraph's bullet. - "a_key": { # A suggested change to a Bullet. - "bullet": { # Describes the bullet of a paragraph. # A Bullet that only includes the changes made in this suggestion. This can be used along with the bullet_suggestion_state to see which fields have changed and their new values. - "listId": "A String", # The ID of the list this paragraph belongs to. - "nestingLevel": 42, # The nesting level of this paragraph in the list. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - "bulletSuggestionState": { # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. - "listIdSuggested": True or False, # Indicates if there was a suggested change to the list_id. - "nestingLevelSuggested": True or False, # Indicates if there was a suggested change to the nesting_level. - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, - }, - }, - }, - "suggestedParagraphStyleChanges": { # The suggested paragraph style changes to this paragraph, keyed by suggestion ID. - "a_key": { # A suggested change to a ParagraphStyle. - "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A ParagraphStyle that only includes the changes made in this suggestion. This can be used along with the paragraph_style_suggestion_state to see which fields have changed and their new values. - "alignment": "A String", # The text alignment for this paragraph. - "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. - "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, }, - "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. }, - }, - "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. - "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. - "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. - "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. - "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. - "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. - "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. - "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. }, - "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "spacingMode": "A String", # The spacing mode for the paragraph. - "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. - { # A tab stop within a paragraph. - "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. - "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - ], - }, - "paragraphStyleSuggestionState": { # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. - "alignmentSuggested": True or False, # Indicates if there was a suggested change to alignment. - "avoidWidowAndOrphanSuggested": True or False, # Indicates if there was a suggested change to avoid_widow_and_orphan. - "borderBetweenSuggested": True or False, # Indicates if there was a suggested change to border_between. - "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. - "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. - "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. - "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. - "directionSuggested": True or False, # Indicates if there was a suggested change to direction. - "headingIdSuggested": True or False, # Indicates if there was a suggested change to heading_id. - "indentEndSuggested": True or False, # Indicates if there was a suggested change to indent_end. - "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line. - "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start. - "keepLinesTogetherSuggested": True or False, # Indicates if there was a suggested change to keep_lines_together. - "keepWithNextSuggested": True or False, # Indicates if there was a suggested change to keep_with_next. - "lineSpacingSuggested": True or False, # Indicates if there was a suggested change to line_spacing. - "namedStyleTypeSuggested": True or False, # Indicates if there was a suggested change to named_style_type. - "pageBreakBeforeSuggested": True or False, # Indicates if there was a suggested change to page_break_before. - "shadingSuggestionState": { # A mask that indicates which of the fields on the base Shading have been changed in this suggested change. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in shading have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to the Shading. + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, - "spaceAboveSuggested": True or False, # Indicates if there was a suggested change to space_above. - "spaceBelowSuggested": True or False, # Indicates if there was a suggested change to space_below. - "spacingModeSuggested": True or False, # Indicates if there was a suggested change to spacing_mode. }, }, - }, - "suggestedPositionedObjectIds": { # The IDs of the positioned objects suggested to be attached to this paragraph, keyed by suggestion ID. - "a_key": { # A collection of object IDs. - "objectIds": [ # The object IDs. - "A String", - ], - }, + ], + }, + "listPropertiesSuggestionState": { # A mask that indicates which of the fields on the base ListProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base ListProperties have been changed in this suggestion. + "nestingLevelsSuggestionStates": [ # A mask that indicates which of the fields on the corresponding NestingLevel in nesting_levels have been changed in this suggestion. The nesting level suggestion states are returned in ascending order of the nesting level with the least nested returned first. + { # A mask that indicates which of the fields on the base NestingLevel have been changed in this suggestion. For any field set to true, there's a new suggested value. + "bulletAlignmentSuggested": True or False, # Indicates if there was a suggested change to bullet_alignment. + "glyphFormatSuggested": True or False, # Indicates if there was a suggested change to glyph_format. + "glyphSymbolSuggested": True or False, # Indicates if there was a suggested change to glyph_symbol. + "glyphTypeSuggested": True or False, # Indicates if there was a suggested change to glyph_type. + "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line. + "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start. + "startNumberSuggested": True or False, # Indicates if there was a suggested change to start_number. + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + ], + }, + }, + }, + }, + }, + "namedRanges": { # Output only. The named ranges in the document, keyed by name. + "a_key": { # A collection of all the NamedRanges in the document that share a given name. + "name": "A String", # The name that all the named ranges share. + "namedRanges": [ # The NamedRanges that share the same name. + { # A collection of Ranges with the same named range ID. Named ranges allow developers to associate parts of a document with an arbitrary user-defined label so their contents can be programmatically read or edited later. A document can contain multiple named ranges with the same name, but every named range has a unique ID. A named range is created with a single Range, and content inserted inside a named range generally expands that range. However, certain document changes can cause the range to be split into multiple ranges. Named ranges are not private. All applications and collaborators that have access to the document can see its named ranges. + "name": "A String", # The name of the named range. + "namedRangeId": "A String", # The ID of the named range. + "ranges": [ # The ranges that belong to this named range. + { # Specifies a contiguous range of text. + "endIndex": 42, # The zero-based end index of this range, exclusive, in UTF-16 code units. In all current uses, an end index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges. + "segmentId": "A String", # The ID of the header, footer, or footnote that this range is contained in. An empty segment ID signifies the document's body. + "startIndex": 42, # The zero-based start index of this range, in UTF-16 code units. In all current uses, a start index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges. + "tabId": "A String", # The tab that contains this range. When omitted, the request applies to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. + }, + ], + }, + ], + }, + }, + "namedStyles": { # The named styles. Paragraphs in the document can inherit their TextStyle and ParagraphStyle from these named styles. # Output only. The named styles of the document. + "styles": [ # The named styles. There's an entry for each of the possible named style types. + { # A named style. Paragraphs in the document can inherit their TextStyle and ParagraphStyle from this named style when they have the same named style type. + "namedStyleType": "A String", # The type of this named style. + "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph style of this named style. + "alignment": "A String", # The text alignment for this paragraph. + "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. + "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, }, - "sectionBreak": { # A StructuralElement representing a section break. A section is a range of content that has the same SectionStyle. A section break represents the start of a new section, and the section style applies to the section after the section break. The document body always begins with a section break. # A section break type of structural element. - "sectionStyle": { # The styling that applies to a section. # The style of the section after this section break. - "columnProperties": [ # The section's columns properties. If empty, the section contains one column with the default properties in the Docs editor. A section can be updated to have no more than 3 columns. When updating this property, setting a concrete value is required. Unsetting this property will result in a 400 bad request error. - { # Properties that apply to a section's column. - "paddingEnd": { # A magnitude in a single direction in the specified units. # The padding at the end of the column. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # Output only. The width of the column. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, + "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, - ], - "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only. - "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only. - "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only. - "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only. - "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only. - "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only. - "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. }, - "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, - "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, - "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, - "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. + "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. + "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. + "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. + "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. + "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. + "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. + "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, - "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + }, + }, + "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spacingMode": "A String", # The spacing mode for the paragraph. + "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. + { # A tab stop within a paragraph. + "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. + "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "sectionType": "A String", # Output only. The type of section. - "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. }, - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A SectionBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], + ], + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this named style. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, }, - "startIndex": 42, # The zero-based start index of this structural element, in UTF-16 code units. - "table": { # A StructuralElement representing a table. # A table type of structural element. - "columns": 42, # Number of columns in the table. It's possible for a table to be non-rectangular, so some rows may have a different number of cells. - "rows": 42, # Number of rows in the table. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A Table may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "tableRows": [ # The contents and style of each row. - { # The contents and style of a row in a Table. - "endIndex": 42, # The zero-based end index of this row, exclusive, in UTF-16 code units. - "startIndex": 42, # The zero-based start index of this row, in UTF-16 code units. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A TableRow may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTableRowStyleChanges": { # The suggested style changes to this row, keyed by suggestion ID. - "a_key": { # A suggested change to a TableRowStyle. - "tableRowStyle": { # Styles that apply to a table row. # A TableRowStyle that only includes the changes made in this suggestion. This can be used along with the table_row_style_suggestion_state to see which fields have changed and their new values. - "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries. - "tableHeader": True or False, # Whether the row is a table header. - }, - "tableRowStyleSuggestionState": { # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. - "minRowHeightSuggested": True or False, # Indicates if there was a suggested change to min_row_height. + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + ], + }, + "positionedObjects": { # Output only. The positioned objects in the document, keyed by object ID. + "a_key": { # An object that's tethered to a Paragraph and positioned relative to the beginning of the paragraph. A PositionedObject contains an EmbeddedObject such as an image. + "objectId": "A String", # The ID of this positioned object. + "positionedObjectProperties": { # Properties of a PositionedObject. # The properties of this positioned object. + "embeddedObject": { # An embedded object in the document. # The embedded object of this positioned object. + "description": "A String", # The description of the embedded object. The `title` and `description` are both combined to display alt text. + "embeddedDrawingProperties": { # The properties of an embedded drawing and used to differentiate the object type. An embedded drawing is one that's created and edited within a document. Note that extensive details are not supported. # The properties of an embedded drawing. + }, + "embeddedObjectBorder": { # A border around an EmbeddedObject. # The border of the embedded object. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "propertyState": "A String", # The property state of the border property. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "imageProperties": { # The properties of an image. # The properties of an image. + "angle": 3.14, # The clockwise rotation angle of the image, in radians. + "brightness": 3.14, # The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. + "contentUri": "A String", # A URI to the image with a default lifetime of 30 minutes. This URI is tagged with the account of the requester. Anyone with the URI effectively accesses the image as the original requester. Access to the image may be lost if the document's sharing settings change. + "contrast": 3.14, # The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. + "cropProperties": { # The crop properties of an image. The crop rectangle is represented using fractional offsets from the original content's 4 edges. - If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the image's original bounding rectangle. - If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the image's original bounding rectangle. - If all offsets and rotation angle are 0, the image is not cropped. # The crop properties of the image. + "angle": 3.14, # The clockwise rotation angle of the crop rectangle around its center, in radians. Rotation is applied after the offsets. + "offsetBottom": 3.14, # The offset specifies how far inwards the bottom edge of the crop rectangle is from the bottom edge of the original content as a fraction of the original content's height. + "offsetLeft": 3.14, # The offset specifies how far inwards the left edge of the crop rectangle is from the left edge of the original content as a fraction of the original content's width. + "offsetRight": 3.14, # The offset specifies how far inwards the right edge of the crop rectangle is from the right edge of the original content as a fraction of the original content's width. + "offsetTop": 3.14, # The offset specifies how far inwards the top edge of the crop rectangle is from the top edge of the original content as a fraction of the original content's height. + }, + "sourceUri": "A String", # The source URI is the URI used to insert the image. The source URI can be empty. + "transparency": 3.14, # The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means transparent. + }, + "linkedContentReference": { # A reference to the external linked source content. # A reference to the external linked source content. For example, it contains a reference to the source Google Sheets chart when the embedded object is a linked chart. If unset, then the embedded object is not linked. + "sheetsChartReference": { # A reference to a linked chart embedded from Google Sheets. # A reference to the linked chart. + "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that's embedded. + "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart. + }, + }, + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginLeft": { # A magnitude in a single direction in the specified units. # The left margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginRight": { # A magnitude in a single direction in the specified units. # The right margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginTop": { # A magnitude in a single direction in the specified units. # The top margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "size": { # A width and height. # The visible size of the image after cropping. + "height": { # A magnitude in a single direction in the specified units. # The height of the object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "title": "A String", # The title of the embedded object. The `title` and `description` are both combined to display alt text. + }, + "positioning": { # The positioning of a PositionedObject. The positioned object is positioned relative to the beginning of the Paragraph it's tethered to. # The positioning of this positioned object relative to the newline of the Paragraph that references this positioned object. + "layout": "A String", # The layout of this positioned object. + "leftOffset": { # A magnitude in a single direction in the specified units. # The offset of the left edge of the positioned object relative to the beginning of the Paragraph it's tethered to. The exact positioning of the object can depend on other content in the document and the document's styling. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "topOffset": { # A magnitude in a single direction in the specified units. # The offset of the top edge of the positioned object relative to the beginning of the Paragraph it's tethered to. The exact positioning of the object can depend on other content in the document and the document's styling. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + }, + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionId": "A String", # The suggested insertion ID. If empty, then this is not a suggested insertion. + "suggestedPositionedObjectPropertiesChanges": { # The suggested changes to the positioned object properties, keyed by suggestion ID. + "a_key": { # A suggested change to PositionedObjectProperties. + "positionedObjectProperties": { # Properties of a PositionedObject. # A PositionedObjectProperties that only includes the changes made in this suggestion. This can be used along with the positioned_object_properties_suggestion_state to see which fields have changed and their new values. + "embeddedObject": { # An embedded object in the document. # The embedded object of this positioned object. + "description": "A String", # The description of the embedded object. The `title` and `description` are both combined to display alt text. + "embeddedDrawingProperties": { # The properties of an embedded drawing and used to differentiate the object type. An embedded drawing is one that's created and edited within a document. Note that extensive details are not supported. # The properties of an embedded drawing. + }, + "embeddedObjectBorder": { # A border around an EmbeddedObject. # The border of the embedded object. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, }, - "tableCells": [ # The contents and style of each cell in this row. It's possible for a table to be non-rectangular, so some rows may have a different number of cells than other rows in the same table. - { # The contents and style of a cell in a Table. - "content": [ # The content of the cell. - # Object with schema name: StructuralElement - ], - "endIndex": 42, # The zero-based end index of this cell, exclusive, in UTF-16 code units. - "startIndex": 42, # The zero-based start index of this cell, in UTF-16 code units. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A TableCell may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTableCellStyleChanges": { # The suggested changes to the table cell style, keyed by suggestion ID. - "a_key": { # A suggested change to a TableCellStyle. - "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # A TableCellStyle that only includes the changes made in this suggestion. This can be used along with the table_cell_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "columnSpan": 42, # The column span of the cell. This property is read-only. - "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. - "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "rowSpan": 42, # The row span of the cell. This property is read-only. - }, - "tableCellStyleSuggestionState": { # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. - "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. - "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. - "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. - "columnSpanSuggested": True or False, # Indicates if there was a suggested change to column_span. - "contentAlignmentSuggested": True or False, # Indicates if there was a suggested change to content_alignment. - "paddingBottomSuggested": True or False, # Indicates if there was a suggested change to padding_bottom. - "paddingLeftSuggested": True or False, # Indicates if there was a suggested change to padding_left. - "paddingRightSuggested": True or False, # Indicates if there was a suggested change to padding_right. - "paddingTopSuggested": True or False, # Indicates if there was a suggested change to padding_top. - "rowSpanSuggested": True or False, # Indicates if there was a suggested change to row_span. - }, - }, - }, - "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # The style of the cell. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "columnSpan": 42, # The column span of the cell. This property is read-only. - "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. - "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "rowSpan": 42, # The row span of the cell. This property is read-only. - }, - }, - ], - "tableRowStyle": { # Styles that apply to a table row. # The style of the table row. - "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries. - "tableHeader": True or False, # Whether the row is a table header. + "dashStyle": "A String", # The dash style of the border. + "propertyState": "A String", # The property state of the border property. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, }, - ], - "tableStyle": { # Styles that apply to a table. # The style of the table. - "tableColumnProperties": [ # The properties of each column. Note that in Docs, tables contain rows and rows contain cells, similar to HTML. So the properties for a row can be found on the row's table_row_style. - { # The properties of a column in a table. - "width": { # A magnitude in a single direction in the specified units. # The width of the column. Set when the column's `width_type` is FIXED_WIDTH. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "widthType": "A String", # The width type of the column. + "imageProperties": { # The properties of an image. # The properties of an image. + "angle": 3.14, # The clockwise rotation angle of the image, in radians. + "brightness": 3.14, # The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. + "contentUri": "A String", # A URI to the image with a default lifetime of 30 minutes. This URI is tagged with the account of the requester. Anyone with the URI effectively accesses the image as the original requester. Access to the image may be lost if the document's sharing settings change. + "contrast": 3.14, # The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. + "cropProperties": { # The crop properties of an image. The crop rectangle is represented using fractional offsets from the original content's 4 edges. - If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the image's original bounding rectangle. - If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the image's original bounding rectangle. - If all offsets and rotation angle are 0, the image is not cropped. # The crop properties of the image. + "angle": 3.14, # The clockwise rotation angle of the crop rectangle around its center, in radians. Rotation is applied after the offsets. + "offsetBottom": 3.14, # The offset specifies how far inwards the bottom edge of the crop rectangle is from the bottom edge of the original content as a fraction of the original content's height. + "offsetLeft": 3.14, # The offset specifies how far inwards the left edge of the crop rectangle is from the left edge of the original content as a fraction of the original content's width. + "offsetRight": 3.14, # The offset specifies how far inwards the right edge of the crop rectangle is from the right edge of the original content as a fraction of the original content's width. + "offsetTop": 3.14, # The offset specifies how far inwards the top edge of the crop rectangle is from the top edge of the original content as a fraction of the original content's height. }, - ], - }, - }, - "tableOfContents": { # A StructuralElement representing a table of contents. # A table of contents type of structural element. - "content": [ # The content of the table of contents. - # Object with schema name: StructuralElement - ], - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A TableOfContents may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - }, - }, - ], - "footnoteId": "A String", # The ID of the footnote. - }, - }, - "headers": { # Output only. The headers in the document, keyed by header ID. - "a_key": { # A document header. - "content": [ # The contents of the header. The indexes for a header's content begin at zero. - { # A StructuralElement describes content that provides structure to the document. - "endIndex": 42, # The zero-based end index of this structural element, exclusive, in UTF-16 code units. - "paragraph": { # A StructuralElement representing a paragraph. A paragraph is a range of content that's terminated with a newline character. # A paragraph type of structural element. - "bullet": { # Describes the bullet of a paragraph. # The bullet for this paragraph. If not present, the paragraph does not belong to a list. - "listId": "A String", # The ID of the list this paragraph belongs to. - "nestingLevel": 42, # The nesting level of this paragraph in the list. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, + "sourceUri": "A String", # The source URI is the URI used to insert the image. The source URI can be empty. + "transparency": 3.14, # The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means transparent. + }, + "linkedContentReference": { # A reference to the external linked source content. # A reference to the external linked source content. For example, it contains a reference to the source Google Sheets chart when the embedded object is a linked chart. If unset, then the embedded object is not linked. + "sheetsChartReference": { # A reference to a linked chart embedded from Google Sheets. # A reference to the linked chart. + "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that's embedded. + "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart. }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + }, + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginLeft": { # A magnitude in a single direction in the specified units. # The left margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginRight": { # A magnitude in a single direction in the specified units. # The right margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginTop": { # A magnitude in a single direction in the specified units. # The top margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "size": { # A width and height. # The visible size of the image after cropping. + "height": { # A magnitude in a single direction in the specified units. # The height of the object. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "width": { # A magnitude in a single direction in the specified units. # The width of the object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, }, + "title": "A String", # The title of the embedded object. The `title` and `description` are both combined to display alt text. }, - "elements": [ # The content of the paragraph, broken down into its component parts. - { # A ParagraphElement describes content within a Paragraph. - "autoText": { # A ParagraphElement representing a spot in the text that's dynamically replaced with content that can change over time, like a page number. # An auto text paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. An AutoText may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this AutoText, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, + "positioning": { # The positioning of a PositionedObject. The positioned object is positioned relative to the beginning of the Paragraph it's tethered to. # The positioning of this positioned object relative to the newline of the Paragraph that references this positioned object. + "layout": "A String", # The layout of this positioned object. + "leftOffset": { # A magnitude in a single direction in the specified units. # The offset of the left edge of the positioned object relative to the beginning of the Paragraph it's tethered to. The exact positioning of the object can depend on other content in the document and the document's styling. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "topOffset": { # A magnitude in a single direction in the specified units. # The offset of the top edge of the positioned object relative to the beginning of the Paragraph it's tethered to. The exact positioning of the object can depend on other content in the document and the document's styling. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + }, + "positionedObjectPropertiesSuggestionState": { # A mask that indicates which of the fields on the base PositionedObjectProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base PositionedObjectProperties have been changed in this suggestion. + "embeddedObjectSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedObject have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_object have been changed in this suggestion. + "descriptionSuggested": True or False, # Indicates if there was a suggested change to description. + "embeddedDrawingPropertiesSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedDrawingProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_drawing_properties have been changed in this suggestion. + }, + "embeddedObjectBorderSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedObjectBorder have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_object_border have been changed in this suggestion. + "colorSuggested": True or False, # Indicates if there was a suggested change to color. + "dashStyleSuggested": True or False, # Indicates if there was a suggested change to dash_style. + "propertyStateSuggested": True or False, # Indicates if there was a suggested change to property_state. + "widthSuggested": True or False, # Indicates if there was a suggested change to width. + }, + "imagePropertiesSuggestionState": { # A mask that indicates which of the fields on the base ImageProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in image_properties have been changed in this suggestion. + "angleSuggested": True or False, # Indicates if there was a suggested change to angle. + "brightnessSuggested": True or False, # Indicates if there was a suggested change to brightness. + "contentUriSuggested": True or False, # Indicates if there was a suggested change to content_uri. + "contrastSuggested": True or False, # Indicates if there was a suggested change to contrast. + "cropPropertiesSuggestionState": { # A mask that indicates which of the fields on the base CropProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in crop_properties have been changed in this suggestion. + "angleSuggested": True or False, # Indicates if there was a suggested change to angle. + "offsetBottomSuggested": True or False, # Indicates if there was a suggested change to offset_bottom. + "offsetLeftSuggested": True or False, # Indicates if there was a suggested change to offset_left. + "offsetRightSuggested": True or False, # Indicates if there was a suggested change to offset_right. + "offsetTopSuggested": True or False, # Indicates if there was a suggested change to offset_top. + }, + "sourceUriSuggested": True or False, # Indicates if there was a suggested change to source_uri. + "transparencySuggested": True or False, # Indicates if there was a suggested change to transparency. + }, + "linkedContentReferenceSuggestionState": { # A mask that indicates which of the fields on the base LinkedContentReference have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in linked_content_reference have been changed in this suggestion. + "sheetsChartReferenceSuggestionState": { # A mask that indicates which of the fields on the base SheetsChartReference have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in sheets_chart_reference have been changed in this suggestion. + "chartIdSuggested": True or False, # Indicates if there was a suggested change to chart_id. + "spreadsheetIdSuggested": True or False, # Indicates if there was a suggested change to spreadsheet_id. + }, + }, + "marginBottomSuggested": True or False, # Indicates if there was a suggested change to margin_bottom. + "marginLeftSuggested": True or False, # Indicates if there was a suggested change to margin_left. + "marginRightSuggested": True or False, # Indicates if there was a suggested change to margin_right. + "marginTopSuggested": True or False, # Indicates if there was a suggested change to margin_top. + "sizeSuggestionState": { # A mask that indicates which of the fields on the base Size have been changed in this suggestion. For any field set to true, the Size has a new suggested value. # A mask that indicates which of the fields in size have been changed in this suggestion. + "heightSuggested": True or False, # Indicates if there was a suggested change to height. + "widthSuggested": True or False, # Indicates if there was a suggested change to width. + }, + "titleSuggested": True or False, # Indicates if there was a suggested change to title. + }, + "positioningSuggestionState": { # A mask that indicates which of the fields on the base PositionedObjectPositioning have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in positioning have been changed in this suggestion. + "layoutSuggested": True or False, # Indicates if there was a suggested change to layout. + "leftOffsetSuggested": True or False, # Indicates if there was a suggested change to left_offset. + "topOffsetSuggested": True or False, # Indicates if there was a suggested change to top_offset. + }, + }, + }, + }, + }, + }, + "revisionId": "A String", # Output only. The revision ID of the document. Can be used in update requests to specify which revision of a document to apply updates to and how the request should behave if the document has been edited since that revision. Only populated if the user has edit access to the document. The revision ID is not a sequential number but an opaque string. The format of the revision ID might change over time. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the document has not changed. Conversely, a changed ID (for the same document and user) usually means the document has been updated. However, a changed ID can also be due to internal factors such as ID format changes. + "suggestedDocumentStyleChanges": { # Output only. The suggested changes to the style of the document, keyed by suggestion ID. + "a_key": { # A suggested change to the DocumentStyle. + "documentStyle": { # The style of the document. # A DocumentStyle that only includes the changes made in this suggestion. This can be used along with the document_style_suggestion_state to see which fields have changed and their new values. + "background": { # Represents the background of a document. # The background of the document. Documents cannot have a transparent background color. + "color": { # A color that can either be fully opaque or fully transparent. # The background color. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + }, + "defaultFooterId": "A String", # The ID of the default footer. If not set, there's no default footer. This property is read-only. + "defaultHeaderId": "A String", # The ID of the default header. If not set, there's no default header. This property is read-only. + "evenPageFooterId": "A String", # The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. This property is read-only. + "evenPageHeaderId": "A String", # The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. This property is read-only. + "firstPageFooterId": "A String", # The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. This property is read-only. + "firstPageHeaderId": "A String", # The ID of the header used only for the first page. If not set then a unique header for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_header_id or this value for the header on the first page. If not set, there's no first page header. This property is read-only. + "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of the page_size, which allows changing the page orientation between portrait and landscape. + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin. Updating the bottom page margin on the document style clears the bottom page margin on all section styles. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginFooter": { # A magnitude in a single direction in the specified units. # The amount of space between the bottom of the page and the contents of the footer. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginHeader": { # A magnitude in a single direction in the specified units. # The amount of space between the top of the page and the contents of the header. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin. Updating the left page margin on the document style clears the left page margin on all section styles. It may also cause columns to resize in all sections. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin. Updating the right page margin on the document style clears the right page margin on all section styles. It may also cause columns to resize in all sections. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin. Updating the top page margin on the document style clears the top page margin on all section styles. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "pageNumberStart": 42, # The page number from which to start counting the number of pages. + "pageSize": { # A width and height. # The size of a page in the document. + "height": { # A magnitude in a single direction in the specified units. # The height of the object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "useCustomHeaderFooterMargins": True or False, # Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected. When false, the default values in the Docs editor for header and footer margin are used. This property is read-only. + "useEvenPageHeaderFooter": True or False, # Indicates whether to use the even page header / footer IDs for the even pages. + "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page. + }, + "documentStyleSuggestionState": { # A mask that indicates which of the fields on the base DocumentStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DocumentStyle have been changed in this suggestion. + "backgroundSuggestionState": { # A mask that indicates which of the fields on the base Background have been changed in this suggestion. For any field set to true, the Backgound has a new suggested value. # A mask that indicates which of the fields in background have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates whether the current background color has been modified in this suggestion. + }, + "defaultFooterIdSuggested": True or False, # Indicates if there was a suggested change to default_footer_id. + "defaultHeaderIdSuggested": True or False, # Indicates if there was a suggested change to default_header_id. + "evenPageFooterIdSuggested": True or False, # Indicates if there was a suggested change to even_page_footer_id. + "evenPageHeaderIdSuggested": True or False, # Indicates if there was a suggested change to even_page_header_id. + "firstPageFooterIdSuggested": True or False, # Indicates if there was a suggested change to first_page_footer_id. + "firstPageHeaderIdSuggested": True or False, # Indicates if there was a suggested change to first_page_header_id. + "flipPageOrientationSuggested": True or False, # Optional. Indicates if there was a suggested change to flip_page_orientation. + "marginBottomSuggested": True or False, # Indicates if there was a suggested change to margin_bottom. + "marginFooterSuggested": True or False, # Indicates if there was a suggested change to margin_footer. + "marginHeaderSuggested": True or False, # Indicates if there was a suggested change to margin_header. + "marginLeftSuggested": True or False, # Indicates if there was a suggested change to margin_left. + "marginRightSuggested": True or False, # Indicates if there was a suggested change to margin_right. + "marginTopSuggested": True or False, # Indicates if there was a suggested change to margin_top. + "pageNumberStartSuggested": True or False, # Indicates if there was a suggested change to page_number_start. + "pageSizeSuggestionState": { # A mask that indicates which of the fields on the base Size have been changed in this suggestion. For any field set to true, the Size has a new suggested value. # A mask that indicates which of the fields in size have been changed in this suggestion. + "heightSuggested": True or False, # Indicates if there was a suggested change to height. + "widthSuggested": True or False, # Indicates if there was a suggested change to width. + }, + "useCustomHeaderFooterMarginsSuggested": True or False, # Indicates if there was a suggested change to use_custom_header_footer_margins. + "useEvenPageHeaderFooterSuggested": True or False, # Indicates if there was a suggested change to use_even_page_header_footer. + "useFirstPageHeaderFooterSuggested": True or False, # Indicates if there was a suggested change to use_first_page_header_footer. + }, + }, + }, + "suggestedNamedStylesChanges": { # Output only. The suggested changes to the named styles of the document, keyed by suggestion ID. + "a_key": { # A suggested change to the NamedStyles. + "namedStyles": { # The named styles. Paragraphs in the document can inherit their TextStyle and ParagraphStyle from these named styles. # A NamedStyles that only includes the changes made in this suggestion. This can be used along with the named_styles_suggestion_state to see which fields have changed and their new values. + "styles": [ # The named styles. There's an entry for each of the possible named style types. + { # A named style. Paragraphs in the document can inherit their TextStyle and ParagraphStyle from this named style when they have the same named style type. + "namedStyleType": "A String", # The type of this named style. + "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph style of this named style. + "alignment": "A String", # The text alignment for this paragraph. + "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. + "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this AutoText. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. + "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. + "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. + "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. + "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. + "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. + "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. + "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + }, + "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spacingMode": "A String", # The spacing mode for the paragraph. + "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. + { # A tab stop within a paragraph. + "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. + "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + ], + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this named style. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + ], + }, + "namedStylesSuggestionState": { # The suggestion state of a NamedStyles message. # A mask that indicates which of the fields on the base NamedStyles have been changed in this suggestion. + "stylesSuggestionStates": [ # A mask that indicates which of the fields on the corresponding NamedStyle in styles have been changed in this suggestion. The order of these named style suggestion states matches the order of the corresponding named style within the named styles suggestion. + { # A suggestion state of a NamedStyle message. + "namedStyleType": "A String", # The named style type that this suggestion state corresponds to. This field is provided as a convenience for matching the NamedStyleSuggestionState with its corresponding NamedStyle. + "paragraphStyleSuggestionState": { # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in paragraph style have been changed in this suggestion. + "alignmentSuggested": True or False, # Indicates if there was a suggested change to alignment. + "avoidWidowAndOrphanSuggested": True or False, # Indicates if there was a suggested change to avoid_widow_and_orphan. + "borderBetweenSuggested": True or False, # Indicates if there was a suggested change to border_between. + "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. + "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. + "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. + "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. + "directionSuggested": True or False, # Indicates if there was a suggested change to direction. + "headingIdSuggested": True or False, # Indicates if there was a suggested change to heading_id. + "indentEndSuggested": True or False, # Indicates if there was a suggested change to indent_end. + "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line. + "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start. + "keepLinesTogetherSuggested": True or False, # Indicates if there was a suggested change to keep_lines_together. + "keepWithNextSuggested": True or False, # Indicates if there was a suggested change to keep_with_next. + "lineSpacingSuggested": True or False, # Indicates if there was a suggested change to line_spacing. + "namedStyleTypeSuggested": True or False, # Indicates if there was a suggested change to named_style_type. + "pageBreakBeforeSuggested": True or False, # Indicates if there was a suggested change to page_break_before. + "shadingSuggestionState": { # A mask that indicates which of the fields on the base Shading have been changed in this suggested change. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in shading have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to the Shading. + }, + "spaceAboveSuggested": True or False, # Indicates if there was a suggested change to space_above. + "spaceBelowSuggested": True or False, # Indicates if there was a suggested change to space_below. + "spacingModeSuggested": True or False, # Indicates if there was a suggested change to spacing_mode. + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + ], + }, + }, + }, + "suggestionsViewMode": "A String", # Output only. The suggestions view mode applied to the document. Note: When editing a document, changes must be based on a document with SUGGESTIONS_INLINE. + "tabs": [ # Tabs that are part of a document. Tabs can contain child tabs, a tab nested within another tab. Child tabs are represented by the Tab.child_tabs field. + { # A tab in a document. + "childTabs": [ # The child tabs nested within this tab. + # Object with schema name: Tab + ], + "documentTab": { # A tab with document contents. # A tab with document contents, like text and images. + "body": { # The document body. The body typically contains the full document contents except for headers, footers, and footnotes. # The main body of the document tab. + "content": [ # The contents of the body. The indexes for the body's content begin at zero. + { # A StructuralElement describes content that provides structure to the document. + "endIndex": 42, # The zero-based end index of this structural element, exclusive, in UTF-16 code units. + "paragraph": { # A StructuralElement representing a paragraph. A paragraph is a range of content that's terminated with a newline character. # A paragraph type of structural element. + "bullet": { # Describes the bullet of a paragraph. # The bullet for this paragraph. If not present, the paragraph does not belong to a list. + "listId": "A String", # The ID of the list this paragraph belongs to. + "nestingLevel": 42, # The nesting level of this paragraph in the list. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. "bold": True or False, # Whether or not the text is rendered as bold. "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. "magnitude": 3.14, # The magnitude. @@ -22897,8 +28017,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -22909,28 +28038,92 @@

Method Details

"weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, - "type": "A String", # The type of this auto text. }, - "columnBreak": { # A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column. # A column break paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this ColumnBreak, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "elements": [ # The content of the paragraph, broken down into its component parts. + { # A ParagraphElement describes content within a Paragraph. + "autoText": { # A ParagraphElement representing a spot in the text that's dynamically replaced with content that can change over time, like a page number. # An auto text paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. An AutoText may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this AutoText, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this AutoText. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. "bold": True or False, # Whether or not the text is rendered as bold. "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. "magnitude": 3.14, # The magnitude. @@ -22947,8 +28140,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -22959,82 +28161,81 @@

Method Details

"weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, - }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, + "type": "A String", # The type of this auto text. }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - "endIndex": 42, # The zero-base end index of this paragraph element, exclusive, in UTF-16 code units. - "equation": { # A ParagraphElement representing an equation. # An equation paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. An Equation may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - }, - "footnoteReference": { # A ParagraphElement representing a footnote reference. A footnote reference is the inline content rendered with a number and is used to identify the footnote. # A footnote reference paragraph element. - "footnoteId": "A String", # The ID of the footnote that contains the content of this footnote reference. - "footnoteNumber": "A String", # The rendered number of this footnote. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this FootnoteReference, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "columnBreak": { # A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column. # A column break paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this ColumnBreak, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. @@ -23061,8 +28262,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -23073,71 +28283,91 @@

Method Details

"weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, - }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this FootnoteReference. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - "horizontalRule": { # A ParagraphElement representing a horizontal line. # A horizontal rule paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A HorizontalRule may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this HorizontalRule, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "endIndex": 42, # The zero-base end index of this paragraph element, exclusive, in UTF-16 code units. + "equation": { # A ParagraphElement representing an equation. # An equation paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. An Equation may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + }, + "footnoteReference": { # A ParagraphElement representing a footnote reference. A footnote reference is the inline content rendered with a number and is used to identify the footnote. # A footnote reference paragraph element. + "footnoteId": "A String", # The ID of the footnote that contains the content of this footnote reference. + "footnoteNumber": "A String", # The rendered number of this footnote. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this FootnoteReference, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this FootnoteReference. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. @@ -23164,8 +28394,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -23176,72 +28415,80 @@

Method Details

"weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, - }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this HorizontalRule. Similar to text content, like text runs and footnote references, the text style of a horizontal rule can affect content layout as well as the styling of text inserted next to it. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - "inlineObjectElement": { # A ParagraphElement that contains an InlineObject. # An inline object paragraph element. - "inlineObjectId": "A String", # The ID of the InlineObject this element contains. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. An InlineObjectElement may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this InlineObject, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "horizontalRule": { # A ParagraphElement representing a horizontal line. # A horizontal rule paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A HorizontalRule may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this HorizontalRule, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this HorizontalRule. Similar to text content, like text runs and footnote references, the text style of a horizontal rule can affect content layout as well as the styling of text inserted next to it. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. @@ -23268,8 +28515,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -23280,71 +28536,81 @@

Method Details

"weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, - }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this InlineObjectElement. Similar to text content, like text runs and footnote references, the text style of an inline object element can affect content layout as well as the styling of text inserted next to it. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, - }, - }, - "pageBreak": { # A ParagraphElement representing a page break. A page break makes the subsequent text start at the top of the next page. # A page break paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A PageBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this PageBreak, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "inlineObjectElement": { # A ParagraphElement that contains an InlineObject. # An inline object paragraph element. + "inlineObjectId": "A String", # The ID of the InlineObject this element contains. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. An InlineObjectElement may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this InlineObject, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this InlineObjectElement. Similar to text content, like text runs and footnote references, the text style of an inline object element can affect content layout as well as the styling of text inserted next to it. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. @@ -23371,8 +28637,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -23383,76 +28658,80 @@

Method Details

"weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, - }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this PageBreak. Similar to text content, like text runs and footnote references, the text style of a page break can affect content layout as well as the styling of text inserted next to it. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, - }, - }, - "person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address. - "personId": "A String", # Output only. The unique ID of this link. - "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present. - "email": "A String", # Output only. The email address linked to this Person. This field is always present. - "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address. - }, - "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. - "A String", - ], - "suggestedInsertionIds": [ # IDs for suggestions that insert this person link into the document. A Person might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this Person, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "pageBreak": { # A ParagraphElement representing a page break. A page break makes the subsequent text start at the top of the next page. # A page break paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A PageBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this PageBreak, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this PageBreak. Similar to text content, like text runs and footnote references, the text style of a page break can affect content layout as well as the styling of text inserted next to it. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. @@ -23479,8 +28758,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -23491,77 +28779,85 @@

Method Details

"weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this Person. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + "person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address. + "personId": "A String", # Output only. The unique ID of this link. + "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present. + "email": "A String", # Output only. The email address linked to this Person. This field is always present. + "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address. }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - "richLink": { # A link to a Google resource (such as a file in Drive, a YouTube video, or a Calendar event). # A paragraph element that links to a Google resource (such as a file in Google Drive, a YouTube video, or a Calendar event.) - "richLinkId": "A String", # Output only. The ID of this link. - "richLinkProperties": { # Properties specific to a RichLink. # Output only. The properties of this RichLink. This field is always present. - "mimeType": "A String", # Output only. The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the RichLink, if there's one (for example, when it's a file in Drive). - "title": "A String", # Output only. The title of the RichLink as displayed in the link. This title matches the title of the linked resource at the time of the insertion or last update of the link. This field is always present. - "uri": "A String", # Output only. The URI to the RichLink. This is always present. - }, - "suggestedDeletionIds": [ # IDs for suggestions that remove this link from the document. A RichLink might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. - "A String", - ], - "suggestedInsertionIds": [ # IDs for suggestions that insert this link into the document. A RichLink might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this RichLink, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. + "A String", + ], + "suggestedInsertionIds": [ # IDs for suggestions that insert this person link into the document. A Person might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this Person, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this Person. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. @@ -23588,8 +28884,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -23600,73 +28905,209 @@

Method Details

"weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this RichLink. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "richLink": { # A link to a Google resource (such as a file in Drive, a YouTube video, or a Calendar event). # A paragraph element that links to a Google resource (such as a file in Google Drive, a YouTube video, or a Calendar event.) + "richLinkId": "A String", # Output only. The ID of this link. + "richLinkProperties": { # Properties specific to a RichLink. # Output only. The properties of this RichLink. This field is always present. + "mimeType": "A String", # Output only. The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the RichLink, if there's one (for example, when it's a file in Drive). + "title": "A String", # Output only. The title of the RichLink as displayed in the link. This title matches the title of the linked resource at the time of the insertion or last update of the link. This field is always present. + "uri": "A String", # Output only. The URI to the RichLink. This is always present. + }, + "suggestedDeletionIds": [ # IDs for suggestions that remove this link from the document. A RichLink might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. + "A String", + ], + "suggestedInsertionIds": [ # IDs for suggestions that insert this link into the document. A RichLink might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this RichLink, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this RichLink. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - "startIndex": 42, # The zero-based start index of this paragraph element, in UTF-16 code units. - "textRun": { # A ParagraphElement that represents a run of text that all has the same styling. # A text run paragraph element. - "content": "A String", # The text of this run. Any non-text elements in the run are replaced with the Unicode character U+E907. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A TextRun may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this run, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "startIndex": 42, # The zero-based start index of this paragraph element, in UTF-16 code units. + "textRun": { # A ParagraphElement that represents a run of text that all has the same styling. # A text run paragraph element. + "content": "A String", # The text of this run. Any non-text elements in the run are replaced with the Unicode character U+E907. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TextRun may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this run, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this run. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. @@ -23693,8 +29134,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -23705,23 +29155,14 @@

Method Details

"weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, }, }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this run. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + ], + "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The style of this paragraph. + "alignment": "A String", # The text alignment for this paragraph. + "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. + "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -23730,13 +29171,18 @@

Method Details

}, }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -23745,248 +29191,17 @@

Method Details

}, }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, }, - }, - }, - ], - "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The style of this paragraph. - "alignment": "A String", # The text alignment for this paragraph. - "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. - "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. - "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. - "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. - "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. - "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. - "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. - "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. - "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - }, - "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "spacingMode": "A String", # The spacing mode for the paragraph. - "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. - { # A tab stop within a paragraph. - "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. - "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - ], - }, - "positionedObjectIds": [ # The IDs of the positioned objects tethered to this paragraph. - "A String", - ], - "suggestedBulletChanges": { # The suggested changes to this paragraph's bullet. - "a_key": { # A suggested change to a Bullet. - "bullet": { # Describes the bullet of a paragraph. # A Bullet that only includes the changes made in this suggestion. This can be used along with the bullet_suggestion_state to see which fields have changed and their new values. - "listId": "A String", # The ID of the list this paragraph belongs to. - "nestingLevel": 42, # The nesting level of this paragraph in the list. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - "bulletSuggestionState": { # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. - "listIdSuggested": True or False, # Indicates if there was a suggested change to the list_id. - "nestingLevelSuggested": True or False, # Indicates if there was a suggested change to the nesting_level. - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, - }, - }, - }, - "suggestedParagraphStyleChanges": { # The suggested paragraph style changes to this paragraph, keyed by suggestion ID. - "a_key": { # A suggested change to a ParagraphStyle. - "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A ParagraphStyle that only includes the changes made in this suggestion. This can be used along with the paragraph_style_suggestion_state to see which fields have changed and their new values. - "alignment": "A String", # The text alignment for this paragraph. - "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. - "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. @@ -24006,7 +29221,7 @@

Method Details

"unit": "A String", # The units for magnitude. }, }, - "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. @@ -24026,7 +29241,7 @@

Method Details

"unit": "A String", # The units for magnitude. }, }, - "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. @@ -24046,67 +29261,27 @@

Method Details

"unit": "A String", # The units for magnitude. }, }, - "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. - "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. - "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. - "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. - "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. - "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. - "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. - "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. + "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. + "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. + "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. + "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. + "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. + "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. + "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. + "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -24135,161 +29310,501 @@

Method Details

}, ], }, - "paragraphStyleSuggestionState": { # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. - "alignmentSuggested": True or False, # Indicates if there was a suggested change to alignment. - "avoidWidowAndOrphanSuggested": True or False, # Indicates if there was a suggested change to avoid_widow_and_orphan. - "borderBetweenSuggested": True or False, # Indicates if there was a suggested change to border_between. - "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. - "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. - "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. - "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. - "directionSuggested": True or False, # Indicates if there was a suggested change to direction. - "headingIdSuggested": True or False, # Indicates if there was a suggested change to heading_id. - "indentEndSuggested": True or False, # Indicates if there was a suggested change to indent_end. - "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line. - "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start. - "keepLinesTogetherSuggested": True or False, # Indicates if there was a suggested change to keep_lines_together. - "keepWithNextSuggested": True or False, # Indicates if there was a suggested change to keep_with_next. - "lineSpacingSuggested": True or False, # Indicates if there was a suggested change to line_spacing. - "namedStyleTypeSuggested": True or False, # Indicates if there was a suggested change to named_style_type. - "pageBreakBeforeSuggested": True or False, # Indicates if there was a suggested change to page_break_before. - "shadingSuggestionState": { # A mask that indicates which of the fields on the base Shading have been changed in this suggested change. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in shading have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to the Shading. - }, - "spaceAboveSuggested": True or False, # Indicates if there was a suggested change to space_above. - "spaceBelowSuggested": True or False, # Indicates if there was a suggested change to space_below. - "spacingModeSuggested": True or False, # Indicates if there was a suggested change to spacing_mode. - }, - }, - }, - "suggestedPositionedObjectIds": { # The IDs of the positioned objects suggested to be attached to this paragraph, keyed by suggestion ID. - "a_key": { # A collection of object IDs. - "objectIds": [ # The object IDs. - "A String", - ], - }, - }, - }, - "sectionBreak": { # A StructuralElement representing a section break. A section is a range of content that has the same SectionStyle. A section break represents the start of a new section, and the section style applies to the section after the section break. The document body always begins with a section break. # A section break type of structural element. - "sectionStyle": { # The styling that applies to a section. # The style of the section after this section break. - "columnProperties": [ # The section's columns properties. If empty, the section contains one column with the default properties in the Docs editor. A section can be updated to have no more than 3 columns. When updating this property, setting a concrete value is required. Unsetting this property will result in a 400 bad request error. - { # Properties that apply to a section's column. - "paddingEnd": { # A magnitude in a single direction in the specified units. # The padding at the end of the column. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # Output only. The width of the column. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - ], - "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only. - "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only. - "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only. - "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only. - "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only. - "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only. - "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "sectionType": "A String", # Output only. The type of section. - "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - }, - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A SectionBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - }, - "startIndex": 42, # The zero-based start index of this structural element, in UTF-16 code units. - "table": { # A StructuralElement representing a table. # A table type of structural element. - "columns": 42, # Number of columns in the table. It's possible for a table to be non-rectangular, so some rows may have a different number of cells. - "rows": 42, # Number of rows in the table. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A Table may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "tableRows": [ # The contents and style of each row. - { # The contents and style of a row in a Table. - "endIndex": 42, # The zero-based end index of this row, exclusive, in UTF-16 code units. - "startIndex": 42, # The zero-based start index of this row, in UTF-16 code units. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A TableRow may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "positionedObjectIds": [ # The IDs of the positioned objects tethered to this paragraph. "A String", ], - "suggestedTableRowStyleChanges": { # The suggested style changes to this row, keyed by suggestion ID. - "a_key": { # A suggested change to a TableRowStyle. - "tableRowStyle": { # Styles that apply to a table row. # A TableRowStyle that only includes the changes made in this suggestion. This can be used along with the table_row_style_suggestion_state to see which fields have changed and their new values. - "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "suggestedBulletChanges": { # The suggested changes to this paragraph's bullet. + "a_key": { # A suggested change to a Bullet. + "bullet": { # Describes the bullet of a paragraph. # A Bullet that only includes the changes made in this suggestion. This can be used along with the bullet_suggestion_state to see which fields have changed and their new values. + "listId": "A String", # The ID of the list this paragraph belongs to. + "nestingLevel": 42, # The nesting level of this paragraph in the list. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, }, - "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries. - "tableHeader": True or False, # Whether the row is a table header. }, - "tableRowStyleSuggestionState": { # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. - "minRowHeightSuggested": True or False, # Indicates if there was a suggested change to min_row_height. + "bulletSuggestionState": { # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. + "listIdSuggested": True or False, # Indicates if there was a suggested change to the list_id. + "nestingLevelSuggested": True or False, # Indicates if there was a suggested change to the nesting_level. + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, }, }, }, - "tableCells": [ # The contents and style of each cell in this row. It's possible for a table to be non-rectangular, so some rows may have a different number of cells than other rows in the same table. - { # The contents and style of a cell in a Table. - "content": [ # The content of the cell. - # Object with schema name: StructuralElement - ], - "endIndex": 42, # The zero-based end index of this cell, exclusive, in UTF-16 code units. - "startIndex": 42, # The zero-based start index of this cell, in UTF-16 code units. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A TableCell may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTableCellStyleChanges": { # The suggested changes to the table cell style, keyed by suggestion ID. - "a_key": { # A suggested change to a TableCellStyle. - "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # A TableCellStyle that only includes the changes made in this suggestion. This can be used along with the table_cell_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + "suggestedParagraphStyleChanges": { # The suggested paragraph style changes to this paragraph, keyed by suggestion ID. + "a_key": { # A suggested change to a ParagraphStyle. + "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A ParagraphStyle that only includes the changes made in this suggestion. This can be used along with the paragraph_style_suggestion_state to see which fields have changed and their new values. + "alignment": "A String", # The text alignment for this paragraph. + "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. + "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. + "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. + "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. + "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. + "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. + "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. + "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. + "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + }, + "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spacingMode": "A String", # The spacing mode for the paragraph. + "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. + { # A tab stop within a paragraph. + "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. + "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + ], + }, + "paragraphStyleSuggestionState": { # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. + "alignmentSuggested": True or False, # Indicates if there was a suggested change to alignment. + "avoidWidowAndOrphanSuggested": True or False, # Indicates if there was a suggested change to avoid_widow_and_orphan. + "borderBetweenSuggested": True or False, # Indicates if there was a suggested change to border_between. + "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. + "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. + "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. + "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. + "directionSuggested": True or False, # Indicates if there was a suggested change to direction. + "headingIdSuggested": True or False, # Indicates if there was a suggested change to heading_id. + "indentEndSuggested": True or False, # Indicates if there was a suggested change to indent_end. + "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line. + "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start. + "keepLinesTogetherSuggested": True or False, # Indicates if there was a suggested change to keep_lines_together. + "keepWithNextSuggested": True or False, # Indicates if there was a suggested change to keep_with_next. + "lineSpacingSuggested": True or False, # Indicates if there was a suggested change to line_spacing. + "namedStyleTypeSuggested": True or False, # Indicates if there was a suggested change to named_style_type. + "pageBreakBeforeSuggested": True or False, # Indicates if there was a suggested change to page_break_before. + "shadingSuggestionState": { # A mask that indicates which of the fields on the base Shading have been changed in this suggested change. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in shading have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to the Shading. + }, + "spaceAboveSuggested": True or False, # Indicates if there was a suggested change to space_above. + "spaceBelowSuggested": True or False, # Indicates if there was a suggested change to space_below. + "spacingModeSuggested": True or False, # Indicates if there was a suggested change to spacing_mode. + }, + }, + }, + "suggestedPositionedObjectIds": { # The IDs of the positioned objects suggested to be attached to this paragraph, keyed by suggestion ID. + "a_key": { # A collection of object IDs. + "objectIds": [ # The object IDs. + "A String", + ], + }, + }, + }, + "sectionBreak": { # A StructuralElement representing a section break. A section is a range of content that has the same SectionStyle. A section break represents the start of a new section, and the section style applies to the section after the section break. The document body always begins with a section break. # A section break type of structural element. + "sectionStyle": { # The styling that applies to a section. # The style of the section after this section break. + "columnProperties": [ # The section's columns properties. If empty, the section contains one column with the default properties in the Docs editor. A section can be updated to have no more than 3 columns. When updating this property, setting a concrete value is required. Unsetting this property will result in a 400 bad request error. + { # Properties that apply to a section's column. + "paddingEnd": { # A magnitude in a single direction in the specified units. # The padding at the end of the column. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # Output only. The width of the column. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + ], + "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only. + "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only. + "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only. + "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only. + "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only. + "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only. + "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "sectionType": "A String", # Output only. The type of section. + "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + }, + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A SectionBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + }, + "startIndex": 42, # The zero-based start index of this structural element, in UTF-16 code units. + "table": { # A StructuralElement representing a table. # A table type of structural element. + "columns": 42, # Number of columns in the table. It's possible for a table to be non-rectangular, so some rows may have a different number of cells. + "rows": 42, # Number of rows in the table. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A Table may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "tableRows": [ # The contents and style of each row. + { # The contents and style of a row in a Table. + "endIndex": 42, # The zero-based end index of this row, exclusive, in UTF-16 code units. + "startIndex": 42, # The zero-based start index of this row, in UTF-16 code units. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TableRow may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTableRowStyleChanges": { # The suggested style changes to this row, keyed by suggestion ID. + "a_key": { # A suggested change to a TableRowStyle. + "tableRowStyle": { # Styles that apply to a table row. # A TableRowStyle that only includes the changes made in this suggestion. This can be used along with the table_row_style_suggestion_state to see which fields have changed and their new values. + "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries. + "tableHeader": True or False, # Whether the row is a table header. + }, + "tableRowStyleSuggestionState": { # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. + "minRowHeightSuggested": True or False, # Indicates if there was a suggested change to min_row_height. + }, + }, + }, + "tableCells": [ # The contents and style of each cell in this row. It's possible for a table to be non-rectangular, so some rows may have a different number of cells than other rows in the same table. + { # The contents and style of a cell in a Table. + "content": [ # The content of the cell. + # Object with schema name: StructuralElement + ], + "endIndex": 42, # The zero-based end index of this cell, exclusive, in UTF-16 code units. + "startIndex": 42, # The zero-based start index of this cell, in UTF-16 code units. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TableCell may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTableCellStyleChanges": { # The suggested changes to the table cell style, keyed by suggestion ID. + "a_key": { # A suggested change to a TableCellStyle. + "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # A TableCellStyle that only includes the changes made in this suggestion. This can be used along with the table_cell_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "columnSpan": 42, # The column span of the cell. This property is read-only. + "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. + "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "rowSpan": 42, # The row span of the cell. This property is read-only. + }, + "tableCellStyleSuggestionState": { # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. + "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. + "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. + "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. + "columnSpanSuggested": True or False, # Indicates if there was a suggested change to column_span. + "contentAlignmentSuggested": True or False, # Indicates if there was a suggested change to content_alignment. + "paddingBottomSuggested": True or False, # Indicates if there was a suggested change to padding_bottom. + "paddingLeftSuggested": True or False, # Indicates if there was a suggested change to padding_left. + "paddingRightSuggested": True or False, # Indicates if there was a suggested change to padding_right. + "paddingTopSuggested": True or False, # Indicates if there was a suggested change to padding_top. + "rowSpanSuggested": True or False, # Indicates if there was a suggested change to row_span. + }, + }, + }, + "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # The style of the cell. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -24372,165 +29887,47 @@

Method Details

}, "rowSpan": 42, # The row span of the cell. This property is read-only. }, - "tableCellStyleSuggestionState": { # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. - "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. - "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. - "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. - "columnSpanSuggested": True or False, # Indicates if there was a suggested change to column_span. - "contentAlignmentSuggested": True or False, # Indicates if there was a suggested change to content_alignment. - "paddingBottomSuggested": True or False, # Indicates if there was a suggested change to padding_bottom. - "paddingLeftSuggested": True or False, # Indicates if there was a suggested change to padding_left. - "paddingRightSuggested": True or False, # Indicates if there was a suggested change to padding_right. - "paddingTopSuggested": True or False, # Indicates if there was a suggested change to padding_top. - "rowSpanSuggested": True or False, # Indicates if there was a suggested change to row_span. - }, - }, - }, - "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # The style of the cell. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, }, - "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, + ], + "tableRowStyle": { # Styles that apply to a table row. # The style of the table row. + "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, + "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries. + "tableHeader": True or False, # Whether the row is a table header. + }, + }, + ], + "tableStyle": { # Styles that apply to a table. # The style of the table. + "tableColumnProperties": [ # The properties of each column. Note that in Docs, tables contain rows and rows contain cells, similar to HTML. So the properties for a row can be found on the row's table_row_style. + { # The properties of a column in a table. + "width": { # A magnitude in a single direction in the specified units. # The width of the column. Set when the column's `width_type` is FIXED_WIDTH. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "columnSpan": 42, # The column span of the cell. This property is read-only. - "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. - "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "rowSpan": 42, # The row span of the cell. This property is read-only. + "widthType": "A String", # The width type of the column. }, - }, - ], - "tableRowStyle": { # Styles that apply to a table row. # The style of the table row. - "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries. - "tableHeader": True or False, # Whether the row is a table header. + ], }, }, - ], - "tableStyle": { # Styles that apply to a table. # The style of the table. - "tableColumnProperties": [ # The properties of each column. Note that in Docs, tables contain rows and rows contain cells, similar to HTML. So the properties for a row can be found on the row's table_row_style. - { # The properties of a column in a table. - "width": { # A magnitude in a single direction in the specified units. # The width of the column. Set when the column's `width_type` is FIXED_WIDTH. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "widthType": "A String", # The width type of the column. - }, - ], + "tableOfContents": { # A StructuralElement representing a table of contents. # A table of contents type of structural element. + "content": [ # The content of the table of contents. + # Object with schema name: StructuralElement + ], + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TableOfContents may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + }, }, - }, - "tableOfContents": { # A StructuralElement representing a table of contents. # A table of contents type of structural element. - "content": [ # The content of the table of contents. - # Object with schema name: StructuralElement - ], - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A TableOfContents may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - }, + ], }, - ], - "headerId": "A String", # The ID of the header. - }, - }, - "inlineObjects": { # Output only. The inline objects in the document, keyed by object ID. - "a_key": { # An object that appears inline with text. An InlineObject contains an EmbeddedObject such as an image. - "inlineObjectProperties": { # Properties of an InlineObject. # The properties of this inline object. - "embeddedObject": { # An embedded object in the document. # The embedded object of this inline object. - "description": "A String", # The description of the embedded object. The `title` and `description` are both combined to display alt text. - "embeddedDrawingProperties": { # The properties of an embedded drawing and used to differentiate the object type. An embedded drawing is one that's created and edited within a document. Note that extensive details are not supported. # The properties of an embedded drawing. - }, - "embeddedObjectBorder": { # A border around an EmbeddedObject. # The border of the embedded object. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "documentStyle": { # The style of the document. # The style of the document tab. + "background": { # Represents the background of a document. # The background of the document. Documents cannot have a transparent background color. + "color": { # A color that can either be fully opaque or fully transparent. # The background color. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -24539,51 +29936,40 @@

Method Details

}, }, }, - "dashStyle": "A String", # The dash style of the border. - "propertyState": "A String", # The property state of the border property. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, }, - "imageProperties": { # The properties of an image. # The properties of an image. - "angle": 3.14, # The clockwise rotation angle of the image, in radians. - "brightness": 3.14, # The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. - "contentUri": "A String", # A URI to the image with a default lifetime of 30 minutes. This URI is tagged with the account of the requester. Anyone with the URI effectively accesses the image as the original requester. Access to the image may be lost if the document's sharing settings change. - "contrast": 3.14, # The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. - "cropProperties": { # The crop properties of an image. The crop rectangle is represented using fractional offsets from the original content's 4 edges. - If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the image's original bounding rectangle. - If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the image's original bounding rectangle. - If all offsets and rotation angle are 0, the image is not cropped. # The crop properties of the image. - "angle": 3.14, # The clockwise rotation angle of the crop rectangle around its center, in radians. Rotation is applied after the offsets. - "offsetBottom": 3.14, # The offset specifies how far inwards the bottom edge of the crop rectangle is from the bottom edge of the original content as a fraction of the original content's height. - "offsetLeft": 3.14, # The offset specifies how far inwards the left edge of the crop rectangle is from the left edge of the original content as a fraction of the original content's width. - "offsetRight": 3.14, # The offset specifies how far inwards the right edge of the crop rectangle is from the right edge of the original content as a fraction of the original content's width. - "offsetTop": 3.14, # The offset specifies how far inwards the top edge of the crop rectangle is from the top edge of the original content as a fraction of the original content's height. - }, - "sourceUri": "A String", # The source URI is the URI used to insert the image. The source URI can be empty. - "transparency": 3.14, # The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means transparent. + "defaultFooterId": "A String", # The ID of the default footer. If not set, there's no default footer. This property is read-only. + "defaultHeaderId": "A String", # The ID of the default header. If not set, there's no default header. This property is read-only. + "evenPageFooterId": "A String", # The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. This property is read-only. + "evenPageHeaderId": "A String", # The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. This property is read-only. + "firstPageFooterId": "A String", # The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. This property is read-only. + "firstPageHeaderId": "A String", # The ID of the header used only for the first page. If not set then a unique header for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_header_id or this value for the header on the first page. If not set, there's no first page header. This property is read-only. + "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of the page_size, which allows changing the page orientation between portrait and landscape. + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin. Updating the bottom page margin on the document style clears the bottom page margin on all section styles. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - "linkedContentReference": { # A reference to the external linked source content. # A reference to the external linked source content. For example, it contains a reference to the source Google Sheets chart when the embedded object is a linked chart. If unset, then the embedded object is not linked. - "sheetsChartReference": { # A reference to a linked chart embedded from Google Sheets. # A reference to the linked chart. - "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that's embedded. - "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart. - }, + "marginFooter": { # A magnitude in a single direction in the specified units. # The amount of space between the bottom of the page and the contents of the footer. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom margin of the embedded object. + "marginHeader": { # A magnitude in a single direction in the specified units. # The amount of space between the top of the page and the contents of the header. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginLeft": { # A magnitude in a single direction in the specified units. # The left margin of the embedded object. + "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin. Updating the left page margin on the document style clears the left page margin on all section styles. It may also cause columns to resize in all sections. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginRight": { # A magnitude in a single direction in the specified units. # The right margin of the embedded object. + "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin. Updating the right page margin on the document style clears the right page margin on all section styles. It may also cause columns to resize in all sections. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginTop": { # A magnitude in a single direction in the specified units. # The top margin of the embedded object. + "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin. Updating the top page margin on the document style clears the top page margin on all section styles. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "size": { # A width and height. # The visible size of the image after cropping. + "pageNumberStart": 42, # The page number from which to start counting the number of pages. + "pageSize": { # A width and height. # The size of a page in the document. "height": { # A magnitude in a single direction in the specified units. # The height of the object. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. @@ -24593,604 +29979,24458 @@

Method Details

"unit": "A String", # The units for magnitude. }, }, - "title": "A String", # The title of the embedded object. The `title` and `description` are both combined to display alt text. + "useCustomHeaderFooterMargins": True or False, # Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected. When false, the default values in the Docs editor for header and footer margin are used. This property is read-only. + "useEvenPageHeaderFooter": True or False, # Indicates whether to use the even page header / footer IDs for the even pages. + "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page. }, - }, - "objectId": "A String", # The ID of this inline object. Can be used to update an object’s properties. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInlineObjectPropertiesChanges": { # The suggested changes to the inline object properties, keyed by suggestion ID. - "a_key": { # A suggested change to InlineObjectProperties. - "inlineObjectProperties": { # Properties of an InlineObject. # An InlineObjectProperties that only includes the changes made in this suggestion. This can be used along with the inline_object_properties_suggestion_state to see which fields have changed and their new values. - "embeddedObject": { # An embedded object in the document. # The embedded object of this inline object. - "description": "A String", # The description of the embedded object. The `title` and `description` are both combined to display alt text. - "embeddedDrawingProperties": { # The properties of an embedded drawing and used to differentiate the object type. An embedded drawing is one that's created and edited within a document. Note that extensive details are not supported. # The properties of an embedded drawing. - }, - "embeddedObjectBorder": { # A border around an EmbeddedObject. # The border of the embedded object. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "footers": { # The footers in the document tab, keyed by footer ID. + "a_key": { # A document footer. + "content": [ # The contents of the footer. The indexes for a footer's content begin at zero. + { # A StructuralElement describes content that provides structure to the document. + "endIndex": 42, # The zero-based end index of this structural element, exclusive, in UTF-16 code units. + "paragraph": { # A StructuralElement representing a paragraph. A paragraph is a range of content that's terminated with a newline character. # A paragraph type of structural element. + "bullet": { # Describes the bullet of a paragraph. # The bullet for this paragraph. If not present, the paragraph does not belong to a list. + "listId": "A String", # The ID of the list this paragraph belongs to. + "nestingLevel": 42, # The nesting level of this paragraph in the list. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, }, }, - }, - "dashStyle": "A String", # The dash style of the border. - "propertyState": "A String", # The property state of the border property. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "imageProperties": { # The properties of an image. # The properties of an image. - "angle": 3.14, # The clockwise rotation angle of the image, in radians. - "brightness": 3.14, # The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. - "contentUri": "A String", # A URI to the image with a default lifetime of 30 minutes. This URI is tagged with the account of the requester. Anyone with the URI effectively accesses the image as the original requester. Access to the image may be lost if the document's sharing settings change. - "contrast": 3.14, # The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. - "cropProperties": { # The crop properties of an image. The crop rectangle is represented using fractional offsets from the original content's 4 edges. - If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the image's original bounding rectangle. - If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the image's original bounding rectangle. - If all offsets and rotation angle are 0, the image is not cropped. # The crop properties of the image. - "angle": 3.14, # The clockwise rotation angle of the crop rectangle around its center, in radians. Rotation is applied after the offsets. - "offsetBottom": 3.14, # The offset specifies how far inwards the bottom edge of the crop rectangle is from the bottom edge of the original content as a fraction of the original content's height. - "offsetLeft": 3.14, # The offset specifies how far inwards the left edge of the crop rectangle is from the left edge of the original content as a fraction of the original content's width. - "offsetRight": 3.14, # The offset specifies how far inwards the right edge of the crop rectangle is from the right edge of the original content as a fraction of the original content's width. - "offsetTop": 3.14, # The offset specifies how far inwards the top edge of the crop rectangle is from the top edge of the original content as a fraction of the original content's height. - }, - "sourceUri": "A String", # The source URI is the URI used to insert the image. The source URI can be empty. - "transparency": 3.14, # The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means transparent. - }, - "linkedContentReference": { # A reference to the external linked source content. # A reference to the external linked source content. For example, it contains a reference to the source Google Sheets chart when the embedded object is a linked chart. If unset, then the embedded object is not linked. - "sheetsChartReference": { # A reference to a linked chart embedded from Google Sheets. # A reference to the linked chart. - "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that's embedded. - "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart. - }, - }, - "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom margin of the embedded object. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginLeft": { # A magnitude in a single direction in the specified units. # The left margin of the embedded object. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginRight": { # A magnitude in a single direction in the specified units. # The right margin of the embedded object. + "elements": [ # The content of the paragraph, broken down into its component parts. + { # A ParagraphElement describes content within a Paragraph. + "autoText": { # A ParagraphElement representing a spot in the text that's dynamically replaced with content that can change over time, like a page number. # An auto text paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. An AutoText may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this AutoText, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this AutoText. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "type": "A String", # The type of this auto text. + }, + "columnBreak": { # A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column. # A column break paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this ColumnBreak, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "endIndex": 42, # The zero-base end index of this paragraph element, exclusive, in UTF-16 code units. + "equation": { # A ParagraphElement representing an equation. # An equation paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. An Equation may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + }, + "footnoteReference": { # A ParagraphElement representing a footnote reference. A footnote reference is the inline content rendered with a number and is used to identify the footnote. # A footnote reference paragraph element. + "footnoteId": "A String", # The ID of the footnote that contains the content of this footnote reference. + "footnoteNumber": "A String", # The rendered number of this footnote. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this FootnoteReference, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this FootnoteReference. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "horizontalRule": { # A ParagraphElement representing a horizontal line. # A horizontal rule paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A HorizontalRule may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this HorizontalRule, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this HorizontalRule. Similar to text content, like text runs and footnote references, the text style of a horizontal rule can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "inlineObjectElement": { # A ParagraphElement that contains an InlineObject. # An inline object paragraph element. + "inlineObjectId": "A String", # The ID of the InlineObject this element contains. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. An InlineObjectElement may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this InlineObject, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this InlineObjectElement. Similar to text content, like text runs and footnote references, the text style of an inline object element can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "pageBreak": { # A ParagraphElement representing a page break. A page break makes the subsequent text start at the top of the next page. # A page break paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A PageBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this PageBreak, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this PageBreak. Similar to text content, like text runs and footnote references, the text style of a page break can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address. + "personId": "A String", # Output only. The unique ID of this link. + "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present. + "email": "A String", # Output only. The email address linked to this Person. This field is always present. + "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address. + }, + "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. + "A String", + ], + "suggestedInsertionIds": [ # IDs for suggestions that insert this person link into the document. A Person might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this Person, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this Person. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "richLink": { # A link to a Google resource (such as a file in Drive, a YouTube video, or a Calendar event). # A paragraph element that links to a Google resource (such as a file in Google Drive, a YouTube video, or a Calendar event.) + "richLinkId": "A String", # Output only. The ID of this link. + "richLinkProperties": { # Properties specific to a RichLink. # Output only. The properties of this RichLink. This field is always present. + "mimeType": "A String", # Output only. The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the RichLink, if there's one (for example, when it's a file in Drive). + "title": "A String", # Output only. The title of the RichLink as displayed in the link. This title matches the title of the linked resource at the time of the insertion or last update of the link. This field is always present. + "uri": "A String", # Output only. The URI to the RichLink. This is always present. + }, + "suggestedDeletionIds": [ # IDs for suggestions that remove this link from the document. A RichLink might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. + "A String", + ], + "suggestedInsertionIds": [ # IDs for suggestions that insert this link into the document. A RichLink might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this RichLink, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this RichLink. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "startIndex": 42, # The zero-based start index of this paragraph element, in UTF-16 code units. + "textRun": { # A ParagraphElement that represents a run of text that all has the same styling. # A text run paragraph element. + "content": "A String", # The text of this run. Any non-text elements in the run are replaced with the Unicode character U+E907. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TextRun may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this run, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this run. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + }, + ], + "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The style of this paragraph. + "alignment": "A String", # The text alignment for this paragraph. + "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. + "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. + "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. + "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. + "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. + "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. + "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. + "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. + "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + }, + "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spacingMode": "A String", # The spacing mode for the paragraph. + "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. + { # A tab stop within a paragraph. + "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. + "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + ], + }, + "positionedObjectIds": [ # The IDs of the positioned objects tethered to this paragraph. + "A String", + ], + "suggestedBulletChanges": { # The suggested changes to this paragraph's bullet. + "a_key": { # A suggested change to a Bullet. + "bullet": { # Describes the bullet of a paragraph. # A Bullet that only includes the changes made in this suggestion. This can be used along with the bullet_suggestion_state to see which fields have changed and their new values. + "listId": "A String", # The ID of the list this paragraph belongs to. + "nestingLevel": 42, # The nesting level of this paragraph in the list. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "bulletSuggestionState": { # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. + "listIdSuggested": True or False, # Indicates if there was a suggested change to the list_id. + "nestingLevelSuggested": True or False, # Indicates if there was a suggested change to the nesting_level. + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + }, + "suggestedParagraphStyleChanges": { # The suggested paragraph style changes to this paragraph, keyed by suggestion ID. + "a_key": { # A suggested change to a ParagraphStyle. + "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A ParagraphStyle that only includes the changes made in this suggestion. This can be used along with the paragraph_style_suggestion_state to see which fields have changed and their new values. + "alignment": "A String", # The text alignment for this paragraph. + "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. + "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. + "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. + "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. + "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. + "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. + "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. + "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. + "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + }, + "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spacingMode": "A String", # The spacing mode for the paragraph. + "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. + { # A tab stop within a paragraph. + "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. + "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + ], + }, + "paragraphStyleSuggestionState": { # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. + "alignmentSuggested": True or False, # Indicates if there was a suggested change to alignment. + "avoidWidowAndOrphanSuggested": True or False, # Indicates if there was a suggested change to avoid_widow_and_orphan. + "borderBetweenSuggested": True or False, # Indicates if there was a suggested change to border_between. + "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. + "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. + "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. + "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. + "directionSuggested": True or False, # Indicates if there was a suggested change to direction. + "headingIdSuggested": True or False, # Indicates if there was a suggested change to heading_id. + "indentEndSuggested": True or False, # Indicates if there was a suggested change to indent_end. + "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line. + "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start. + "keepLinesTogetherSuggested": True or False, # Indicates if there was a suggested change to keep_lines_together. + "keepWithNextSuggested": True or False, # Indicates if there was a suggested change to keep_with_next. + "lineSpacingSuggested": True or False, # Indicates if there was a suggested change to line_spacing. + "namedStyleTypeSuggested": True or False, # Indicates if there was a suggested change to named_style_type. + "pageBreakBeforeSuggested": True or False, # Indicates if there was a suggested change to page_break_before. + "shadingSuggestionState": { # A mask that indicates which of the fields on the base Shading have been changed in this suggested change. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in shading have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to the Shading. + }, + "spaceAboveSuggested": True or False, # Indicates if there was a suggested change to space_above. + "spaceBelowSuggested": True or False, # Indicates if there was a suggested change to space_below. + "spacingModeSuggested": True or False, # Indicates if there was a suggested change to spacing_mode. + }, + }, + }, + "suggestedPositionedObjectIds": { # The IDs of the positioned objects suggested to be attached to this paragraph, keyed by suggestion ID. + "a_key": { # A collection of object IDs. + "objectIds": [ # The object IDs. + "A String", + ], + }, + }, + }, + "sectionBreak": { # A StructuralElement representing a section break. A section is a range of content that has the same SectionStyle. A section break represents the start of a new section, and the section style applies to the section after the section break. The document body always begins with a section break. # A section break type of structural element. + "sectionStyle": { # The styling that applies to a section. # The style of the section after this section break. + "columnProperties": [ # The section's columns properties. If empty, the section contains one column with the default properties in the Docs editor. A section can be updated to have no more than 3 columns. When updating this property, setting a concrete value is required. Unsetting this property will result in a 400 bad request error. + { # Properties that apply to a section's column. + "paddingEnd": { # A magnitude in a single direction in the specified units. # The padding at the end of the column. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # Output only. The width of the column. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + ], + "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only. + "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only. + "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only. + "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only. + "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only. + "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only. + "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "sectionType": "A String", # Output only. The type of section. + "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + }, + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A SectionBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + }, + "startIndex": 42, # The zero-based start index of this structural element, in UTF-16 code units. + "table": { # A StructuralElement representing a table. # A table type of structural element. + "columns": 42, # Number of columns in the table. It's possible for a table to be non-rectangular, so some rows may have a different number of cells. + "rows": 42, # Number of rows in the table. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A Table may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "tableRows": [ # The contents and style of each row. + { # The contents and style of a row in a Table. + "endIndex": 42, # The zero-based end index of this row, exclusive, in UTF-16 code units. + "startIndex": 42, # The zero-based start index of this row, in UTF-16 code units. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TableRow may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTableRowStyleChanges": { # The suggested style changes to this row, keyed by suggestion ID. + "a_key": { # A suggested change to a TableRowStyle. + "tableRowStyle": { # Styles that apply to a table row. # A TableRowStyle that only includes the changes made in this suggestion. This can be used along with the table_row_style_suggestion_state to see which fields have changed and their new values. + "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries. + "tableHeader": True or False, # Whether the row is a table header. + }, + "tableRowStyleSuggestionState": { # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. + "minRowHeightSuggested": True or False, # Indicates if there was a suggested change to min_row_height. + }, + }, + }, + "tableCells": [ # The contents and style of each cell in this row. It's possible for a table to be non-rectangular, so some rows may have a different number of cells than other rows in the same table. + { # The contents and style of a cell in a Table. + "content": [ # The content of the cell. + # Object with schema name: StructuralElement + ], + "endIndex": 42, # The zero-based end index of this cell, exclusive, in UTF-16 code units. + "startIndex": 42, # The zero-based start index of this cell, in UTF-16 code units. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TableCell may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTableCellStyleChanges": { # The suggested changes to the table cell style, keyed by suggestion ID. + "a_key": { # A suggested change to a TableCellStyle. + "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # A TableCellStyle that only includes the changes made in this suggestion. This can be used along with the table_cell_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "columnSpan": 42, # The column span of the cell. This property is read-only. + "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. + "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "rowSpan": 42, # The row span of the cell. This property is read-only. + }, + "tableCellStyleSuggestionState": { # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. + "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. + "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. + "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. + "columnSpanSuggested": True or False, # Indicates if there was a suggested change to column_span. + "contentAlignmentSuggested": True or False, # Indicates if there was a suggested change to content_alignment. + "paddingBottomSuggested": True or False, # Indicates if there was a suggested change to padding_bottom. + "paddingLeftSuggested": True or False, # Indicates if there was a suggested change to padding_left. + "paddingRightSuggested": True or False, # Indicates if there was a suggested change to padding_right. + "paddingTopSuggested": True or False, # Indicates if there was a suggested change to padding_top. + "rowSpanSuggested": True or False, # Indicates if there was a suggested change to row_span. + }, + }, + }, + "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # The style of the cell. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "columnSpan": 42, # The column span of the cell. This property is read-only. + "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. + "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "rowSpan": 42, # The row span of the cell. This property is read-only. + }, + }, + ], + "tableRowStyle": { # Styles that apply to a table row. # The style of the table row. + "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries. + "tableHeader": True or False, # Whether the row is a table header. + }, + }, + ], + "tableStyle": { # Styles that apply to a table. # The style of the table. + "tableColumnProperties": [ # The properties of each column. Note that in Docs, tables contain rows and rows contain cells, similar to HTML. So the properties for a row can be found on the row's table_row_style. + { # The properties of a column in a table. + "width": { # A magnitude in a single direction in the specified units. # The width of the column. Set when the column's `width_type` is FIXED_WIDTH. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "widthType": "A String", # The width type of the column. + }, + ], + }, + }, + "tableOfContents": { # A StructuralElement representing a table of contents. # A table of contents type of structural element. + "content": [ # The content of the table of contents. + # Object with schema name: StructuralElement + ], + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TableOfContents may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + }, + }, + ], + "footerId": "A String", # The ID of the footer. + }, + }, + "footnotes": { # The footnotes in the document tab, keyed by footnote ID. + "a_key": { # A document footnote. + "content": [ # The contents of the footnote. The indexes for a footnote's content begin at zero. + { # A StructuralElement describes content that provides structure to the document. + "endIndex": 42, # The zero-based end index of this structural element, exclusive, in UTF-16 code units. + "paragraph": { # A StructuralElement representing a paragraph. A paragraph is a range of content that's terminated with a newline character. # A paragraph type of structural element. + "bullet": { # Describes the bullet of a paragraph. # The bullet for this paragraph. If not present, the paragraph does not belong to a list. + "listId": "A String", # The ID of the list this paragraph belongs to. + "nestingLevel": 42, # The nesting level of this paragraph in the list. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "elements": [ # The content of the paragraph, broken down into its component parts. + { # A ParagraphElement describes content within a Paragraph. + "autoText": { # A ParagraphElement representing a spot in the text that's dynamically replaced with content that can change over time, like a page number. # An auto text paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. An AutoText may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this AutoText, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this AutoText. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "type": "A String", # The type of this auto text. + }, + "columnBreak": { # A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column. # A column break paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this ColumnBreak, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "endIndex": 42, # The zero-base end index of this paragraph element, exclusive, in UTF-16 code units. + "equation": { # A ParagraphElement representing an equation. # An equation paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. An Equation may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + }, + "footnoteReference": { # A ParagraphElement representing a footnote reference. A footnote reference is the inline content rendered with a number and is used to identify the footnote. # A footnote reference paragraph element. + "footnoteId": "A String", # The ID of the footnote that contains the content of this footnote reference. + "footnoteNumber": "A String", # The rendered number of this footnote. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this FootnoteReference, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this FootnoteReference. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "horizontalRule": { # A ParagraphElement representing a horizontal line. # A horizontal rule paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A HorizontalRule may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this HorizontalRule, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this HorizontalRule. Similar to text content, like text runs and footnote references, the text style of a horizontal rule can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "inlineObjectElement": { # A ParagraphElement that contains an InlineObject. # An inline object paragraph element. + "inlineObjectId": "A String", # The ID of the InlineObject this element contains. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. An InlineObjectElement may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this InlineObject, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this InlineObjectElement. Similar to text content, like text runs and footnote references, the text style of an inline object element can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "pageBreak": { # A ParagraphElement representing a page break. A page break makes the subsequent text start at the top of the next page. # A page break paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A PageBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this PageBreak, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this PageBreak. Similar to text content, like text runs and footnote references, the text style of a page break can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address. + "personId": "A String", # Output only. The unique ID of this link. + "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present. + "email": "A String", # Output only. The email address linked to this Person. This field is always present. + "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address. + }, + "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. + "A String", + ], + "suggestedInsertionIds": [ # IDs for suggestions that insert this person link into the document. A Person might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this Person, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this Person. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "richLink": { # A link to a Google resource (such as a file in Drive, a YouTube video, or a Calendar event). # A paragraph element that links to a Google resource (such as a file in Google Drive, a YouTube video, or a Calendar event.) + "richLinkId": "A String", # Output only. The ID of this link. + "richLinkProperties": { # Properties specific to a RichLink. # Output only. The properties of this RichLink. This field is always present. + "mimeType": "A String", # Output only. The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the RichLink, if there's one (for example, when it's a file in Drive). + "title": "A String", # Output only. The title of the RichLink as displayed in the link. This title matches the title of the linked resource at the time of the insertion or last update of the link. This field is always present. + "uri": "A String", # Output only. The URI to the RichLink. This is always present. + }, + "suggestedDeletionIds": [ # IDs for suggestions that remove this link from the document. A RichLink might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. + "A String", + ], + "suggestedInsertionIds": [ # IDs for suggestions that insert this link into the document. A RichLink might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this RichLink, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this RichLink. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "startIndex": 42, # The zero-based start index of this paragraph element, in UTF-16 code units. + "textRun": { # A ParagraphElement that represents a run of text that all has the same styling. # A text run paragraph element. + "content": "A String", # The text of this run. Any non-text elements in the run are replaced with the Unicode character U+E907. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TextRun may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this run, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this run. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + }, + ], + "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The style of this paragraph. + "alignment": "A String", # The text alignment for this paragraph. + "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. + "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. + "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. + "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. + "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. + "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. + "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. + "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. + "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + }, + "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spacingMode": "A String", # The spacing mode for the paragraph. + "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. + { # A tab stop within a paragraph. + "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. + "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + ], + }, + "positionedObjectIds": [ # The IDs of the positioned objects tethered to this paragraph. + "A String", + ], + "suggestedBulletChanges": { # The suggested changes to this paragraph's bullet. + "a_key": { # A suggested change to a Bullet. + "bullet": { # Describes the bullet of a paragraph. # A Bullet that only includes the changes made in this suggestion. This can be used along with the bullet_suggestion_state to see which fields have changed and their new values. + "listId": "A String", # The ID of the list this paragraph belongs to. + "nestingLevel": 42, # The nesting level of this paragraph in the list. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "bulletSuggestionState": { # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. + "listIdSuggested": True or False, # Indicates if there was a suggested change to the list_id. + "nestingLevelSuggested": True or False, # Indicates if there was a suggested change to the nesting_level. + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + }, + "suggestedParagraphStyleChanges": { # The suggested paragraph style changes to this paragraph, keyed by suggestion ID. + "a_key": { # A suggested change to a ParagraphStyle. + "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A ParagraphStyle that only includes the changes made in this suggestion. This can be used along with the paragraph_style_suggestion_state to see which fields have changed and their new values. + "alignment": "A String", # The text alignment for this paragraph. + "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. + "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. + "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. + "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. + "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. + "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. + "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. + "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. + "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + }, + "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spacingMode": "A String", # The spacing mode for the paragraph. + "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. + { # A tab stop within a paragraph. + "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. + "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + ], + }, + "paragraphStyleSuggestionState": { # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. + "alignmentSuggested": True or False, # Indicates if there was a suggested change to alignment. + "avoidWidowAndOrphanSuggested": True or False, # Indicates if there was a suggested change to avoid_widow_and_orphan. + "borderBetweenSuggested": True or False, # Indicates if there was a suggested change to border_between. + "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. + "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. + "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. + "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. + "directionSuggested": True or False, # Indicates if there was a suggested change to direction. + "headingIdSuggested": True or False, # Indicates if there was a suggested change to heading_id. + "indentEndSuggested": True or False, # Indicates if there was a suggested change to indent_end. + "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line. + "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start. + "keepLinesTogetherSuggested": True or False, # Indicates if there was a suggested change to keep_lines_together. + "keepWithNextSuggested": True or False, # Indicates if there was a suggested change to keep_with_next. + "lineSpacingSuggested": True or False, # Indicates if there was a suggested change to line_spacing. + "namedStyleTypeSuggested": True or False, # Indicates if there was a suggested change to named_style_type. + "pageBreakBeforeSuggested": True or False, # Indicates if there was a suggested change to page_break_before. + "shadingSuggestionState": { # A mask that indicates which of the fields on the base Shading have been changed in this suggested change. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in shading have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to the Shading. + }, + "spaceAboveSuggested": True or False, # Indicates if there was a suggested change to space_above. + "spaceBelowSuggested": True or False, # Indicates if there was a suggested change to space_below. + "spacingModeSuggested": True or False, # Indicates if there was a suggested change to spacing_mode. + }, + }, + }, + "suggestedPositionedObjectIds": { # The IDs of the positioned objects suggested to be attached to this paragraph, keyed by suggestion ID. + "a_key": { # A collection of object IDs. + "objectIds": [ # The object IDs. + "A String", + ], + }, + }, + }, + "sectionBreak": { # A StructuralElement representing a section break. A section is a range of content that has the same SectionStyle. A section break represents the start of a new section, and the section style applies to the section after the section break. The document body always begins with a section break. # A section break type of structural element. + "sectionStyle": { # The styling that applies to a section. # The style of the section after this section break. + "columnProperties": [ # The section's columns properties. If empty, the section contains one column with the default properties in the Docs editor. A section can be updated to have no more than 3 columns. When updating this property, setting a concrete value is required. Unsetting this property will result in a 400 bad request error. + { # Properties that apply to a section's column. + "paddingEnd": { # A magnitude in a single direction in the specified units. # The padding at the end of the column. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # Output only. The width of the column. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + ], + "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only. + "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only. + "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only. + "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only. + "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only. + "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only. + "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "sectionType": "A String", # Output only. The type of section. + "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + }, + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A SectionBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + }, + "startIndex": 42, # The zero-based start index of this structural element, in UTF-16 code units. + "table": { # A StructuralElement representing a table. # A table type of structural element. + "columns": 42, # Number of columns in the table. It's possible for a table to be non-rectangular, so some rows may have a different number of cells. + "rows": 42, # Number of rows in the table. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A Table may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "tableRows": [ # The contents and style of each row. + { # The contents and style of a row in a Table. + "endIndex": 42, # The zero-based end index of this row, exclusive, in UTF-16 code units. + "startIndex": 42, # The zero-based start index of this row, in UTF-16 code units. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TableRow may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTableRowStyleChanges": { # The suggested style changes to this row, keyed by suggestion ID. + "a_key": { # A suggested change to a TableRowStyle. + "tableRowStyle": { # Styles that apply to a table row. # A TableRowStyle that only includes the changes made in this suggestion. This can be used along with the table_row_style_suggestion_state to see which fields have changed and their new values. + "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries. + "tableHeader": True or False, # Whether the row is a table header. + }, + "tableRowStyleSuggestionState": { # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. + "minRowHeightSuggested": True or False, # Indicates if there was a suggested change to min_row_height. + }, + }, + }, + "tableCells": [ # The contents and style of each cell in this row. It's possible for a table to be non-rectangular, so some rows may have a different number of cells than other rows in the same table. + { # The contents and style of a cell in a Table. + "content": [ # The content of the cell. + # Object with schema name: StructuralElement + ], + "endIndex": 42, # The zero-based end index of this cell, exclusive, in UTF-16 code units. + "startIndex": 42, # The zero-based start index of this cell, in UTF-16 code units. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TableCell may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTableCellStyleChanges": { # The suggested changes to the table cell style, keyed by suggestion ID. + "a_key": { # A suggested change to a TableCellStyle. + "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # A TableCellStyle that only includes the changes made in this suggestion. This can be used along with the table_cell_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "columnSpan": 42, # The column span of the cell. This property is read-only. + "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. + "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "rowSpan": 42, # The row span of the cell. This property is read-only. + }, + "tableCellStyleSuggestionState": { # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. + "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. + "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. + "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. + "columnSpanSuggested": True or False, # Indicates if there was a suggested change to column_span. + "contentAlignmentSuggested": True or False, # Indicates if there was a suggested change to content_alignment. + "paddingBottomSuggested": True or False, # Indicates if there was a suggested change to padding_bottom. + "paddingLeftSuggested": True or False, # Indicates if there was a suggested change to padding_left. + "paddingRightSuggested": True or False, # Indicates if there was a suggested change to padding_right. + "paddingTopSuggested": True or False, # Indicates if there was a suggested change to padding_top. + "rowSpanSuggested": True or False, # Indicates if there was a suggested change to row_span. + }, + }, + }, + "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # The style of the cell. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "columnSpan": 42, # The column span of the cell. This property is read-only. + "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. + "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "rowSpan": 42, # The row span of the cell. This property is read-only. + }, + }, + ], + "tableRowStyle": { # Styles that apply to a table row. # The style of the table row. + "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries. + "tableHeader": True or False, # Whether the row is a table header. + }, + }, + ], + "tableStyle": { # Styles that apply to a table. # The style of the table. + "tableColumnProperties": [ # The properties of each column. Note that in Docs, tables contain rows and rows contain cells, similar to HTML. So the properties for a row can be found on the row's table_row_style. + { # The properties of a column in a table. + "width": { # A magnitude in a single direction in the specified units. # The width of the column. Set when the column's `width_type` is FIXED_WIDTH. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "widthType": "A String", # The width type of the column. + }, + ], + }, + }, + "tableOfContents": { # A StructuralElement representing a table of contents. # A table of contents type of structural element. + "content": [ # The content of the table of contents. + # Object with schema name: StructuralElement + ], + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TableOfContents may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + }, + }, + ], + "footnoteId": "A String", # The ID of the footnote. + }, + }, + "headers": { # The headers in the document tab, keyed by header ID. + "a_key": { # A document header. + "content": [ # The contents of the header. The indexes for a header's content begin at zero. + { # A StructuralElement describes content that provides structure to the document. + "endIndex": 42, # The zero-based end index of this structural element, exclusive, in UTF-16 code units. + "paragraph": { # A StructuralElement representing a paragraph. A paragraph is a range of content that's terminated with a newline character. # A paragraph type of structural element. + "bullet": { # Describes the bullet of a paragraph. # The bullet for this paragraph. If not present, the paragraph does not belong to a list. + "listId": "A String", # The ID of the list this paragraph belongs to. + "nestingLevel": 42, # The nesting level of this paragraph in the list. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "elements": [ # The content of the paragraph, broken down into its component parts. + { # A ParagraphElement describes content within a Paragraph. + "autoText": { # A ParagraphElement representing a spot in the text that's dynamically replaced with content that can change over time, like a page number. # An auto text paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. An AutoText may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this AutoText, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this AutoText. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "type": "A String", # The type of this auto text. + }, + "columnBreak": { # A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column. # A column break paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this ColumnBreak, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "endIndex": 42, # The zero-base end index of this paragraph element, exclusive, in UTF-16 code units. + "equation": { # A ParagraphElement representing an equation. # An equation paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. An Equation may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + }, + "footnoteReference": { # A ParagraphElement representing a footnote reference. A footnote reference is the inline content rendered with a number and is used to identify the footnote. # A footnote reference paragraph element. + "footnoteId": "A String", # The ID of the footnote that contains the content of this footnote reference. + "footnoteNumber": "A String", # The rendered number of this footnote. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this FootnoteReference, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this FootnoteReference. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "horizontalRule": { # A ParagraphElement representing a horizontal line. # A horizontal rule paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A HorizontalRule may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this HorizontalRule, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this HorizontalRule. Similar to text content, like text runs and footnote references, the text style of a horizontal rule can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "inlineObjectElement": { # A ParagraphElement that contains an InlineObject. # An inline object paragraph element. + "inlineObjectId": "A String", # The ID of the InlineObject this element contains. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. An InlineObjectElement may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this InlineObject, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this InlineObjectElement. Similar to text content, like text runs and footnote references, the text style of an inline object element can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "pageBreak": { # A ParagraphElement representing a page break. A page break makes the subsequent text start at the top of the next page. # A page break paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A PageBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this PageBreak, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this PageBreak. Similar to text content, like text runs and footnote references, the text style of a page break can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address. + "personId": "A String", # Output only. The unique ID of this link. + "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present. + "email": "A String", # Output only. The email address linked to this Person. This field is always present. + "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address. + }, + "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. + "A String", + ], + "suggestedInsertionIds": [ # IDs for suggestions that insert this person link into the document. A Person might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this Person, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this Person. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "richLink": { # A link to a Google resource (such as a file in Drive, a YouTube video, or a Calendar event). # A paragraph element that links to a Google resource (such as a file in Google Drive, a YouTube video, or a Calendar event.) + "richLinkId": "A String", # Output only. The ID of this link. + "richLinkProperties": { # Properties specific to a RichLink. # Output only. The properties of this RichLink. This field is always present. + "mimeType": "A String", # Output only. The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the RichLink, if there's one (for example, when it's a file in Drive). + "title": "A String", # Output only. The title of the RichLink as displayed in the link. This title matches the title of the linked resource at the time of the insertion or last update of the link. This field is always present. + "uri": "A String", # Output only. The URI to the RichLink. This is always present. + }, + "suggestedDeletionIds": [ # IDs for suggestions that remove this link from the document. A RichLink might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. + "A String", + ], + "suggestedInsertionIds": [ # IDs for suggestions that insert this link into the document. A RichLink might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this RichLink, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this RichLink. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "startIndex": 42, # The zero-based start index of this paragraph element, in UTF-16 code units. + "textRun": { # A ParagraphElement that represents a run of text that all has the same styling. # A text run paragraph element. + "content": "A String", # The text of this run. Any non-text elements in the run are replaced with the Unicode character U+E907. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TextRun may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this run, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this run. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + }, + ], + "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The style of this paragraph. + "alignment": "A String", # The text alignment for this paragraph. + "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. + "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. + "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. + "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. + "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. + "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. + "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. + "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. + "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + }, + "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spacingMode": "A String", # The spacing mode for the paragraph. + "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. + { # A tab stop within a paragraph. + "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. + "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + ], + }, + "positionedObjectIds": [ # The IDs of the positioned objects tethered to this paragraph. + "A String", + ], + "suggestedBulletChanges": { # The suggested changes to this paragraph's bullet. + "a_key": { # A suggested change to a Bullet. + "bullet": { # Describes the bullet of a paragraph. # A Bullet that only includes the changes made in this suggestion. This can be used along with the bullet_suggestion_state to see which fields have changed and their new values. + "listId": "A String", # The ID of the list this paragraph belongs to. + "nestingLevel": 42, # The nesting level of this paragraph in the list. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "bulletSuggestionState": { # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. + "listIdSuggested": True or False, # Indicates if there was a suggested change to the list_id. + "nestingLevelSuggested": True or False, # Indicates if there was a suggested change to the nesting_level. + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + }, + "suggestedParagraphStyleChanges": { # The suggested paragraph style changes to this paragraph, keyed by suggestion ID. + "a_key": { # A suggested change to a ParagraphStyle. + "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A ParagraphStyle that only includes the changes made in this suggestion. This can be used along with the paragraph_style_suggestion_state to see which fields have changed and their new values. + "alignment": "A String", # The text alignment for this paragraph. + "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. + "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. + "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. + "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. + "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. + "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. + "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. + "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. + "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + }, + "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spacingMode": "A String", # The spacing mode for the paragraph. + "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. + { # A tab stop within a paragraph. + "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. + "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + ], + }, + "paragraphStyleSuggestionState": { # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. + "alignmentSuggested": True or False, # Indicates if there was a suggested change to alignment. + "avoidWidowAndOrphanSuggested": True or False, # Indicates if there was a suggested change to avoid_widow_and_orphan. + "borderBetweenSuggested": True or False, # Indicates if there was a suggested change to border_between. + "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. + "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. + "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. + "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. + "directionSuggested": True or False, # Indicates if there was a suggested change to direction. + "headingIdSuggested": True or False, # Indicates if there was a suggested change to heading_id. + "indentEndSuggested": True or False, # Indicates if there was a suggested change to indent_end. + "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line. + "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start. + "keepLinesTogetherSuggested": True or False, # Indicates if there was a suggested change to keep_lines_together. + "keepWithNextSuggested": True or False, # Indicates if there was a suggested change to keep_with_next. + "lineSpacingSuggested": True or False, # Indicates if there was a suggested change to line_spacing. + "namedStyleTypeSuggested": True or False, # Indicates if there was a suggested change to named_style_type. + "pageBreakBeforeSuggested": True or False, # Indicates if there was a suggested change to page_break_before. + "shadingSuggestionState": { # A mask that indicates which of the fields on the base Shading have been changed in this suggested change. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in shading have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to the Shading. + }, + "spaceAboveSuggested": True or False, # Indicates if there was a suggested change to space_above. + "spaceBelowSuggested": True or False, # Indicates if there was a suggested change to space_below. + "spacingModeSuggested": True or False, # Indicates if there was a suggested change to spacing_mode. + }, + }, + }, + "suggestedPositionedObjectIds": { # The IDs of the positioned objects suggested to be attached to this paragraph, keyed by suggestion ID. + "a_key": { # A collection of object IDs. + "objectIds": [ # The object IDs. + "A String", + ], + }, + }, + }, + "sectionBreak": { # A StructuralElement representing a section break. A section is a range of content that has the same SectionStyle. A section break represents the start of a new section, and the section style applies to the section after the section break. The document body always begins with a section break. # A section break type of structural element. + "sectionStyle": { # The styling that applies to a section. # The style of the section after this section break. + "columnProperties": [ # The section's columns properties. If empty, the section contains one column with the default properties in the Docs editor. A section can be updated to have no more than 3 columns. When updating this property, setting a concrete value is required. Unsetting this property will result in a 400 bad request error. + { # Properties that apply to a section's column. + "paddingEnd": { # A magnitude in a single direction in the specified units. # The padding at the end of the column. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # Output only. The width of the column. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + ], + "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only. + "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only. + "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only. + "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only. + "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only. + "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only. + "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "sectionType": "A String", # Output only. The type of section. + "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + }, + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A SectionBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + }, + "startIndex": 42, # The zero-based start index of this structural element, in UTF-16 code units. + "table": { # A StructuralElement representing a table. # A table type of structural element. + "columns": 42, # Number of columns in the table. It's possible for a table to be non-rectangular, so some rows may have a different number of cells. + "rows": 42, # Number of rows in the table. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A Table may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "tableRows": [ # The contents and style of each row. + { # The contents and style of a row in a Table. + "endIndex": 42, # The zero-based end index of this row, exclusive, in UTF-16 code units. + "startIndex": 42, # The zero-based start index of this row, in UTF-16 code units. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TableRow may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTableRowStyleChanges": { # The suggested style changes to this row, keyed by suggestion ID. + "a_key": { # A suggested change to a TableRowStyle. + "tableRowStyle": { # Styles that apply to a table row. # A TableRowStyle that only includes the changes made in this suggestion. This can be used along with the table_row_style_suggestion_state to see which fields have changed and their new values. + "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries. + "tableHeader": True or False, # Whether the row is a table header. + }, + "tableRowStyleSuggestionState": { # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. + "minRowHeightSuggested": True or False, # Indicates if there was a suggested change to min_row_height. + }, + }, + }, + "tableCells": [ # The contents and style of each cell in this row. It's possible for a table to be non-rectangular, so some rows may have a different number of cells than other rows in the same table. + { # The contents and style of a cell in a Table. + "content": [ # The content of the cell. + # Object with schema name: StructuralElement + ], + "endIndex": 42, # The zero-based end index of this cell, exclusive, in UTF-16 code units. + "startIndex": 42, # The zero-based start index of this cell, in UTF-16 code units. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TableCell may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTableCellStyleChanges": { # The suggested changes to the table cell style, keyed by suggestion ID. + "a_key": { # A suggested change to a TableCellStyle. + "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # A TableCellStyle that only includes the changes made in this suggestion. This can be used along with the table_cell_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "columnSpan": 42, # The column span of the cell. This property is read-only. + "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. + "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "rowSpan": 42, # The row span of the cell. This property is read-only. + }, + "tableCellStyleSuggestionState": { # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. + "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. + "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. + "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. + "columnSpanSuggested": True or False, # Indicates if there was a suggested change to column_span. + "contentAlignmentSuggested": True or False, # Indicates if there was a suggested change to content_alignment. + "paddingBottomSuggested": True or False, # Indicates if there was a suggested change to padding_bottom. + "paddingLeftSuggested": True or False, # Indicates if there was a suggested change to padding_left. + "paddingRightSuggested": True or False, # Indicates if there was a suggested change to padding_right. + "paddingTopSuggested": True or False, # Indicates if there was a suggested change to padding_top. + "rowSpanSuggested": True or False, # Indicates if there was a suggested change to row_span. + }, + }, + }, + "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # The style of the cell. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "columnSpan": 42, # The column span of the cell. This property is read-only. + "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. + "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "rowSpan": 42, # The row span of the cell. This property is read-only. + }, + }, + ], + "tableRowStyle": { # Styles that apply to a table row. # The style of the table row. + "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries. + "tableHeader": True or False, # Whether the row is a table header. + }, + }, + ], + "tableStyle": { # Styles that apply to a table. # The style of the table. + "tableColumnProperties": [ # The properties of each column. Note that in Docs, tables contain rows and rows contain cells, similar to HTML. So the properties for a row can be found on the row's table_row_style. + { # The properties of a column in a table. + "width": { # A magnitude in a single direction in the specified units. # The width of the column. Set when the column's `width_type` is FIXED_WIDTH. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "widthType": "A String", # The width type of the column. + }, + ], + }, + }, + "tableOfContents": { # A StructuralElement representing a table of contents. # A table of contents type of structural element. + "content": [ # The content of the table of contents. + # Object with schema name: StructuralElement + ], + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TableOfContents may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + }, + }, + ], + "headerId": "A String", # The ID of the header. + }, + }, + "inlineObjects": { # The inline objects in the document tab, keyed by object ID. + "a_key": { # An object that appears inline with text. An InlineObject contains an EmbeddedObject such as an image. + "inlineObjectProperties": { # Properties of an InlineObject. # The properties of this inline object. + "embeddedObject": { # An embedded object in the document. # The embedded object of this inline object. + "description": "A String", # The description of the embedded object. The `title` and `description` are both combined to display alt text. + "embeddedDrawingProperties": { # The properties of an embedded drawing and used to differentiate the object type. An embedded drawing is one that's created and edited within a document. Note that extensive details are not supported. # The properties of an embedded drawing. + }, + "embeddedObjectBorder": { # A border around an EmbeddedObject. # The border of the embedded object. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "propertyState": "A String", # The property state of the border property. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "imageProperties": { # The properties of an image. # The properties of an image. + "angle": 3.14, # The clockwise rotation angle of the image, in radians. + "brightness": 3.14, # The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. + "contentUri": "A String", # A URI to the image with a default lifetime of 30 minutes. This URI is tagged with the account of the requester. Anyone with the URI effectively accesses the image as the original requester. Access to the image may be lost if the document's sharing settings change. + "contrast": 3.14, # The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. + "cropProperties": { # The crop properties of an image. The crop rectangle is represented using fractional offsets from the original content's 4 edges. - If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the image's original bounding rectangle. - If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the image's original bounding rectangle. - If all offsets and rotation angle are 0, the image is not cropped. # The crop properties of the image. + "angle": 3.14, # The clockwise rotation angle of the crop rectangle around its center, in radians. Rotation is applied after the offsets. + "offsetBottom": 3.14, # The offset specifies how far inwards the bottom edge of the crop rectangle is from the bottom edge of the original content as a fraction of the original content's height. + "offsetLeft": 3.14, # The offset specifies how far inwards the left edge of the crop rectangle is from the left edge of the original content as a fraction of the original content's width. + "offsetRight": 3.14, # The offset specifies how far inwards the right edge of the crop rectangle is from the right edge of the original content as a fraction of the original content's width. + "offsetTop": 3.14, # The offset specifies how far inwards the top edge of the crop rectangle is from the top edge of the original content as a fraction of the original content's height. + }, + "sourceUri": "A String", # The source URI is the URI used to insert the image. The source URI can be empty. + "transparency": 3.14, # The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means transparent. + }, + "linkedContentReference": { # A reference to the external linked source content. # A reference to the external linked source content. For example, it contains a reference to the source Google Sheets chart when the embedded object is a linked chart. If unset, then the embedded object is not linked. + "sheetsChartReference": { # A reference to a linked chart embedded from Google Sheets. # A reference to the linked chart. + "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that's embedded. + "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart. + }, + }, + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginLeft": { # A magnitude in a single direction in the specified units. # The left margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginRight": { # A magnitude in a single direction in the specified units. # The right margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginTop": { # A magnitude in a single direction in the specified units. # The top margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "size": { # A width and height. # The visible size of the image after cropping. + "height": { # A magnitude in a single direction in the specified units. # The height of the object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "title": "A String", # The title of the embedded object. The `title` and `description` are both combined to display alt text. + }, + }, + "objectId": "A String", # The ID of this inline object. Can be used to update an object’s properties. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInlineObjectPropertiesChanges": { # The suggested changes to the inline object properties, keyed by suggestion ID. + "a_key": { # A suggested change to InlineObjectProperties. + "inlineObjectProperties": { # Properties of an InlineObject. # An InlineObjectProperties that only includes the changes made in this suggestion. This can be used along with the inline_object_properties_suggestion_state to see which fields have changed and their new values. + "embeddedObject": { # An embedded object in the document. # The embedded object of this inline object. + "description": "A String", # The description of the embedded object. The `title` and `description` are both combined to display alt text. + "embeddedDrawingProperties": { # The properties of an embedded drawing and used to differentiate the object type. An embedded drawing is one that's created and edited within a document. Note that extensive details are not supported. # The properties of an embedded drawing. + }, + "embeddedObjectBorder": { # A border around an EmbeddedObject. # The border of the embedded object. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "propertyState": "A String", # The property state of the border property. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "imageProperties": { # The properties of an image. # The properties of an image. + "angle": 3.14, # The clockwise rotation angle of the image, in radians. + "brightness": 3.14, # The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. + "contentUri": "A String", # A URI to the image with a default lifetime of 30 minutes. This URI is tagged with the account of the requester. Anyone with the URI effectively accesses the image as the original requester. Access to the image may be lost if the document's sharing settings change. + "contrast": 3.14, # The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. + "cropProperties": { # The crop properties of an image. The crop rectangle is represented using fractional offsets from the original content's 4 edges. - If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the image's original bounding rectangle. - If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the image's original bounding rectangle. - If all offsets and rotation angle are 0, the image is not cropped. # The crop properties of the image. + "angle": 3.14, # The clockwise rotation angle of the crop rectangle around its center, in radians. Rotation is applied after the offsets. + "offsetBottom": 3.14, # The offset specifies how far inwards the bottom edge of the crop rectangle is from the bottom edge of the original content as a fraction of the original content's height. + "offsetLeft": 3.14, # The offset specifies how far inwards the left edge of the crop rectangle is from the left edge of the original content as a fraction of the original content's width. + "offsetRight": 3.14, # The offset specifies how far inwards the right edge of the crop rectangle is from the right edge of the original content as a fraction of the original content's width. + "offsetTop": 3.14, # The offset specifies how far inwards the top edge of the crop rectangle is from the top edge of the original content as a fraction of the original content's height. + }, + "sourceUri": "A String", # The source URI is the URI used to insert the image. The source URI can be empty. + "transparency": 3.14, # The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means transparent. + }, + "linkedContentReference": { # A reference to the external linked source content. # A reference to the external linked source content. For example, it contains a reference to the source Google Sheets chart when the embedded object is a linked chart. If unset, then the embedded object is not linked. + "sheetsChartReference": { # A reference to a linked chart embedded from Google Sheets. # A reference to the linked chart. + "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that's embedded. + "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart. + }, + }, + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginLeft": { # A magnitude in a single direction in the specified units. # The left margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginRight": { # A magnitude in a single direction in the specified units. # The right margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginTop": { # A magnitude in a single direction in the specified units. # The top margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "size": { # A width and height. # The visible size of the image after cropping. + "height": { # A magnitude in a single direction in the specified units. # The height of the object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "title": "A String", # The title of the embedded object. The `title` and `description` are both combined to display alt text. + }, + }, + "inlineObjectPropertiesSuggestionState": { # A mask that indicates which of the fields on the base InlineObjectProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base InlineObjectProperties have been changed in this suggestion. + "embeddedObjectSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedObject have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_object have been changed in this suggestion. + "descriptionSuggested": True or False, # Indicates if there was a suggested change to description. + "embeddedDrawingPropertiesSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedDrawingProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_drawing_properties have been changed in this suggestion. + }, + "embeddedObjectBorderSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedObjectBorder have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_object_border have been changed in this suggestion. + "colorSuggested": True or False, # Indicates if there was a suggested change to color. + "dashStyleSuggested": True or False, # Indicates if there was a suggested change to dash_style. + "propertyStateSuggested": True or False, # Indicates if there was a suggested change to property_state. + "widthSuggested": True or False, # Indicates if there was a suggested change to width. + }, + "imagePropertiesSuggestionState": { # A mask that indicates which of the fields on the base ImageProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in image_properties have been changed in this suggestion. + "angleSuggested": True or False, # Indicates if there was a suggested change to angle. + "brightnessSuggested": True or False, # Indicates if there was a suggested change to brightness. + "contentUriSuggested": True or False, # Indicates if there was a suggested change to content_uri. + "contrastSuggested": True or False, # Indicates if there was a suggested change to contrast. + "cropPropertiesSuggestionState": { # A mask that indicates which of the fields on the base CropProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in crop_properties have been changed in this suggestion. + "angleSuggested": True or False, # Indicates if there was a suggested change to angle. + "offsetBottomSuggested": True or False, # Indicates if there was a suggested change to offset_bottom. + "offsetLeftSuggested": True or False, # Indicates if there was a suggested change to offset_left. + "offsetRightSuggested": True or False, # Indicates if there was a suggested change to offset_right. + "offsetTopSuggested": True or False, # Indicates if there was a suggested change to offset_top. + }, + "sourceUriSuggested": True or False, # Indicates if there was a suggested change to source_uri. + "transparencySuggested": True or False, # Indicates if there was a suggested change to transparency. + }, + "linkedContentReferenceSuggestionState": { # A mask that indicates which of the fields on the base LinkedContentReference have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in linked_content_reference have been changed in this suggestion. + "sheetsChartReferenceSuggestionState": { # A mask that indicates which of the fields on the base SheetsChartReference have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in sheets_chart_reference have been changed in this suggestion. + "chartIdSuggested": True or False, # Indicates if there was a suggested change to chart_id. + "spreadsheetIdSuggested": True or False, # Indicates if there was a suggested change to spreadsheet_id. + }, + }, + "marginBottomSuggested": True or False, # Indicates if there was a suggested change to margin_bottom. + "marginLeftSuggested": True or False, # Indicates if there was a suggested change to margin_left. + "marginRightSuggested": True or False, # Indicates if there was a suggested change to margin_right. + "marginTopSuggested": True or False, # Indicates if there was a suggested change to margin_top. + "sizeSuggestionState": { # A mask that indicates which of the fields on the base Size have been changed in this suggestion. For any field set to true, the Size has a new suggested value. # A mask that indicates which of the fields in size have been changed in this suggestion. + "heightSuggested": True or False, # Indicates if there was a suggested change to height. + "widthSuggested": True or False, # Indicates if there was a suggested change to width. + }, + "titleSuggested": True or False, # Indicates if there was a suggested change to title. + }, + }, + }, + }, + "suggestedInsertionId": "A String", # The suggested insertion ID. If empty, then this is not a suggested insertion. + }, + }, + "lists": { # The lists in the document tab, keyed by list ID. + "a_key": { # A List represents the list attributes for a group of paragraphs that all belong to the same list. A paragraph that's part of a list has a reference to the list's ID in its bullet. + "listProperties": { # The properties of a list that describe the look and feel of bullets belonging to paragraphs associated with a list. # The properties of the list. + "nestingLevels": [ # Describes the properties of the bullets at the associated level. A list has at most 9 levels of nesting with nesting level 0 corresponding to the top-most level and nesting level 8 corresponding to the most nested level. The nesting levels are returned in ascending order with the least nested returned first. + { # Contains properties describing the look and feel of a list bullet at a given level of nesting. + "bulletAlignment": "A String", # The alignment of the bullet within the space allotted for rendering the bullet. + "glyphFormat": "A String", # The format string used by bullets at this level of nesting. The glyph format contains one or more placeholders, and these placeholders are replaced with the appropriate values depending on the glyph_type or glyph_symbol. The placeholders follow the pattern `%[nesting_level]`. Furthermore, placeholders can have prefixes and suffixes. Thus, the glyph format follows the pattern `%[nesting_level]`. Note that the prefix and suffix are optional and can be arbitrary strings. For example, the glyph format `%0.` indicates that the rendered glyph will replace the placeholder with the corresponding glyph for nesting level 0 followed by a period as the suffix. So a list with a glyph type of UPPER_ALPHA and glyph format `%0.` at nesting level 0 will result in a list with rendered glyphs `A.` `B.` `C.` The glyph format can contain placeholders for the current nesting level as well as placeholders for parent nesting levels. For example, a list can have a glyph format of `%0.` at nesting level 0 and a glyph format of `%0.%1.` at nesting level 1. Assuming both nesting levels have DECIMAL glyph types, this would result in a list with rendered glyphs `1.` `2.` ` 2.1.` ` 2.2.` `3.` For nesting levels that are ordered, the string that replaces a placeholder in the glyph format for a particular paragraph depends on the paragraph's order within the list. + "glyphSymbol": "A String", # A custom glyph symbol used by bullets when paragraphs at this level of nesting are unordered. The glyph symbol replaces placeholders within the glyph_format. For example, if the glyph_symbol is the solid circle corresponding to Unicode U+25cf code point and the glyph_format is `%0`, the rendered glyph would be the solid circle. + "glyphType": "A String", # The type of glyph used by bullets when paragraphs at this level of nesting are ordered. The glyph type determines the type of glyph used to replace placeholders within the glyph_format when paragraphs at this level of nesting are ordered. For example, if the nesting level is 0, the glyph_format is `%0.` and the glyph type is DECIMAL, then the rendered glyph would replace the placeholder `%0` in the glyph format with a number corresponding to list item's order within the list. + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of paragraphs at this level of nesting. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for paragraphs at this level of nesting. Applied to the side that corresponds to the start of the text, based on the paragraph's content direction. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "startNumber": 42, # The number of the first list item at this nesting level. A value of 0 is treated as a value of 1 for lettered lists and Roman numeral lists. For values of both 0 and 1, lettered and Roman numeral lists will begin at `a` and `i` respectively. This value is ignored for nesting levels with unordered glyphs. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of bullets at this level of nesting. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + ], + }, + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this list. + "A String", + ], + "suggestedInsertionId": "A String", # The suggested insertion ID. If empty, then this is not a suggested insertion. + "suggestedListPropertiesChanges": { # The suggested changes to the list properties, keyed by suggestion ID. + "a_key": { # A suggested change to ListProperties. + "listProperties": { # The properties of a list that describe the look and feel of bullets belonging to paragraphs associated with a list. # A ListProperties that only includes the changes made in this suggestion. This can be used along with the list_properties_suggestion_state to see which fields have changed and their new values. + "nestingLevels": [ # Describes the properties of the bullets at the associated level. A list has at most 9 levels of nesting with nesting level 0 corresponding to the top-most level and nesting level 8 corresponding to the most nested level. The nesting levels are returned in ascending order with the least nested returned first. + { # Contains properties describing the look and feel of a list bullet at a given level of nesting. + "bulletAlignment": "A String", # The alignment of the bullet within the space allotted for rendering the bullet. + "glyphFormat": "A String", # The format string used by bullets at this level of nesting. The glyph format contains one or more placeholders, and these placeholders are replaced with the appropriate values depending on the glyph_type or glyph_symbol. The placeholders follow the pattern `%[nesting_level]`. Furthermore, placeholders can have prefixes and suffixes. Thus, the glyph format follows the pattern `%[nesting_level]`. Note that the prefix and suffix are optional and can be arbitrary strings. For example, the glyph format `%0.` indicates that the rendered glyph will replace the placeholder with the corresponding glyph for nesting level 0 followed by a period as the suffix. So a list with a glyph type of UPPER_ALPHA and glyph format `%0.` at nesting level 0 will result in a list with rendered glyphs `A.` `B.` `C.` The glyph format can contain placeholders for the current nesting level as well as placeholders for parent nesting levels. For example, a list can have a glyph format of `%0.` at nesting level 0 and a glyph format of `%0.%1.` at nesting level 1. Assuming both nesting levels have DECIMAL glyph types, this would result in a list with rendered glyphs `1.` `2.` ` 2.1.` ` 2.2.` `3.` For nesting levels that are ordered, the string that replaces a placeholder in the glyph format for a particular paragraph depends on the paragraph's order within the list. + "glyphSymbol": "A String", # A custom glyph symbol used by bullets when paragraphs at this level of nesting are unordered. The glyph symbol replaces placeholders within the glyph_format. For example, if the glyph_symbol is the solid circle corresponding to Unicode U+25cf code point and the glyph_format is `%0`, the rendered glyph would be the solid circle. + "glyphType": "A String", # The type of glyph used by bullets when paragraphs at this level of nesting are ordered. The glyph type determines the type of glyph used to replace placeholders within the glyph_format when paragraphs at this level of nesting are ordered. For example, if the nesting level is 0, the glyph_format is `%0.` and the glyph type is DECIMAL, then the rendered glyph would replace the placeholder `%0` in the glyph format with a number corresponding to list item's order within the list. + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of paragraphs at this level of nesting. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for paragraphs at this level of nesting. Applied to the side that corresponds to the start of the text, based on the paragraph's content direction. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "startNumber": 42, # The number of the first list item at this nesting level. A value of 0 is treated as a value of 1 for lettered lists and Roman numeral lists. For values of both 0 and 1, lettered and Roman numeral lists will begin at `a` and `i` respectively. This value is ignored for nesting levels with unordered glyphs. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of bullets at this level of nesting. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + ], + }, + "listPropertiesSuggestionState": { # A mask that indicates which of the fields on the base ListProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base ListProperties have been changed in this suggestion. + "nestingLevelsSuggestionStates": [ # A mask that indicates which of the fields on the corresponding NestingLevel in nesting_levels have been changed in this suggestion. The nesting level suggestion states are returned in ascending order of the nesting level with the least nested returned first. + { # A mask that indicates which of the fields on the base NestingLevel have been changed in this suggestion. For any field set to true, there's a new suggested value. + "bulletAlignmentSuggested": True or False, # Indicates if there was a suggested change to bullet_alignment. + "glyphFormatSuggested": True or False, # Indicates if there was a suggested change to glyph_format. + "glyphSymbolSuggested": True or False, # Indicates if there was a suggested change to glyph_symbol. + "glyphTypeSuggested": True or False, # Indicates if there was a suggested change to glyph_type. + "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line. + "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start. + "startNumberSuggested": True or False, # Indicates if there was a suggested change to start_number. + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + ], + }, + }, + }, + }, + }, + "namedRanges": { # The named ranges in the document tab, keyed by name. + "a_key": { # A collection of all the NamedRanges in the document that share a given name. + "name": "A String", # The name that all the named ranges share. + "namedRanges": [ # The NamedRanges that share the same name. + { # A collection of Ranges with the same named range ID. Named ranges allow developers to associate parts of a document with an arbitrary user-defined label so their contents can be programmatically read or edited later. A document can contain multiple named ranges with the same name, but every named range has a unique ID. A named range is created with a single Range, and content inserted inside a named range generally expands that range. However, certain document changes can cause the range to be split into multiple ranges. Named ranges are not private. All applications and collaborators that have access to the document can see its named ranges. + "name": "A String", # The name of the named range. + "namedRangeId": "A String", # The ID of the named range. + "ranges": [ # The ranges that belong to this named range. + { # Specifies a contiguous range of text. + "endIndex": 42, # The zero-based end index of this range, exclusive, in UTF-16 code units. In all current uses, an end index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges. + "segmentId": "A String", # The ID of the header, footer, or footnote that this range is contained in. An empty segment ID signifies the document's body. + "startIndex": 42, # The zero-based start index of this range, in UTF-16 code units. In all current uses, a start index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges. + "tabId": "A String", # The tab that contains this range. When omitted, the request applies to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. + }, + ], + }, + ], + }, + }, + "namedStyles": { # The named styles. Paragraphs in the document can inherit their TextStyle and ParagraphStyle from these named styles. # The named styles of the document tab. + "styles": [ # The named styles. There's an entry for each of the possible named style types. + { # A named style. Paragraphs in the document can inherit their TextStyle and ParagraphStyle from this named style when they have the same named style type. + "namedStyleType": "A String", # The type of this named style. + "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph style of this named style. + "alignment": "A String", # The text alignment for this paragraph. + "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. + "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. + "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. + "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. + "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. + "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. + "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. + "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. + "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + }, + "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spacingMode": "A String", # The spacing mode for the paragraph. + "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. + { # A tab stop within a paragraph. + "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. + "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + ], + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this named style. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + ], + }, + "positionedObjects": { # The positioned objects in the document tab, keyed by object ID. + "a_key": { # An object that's tethered to a Paragraph and positioned relative to the beginning of the paragraph. A PositionedObject contains an EmbeddedObject such as an image. + "objectId": "A String", # The ID of this positioned object. + "positionedObjectProperties": { # Properties of a PositionedObject. # The properties of this positioned object. + "embeddedObject": { # An embedded object in the document. # The embedded object of this positioned object. + "description": "A String", # The description of the embedded object. The `title` and `description` are both combined to display alt text. + "embeddedDrawingProperties": { # The properties of an embedded drawing and used to differentiate the object type. An embedded drawing is one that's created and edited within a document. Note that extensive details are not supported. # The properties of an embedded drawing. + }, + "embeddedObjectBorder": { # A border around an EmbeddedObject. # The border of the embedded object. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "propertyState": "A String", # The property state of the border property. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "imageProperties": { # The properties of an image. # The properties of an image. + "angle": 3.14, # The clockwise rotation angle of the image, in radians. + "brightness": 3.14, # The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. + "contentUri": "A String", # A URI to the image with a default lifetime of 30 minutes. This URI is tagged with the account of the requester. Anyone with the URI effectively accesses the image as the original requester. Access to the image may be lost if the document's sharing settings change. + "contrast": 3.14, # The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. + "cropProperties": { # The crop properties of an image. The crop rectangle is represented using fractional offsets from the original content's 4 edges. - If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the image's original bounding rectangle. - If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the image's original bounding rectangle. - If all offsets and rotation angle are 0, the image is not cropped. # The crop properties of the image. + "angle": 3.14, # The clockwise rotation angle of the crop rectangle around its center, in radians. Rotation is applied after the offsets. + "offsetBottom": 3.14, # The offset specifies how far inwards the bottom edge of the crop rectangle is from the bottom edge of the original content as a fraction of the original content's height. + "offsetLeft": 3.14, # The offset specifies how far inwards the left edge of the crop rectangle is from the left edge of the original content as a fraction of the original content's width. + "offsetRight": 3.14, # The offset specifies how far inwards the right edge of the crop rectangle is from the right edge of the original content as a fraction of the original content's width. + "offsetTop": 3.14, # The offset specifies how far inwards the top edge of the crop rectangle is from the top edge of the original content as a fraction of the original content's height. + }, + "sourceUri": "A String", # The source URI is the URI used to insert the image. The source URI can be empty. + "transparency": 3.14, # The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means transparent. + }, + "linkedContentReference": { # A reference to the external linked source content. # A reference to the external linked source content. For example, it contains a reference to the source Google Sheets chart when the embedded object is a linked chart. If unset, then the embedded object is not linked. + "sheetsChartReference": { # A reference to a linked chart embedded from Google Sheets. # A reference to the linked chart. + "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that's embedded. + "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart. + }, + }, + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginLeft": { # A magnitude in a single direction in the specified units. # The left margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginRight": { # A magnitude in a single direction in the specified units. # The right margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginTop": { # A magnitude in a single direction in the specified units. # The top margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "size": { # A width and height. # The visible size of the image after cropping. + "height": { # A magnitude in a single direction in the specified units. # The height of the object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "title": "A String", # The title of the embedded object. The `title` and `description` are both combined to display alt text. + }, + "positioning": { # The positioning of a PositionedObject. The positioned object is positioned relative to the beginning of the Paragraph it's tethered to. # The positioning of this positioned object relative to the newline of the Paragraph that references this positioned object. + "layout": "A String", # The layout of this positioned object. + "leftOffset": { # A magnitude in a single direction in the specified units. # The offset of the left edge of the positioned object relative to the beginning of the Paragraph it's tethered to. The exact positioning of the object can depend on other content in the document and the document's styling. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "topOffset": { # A magnitude in a single direction in the specified units. # The offset of the top edge of the positioned object relative to the beginning of the Paragraph it's tethered to. The exact positioning of the object can depend on other content in the document and the document's styling. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + }, + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionId": "A String", # The suggested insertion ID. If empty, then this is not a suggested insertion. + "suggestedPositionedObjectPropertiesChanges": { # The suggested changes to the positioned object properties, keyed by suggestion ID. + "a_key": { # A suggested change to PositionedObjectProperties. + "positionedObjectProperties": { # Properties of a PositionedObject. # A PositionedObjectProperties that only includes the changes made in this suggestion. This can be used along with the positioned_object_properties_suggestion_state to see which fields have changed and their new values. + "embeddedObject": { # An embedded object in the document. # The embedded object of this positioned object. + "description": "A String", # The description of the embedded object. The `title` and `description` are both combined to display alt text. + "embeddedDrawingProperties": { # The properties of an embedded drawing and used to differentiate the object type. An embedded drawing is one that's created and edited within a document. Note that extensive details are not supported. # The properties of an embedded drawing. + }, + "embeddedObjectBorder": { # A border around an EmbeddedObject. # The border of the embedded object. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "propertyState": "A String", # The property state of the border property. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "imageProperties": { # The properties of an image. # The properties of an image. + "angle": 3.14, # The clockwise rotation angle of the image, in radians. + "brightness": 3.14, # The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. + "contentUri": "A String", # A URI to the image with a default lifetime of 30 minutes. This URI is tagged with the account of the requester. Anyone with the URI effectively accesses the image as the original requester. Access to the image may be lost if the document's sharing settings change. + "contrast": 3.14, # The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. + "cropProperties": { # The crop properties of an image. The crop rectangle is represented using fractional offsets from the original content's 4 edges. - If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the image's original bounding rectangle. - If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the image's original bounding rectangle. - If all offsets and rotation angle are 0, the image is not cropped. # The crop properties of the image. + "angle": 3.14, # The clockwise rotation angle of the crop rectangle around its center, in radians. Rotation is applied after the offsets. + "offsetBottom": 3.14, # The offset specifies how far inwards the bottom edge of the crop rectangle is from the bottom edge of the original content as a fraction of the original content's height. + "offsetLeft": 3.14, # The offset specifies how far inwards the left edge of the crop rectangle is from the left edge of the original content as a fraction of the original content's width. + "offsetRight": 3.14, # The offset specifies how far inwards the right edge of the crop rectangle is from the right edge of the original content as a fraction of the original content's width. + "offsetTop": 3.14, # The offset specifies how far inwards the top edge of the crop rectangle is from the top edge of the original content as a fraction of the original content's height. + }, + "sourceUri": "A String", # The source URI is the URI used to insert the image. The source URI can be empty. + "transparency": 3.14, # The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means transparent. + }, + "linkedContentReference": { # A reference to the external linked source content. # A reference to the external linked source content. For example, it contains a reference to the source Google Sheets chart when the embedded object is a linked chart. If unset, then the embedded object is not linked. + "sheetsChartReference": { # A reference to a linked chart embedded from Google Sheets. # A reference to the linked chart. + "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that's embedded. + "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart. + }, + }, + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginLeft": { # A magnitude in a single direction in the specified units. # The left margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginRight": { # A magnitude in a single direction in the specified units. # The right margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginTop": { # A magnitude in a single direction in the specified units. # The top margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "size": { # A width and height. # The visible size of the image after cropping. + "height": { # A magnitude in a single direction in the specified units. # The height of the object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "title": "A String", # The title of the embedded object. The `title` and `description` are both combined to display alt text. + }, + "positioning": { # The positioning of a PositionedObject. The positioned object is positioned relative to the beginning of the Paragraph it's tethered to. # The positioning of this positioned object relative to the newline of the Paragraph that references this positioned object. + "layout": "A String", # The layout of this positioned object. + "leftOffset": { # A magnitude in a single direction in the specified units. # The offset of the left edge of the positioned object relative to the beginning of the Paragraph it's tethered to. The exact positioning of the object can depend on other content in the document and the document's styling. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "topOffset": { # A magnitude in a single direction in the specified units. # The offset of the top edge of the positioned object relative to the beginning of the Paragraph it's tethered to. The exact positioning of the object can depend on other content in the document and the document's styling. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + }, + "positionedObjectPropertiesSuggestionState": { # A mask that indicates which of the fields on the base PositionedObjectProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base PositionedObjectProperties have been changed in this suggestion. + "embeddedObjectSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedObject have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_object have been changed in this suggestion. + "descriptionSuggested": True or False, # Indicates if there was a suggested change to description. + "embeddedDrawingPropertiesSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedDrawingProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_drawing_properties have been changed in this suggestion. + }, + "embeddedObjectBorderSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedObjectBorder have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_object_border have been changed in this suggestion. + "colorSuggested": True or False, # Indicates if there was a suggested change to color. + "dashStyleSuggested": True or False, # Indicates if there was a suggested change to dash_style. + "propertyStateSuggested": True or False, # Indicates if there was a suggested change to property_state. + "widthSuggested": True or False, # Indicates if there was a suggested change to width. + }, + "imagePropertiesSuggestionState": { # A mask that indicates which of the fields on the base ImageProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in image_properties have been changed in this suggestion. + "angleSuggested": True or False, # Indicates if there was a suggested change to angle. + "brightnessSuggested": True or False, # Indicates if there was a suggested change to brightness. + "contentUriSuggested": True or False, # Indicates if there was a suggested change to content_uri. + "contrastSuggested": True or False, # Indicates if there was a suggested change to contrast. + "cropPropertiesSuggestionState": { # A mask that indicates which of the fields on the base CropProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in crop_properties have been changed in this suggestion. + "angleSuggested": True or False, # Indicates if there was a suggested change to angle. + "offsetBottomSuggested": True or False, # Indicates if there was a suggested change to offset_bottom. + "offsetLeftSuggested": True or False, # Indicates if there was a suggested change to offset_left. + "offsetRightSuggested": True or False, # Indicates if there was a suggested change to offset_right. + "offsetTopSuggested": True or False, # Indicates if there was a suggested change to offset_top. + }, + "sourceUriSuggested": True or False, # Indicates if there was a suggested change to source_uri. + "transparencySuggested": True or False, # Indicates if there was a suggested change to transparency. + }, + "linkedContentReferenceSuggestionState": { # A mask that indicates which of the fields on the base LinkedContentReference have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in linked_content_reference have been changed in this suggestion. + "sheetsChartReferenceSuggestionState": { # A mask that indicates which of the fields on the base SheetsChartReference have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in sheets_chart_reference have been changed in this suggestion. + "chartIdSuggested": True or False, # Indicates if there was a suggested change to chart_id. + "spreadsheetIdSuggested": True or False, # Indicates if there was a suggested change to spreadsheet_id. + }, + }, + "marginBottomSuggested": True or False, # Indicates if there was a suggested change to margin_bottom. + "marginLeftSuggested": True or False, # Indicates if there was a suggested change to margin_left. + "marginRightSuggested": True or False, # Indicates if there was a suggested change to margin_right. + "marginTopSuggested": True or False, # Indicates if there was a suggested change to margin_top. + "sizeSuggestionState": { # A mask that indicates which of the fields on the base Size have been changed in this suggestion. For any field set to true, the Size has a new suggested value. # A mask that indicates which of the fields in size have been changed in this suggestion. + "heightSuggested": True or False, # Indicates if there was a suggested change to height. + "widthSuggested": True or False, # Indicates if there was a suggested change to width. + }, + "titleSuggested": True or False, # Indicates if there was a suggested change to title. + }, + "positioningSuggestionState": { # A mask that indicates which of the fields on the base PositionedObjectPositioning have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in positioning have been changed in this suggestion. + "layoutSuggested": True or False, # Indicates if there was a suggested change to layout. + "leftOffsetSuggested": True or False, # Indicates if there was a suggested change to left_offset. + "topOffsetSuggested": True or False, # Indicates if there was a suggested change to top_offset. + }, + }, + }, + }, + }, + }, + "suggestedDocumentStyleChanges": { # The suggested changes to the style of the document tab, keyed by suggestion ID. + "a_key": { # A suggested change to the DocumentStyle. + "documentStyle": { # The style of the document. # A DocumentStyle that only includes the changes made in this suggestion. This can be used along with the document_style_suggestion_state to see which fields have changed and their new values. + "background": { # Represents the background of a document. # The background of the document. Documents cannot have a transparent background color. + "color": { # A color that can either be fully opaque or fully transparent. # The background color. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + }, + "defaultFooterId": "A String", # The ID of the default footer. If not set, there's no default footer. This property is read-only. + "defaultHeaderId": "A String", # The ID of the default header. If not set, there's no default header. This property is read-only. + "evenPageFooterId": "A String", # The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. This property is read-only. + "evenPageHeaderId": "A String", # The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. This property is read-only. + "firstPageFooterId": "A String", # The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. This property is read-only. + "firstPageHeaderId": "A String", # The ID of the header used only for the first page. If not set then a unique header for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_header_id or this value for the header on the first page. If not set, there's no first page header. This property is read-only. + "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of the page_size, which allows changing the page orientation between portrait and landscape. + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin. Updating the bottom page margin on the document style clears the bottom page margin on all section styles. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginFooter": { # A magnitude in a single direction in the specified units. # The amount of space between the bottom of the page and the contents of the footer. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginHeader": { # A magnitude in a single direction in the specified units. # The amount of space between the top of the page and the contents of the header. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin. Updating the left page margin on the document style clears the left page margin on all section styles. It may also cause columns to resize in all sections. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin. Updating the right page margin on the document style clears the right page margin on all section styles. It may also cause columns to resize in all sections. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin. Updating the top page margin on the document style clears the top page margin on all section styles. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "pageNumberStart": 42, # The page number from which to start counting the number of pages. + "pageSize": { # A width and height. # The size of a page in the document. + "height": { # A magnitude in a single direction in the specified units. # The height of the object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "useCustomHeaderFooterMargins": True or False, # Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected. When false, the default values in the Docs editor for header and footer margin are used. This property is read-only. + "useEvenPageHeaderFooter": True or False, # Indicates whether to use the even page header / footer IDs for the even pages. + "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page. + }, + "documentStyleSuggestionState": { # A mask that indicates which of the fields on the base DocumentStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DocumentStyle have been changed in this suggestion. + "backgroundSuggestionState": { # A mask that indicates which of the fields on the base Background have been changed in this suggestion. For any field set to true, the Backgound has a new suggested value. # A mask that indicates which of the fields in background have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates whether the current background color has been modified in this suggestion. + }, + "defaultFooterIdSuggested": True or False, # Indicates if there was a suggested change to default_footer_id. + "defaultHeaderIdSuggested": True or False, # Indicates if there was a suggested change to default_header_id. + "evenPageFooterIdSuggested": True or False, # Indicates if there was a suggested change to even_page_footer_id. + "evenPageHeaderIdSuggested": True or False, # Indicates if there was a suggested change to even_page_header_id. + "firstPageFooterIdSuggested": True or False, # Indicates if there was a suggested change to first_page_footer_id. + "firstPageHeaderIdSuggested": True or False, # Indicates if there was a suggested change to first_page_header_id. + "flipPageOrientationSuggested": True or False, # Optional. Indicates if there was a suggested change to flip_page_orientation. + "marginBottomSuggested": True or False, # Indicates if there was a suggested change to margin_bottom. + "marginFooterSuggested": True or False, # Indicates if there was a suggested change to margin_footer. + "marginHeaderSuggested": True or False, # Indicates if there was a suggested change to margin_header. + "marginLeftSuggested": True or False, # Indicates if there was a suggested change to margin_left. + "marginRightSuggested": True or False, # Indicates if there was a suggested change to margin_right. + "marginTopSuggested": True or False, # Indicates if there was a suggested change to margin_top. + "pageNumberStartSuggested": True or False, # Indicates if there was a suggested change to page_number_start. + "pageSizeSuggestionState": { # A mask that indicates which of the fields on the base Size have been changed in this suggestion. For any field set to true, the Size has a new suggested value. # A mask that indicates which of the fields in size have been changed in this suggestion. + "heightSuggested": True or False, # Indicates if there was a suggested change to height. + "widthSuggested": True or False, # Indicates if there was a suggested change to width. + }, + "useCustomHeaderFooterMarginsSuggested": True or False, # Indicates if there was a suggested change to use_custom_header_footer_margins. + "useEvenPageHeaderFooterSuggested": True or False, # Indicates if there was a suggested change to use_even_page_header_footer. + "useFirstPageHeaderFooterSuggested": True or False, # Indicates if there was a suggested change to use_first_page_header_footer. + }, + }, + }, + "suggestedNamedStylesChanges": { # The suggested changes to the named styles of the document tab, keyed by suggestion ID. + "a_key": { # A suggested change to the NamedStyles. + "namedStyles": { # The named styles. Paragraphs in the document can inherit their TextStyle and ParagraphStyle from these named styles. # A NamedStyles that only includes the changes made in this suggestion. This can be used along with the named_styles_suggestion_state to see which fields have changed and their new values. + "styles": [ # The named styles. There's an entry for each of the possible named style types. + { # A named style. Paragraphs in the document can inherit their TextStyle and ParagraphStyle from this named style when they have the same named style type. + "namedStyleType": "A String", # The type of this named style. + "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph style of this named style. + "alignment": "A String", # The text alignment for this paragraph. + "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. + "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. + "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. + "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. + "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. + "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. + "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. + "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. + "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + }, + "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spacingMode": "A String", # The spacing mode for the paragraph. + "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. + { # A tab stop within a paragraph. + "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. + "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + ], + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this named style. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + ], + }, + "namedStylesSuggestionState": { # The suggestion state of a NamedStyles message. # A mask that indicates which of the fields on the base NamedStyles have been changed in this suggestion. + "stylesSuggestionStates": [ # A mask that indicates which of the fields on the corresponding NamedStyle in styles have been changed in this suggestion. The order of these named style suggestion states matches the order of the corresponding named style within the named styles suggestion. + { # A suggestion state of a NamedStyle message. + "namedStyleType": "A String", # The named style type that this suggestion state corresponds to. This field is provided as a convenience for matching the NamedStyleSuggestionState with its corresponding NamedStyle. + "paragraphStyleSuggestionState": { # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in paragraph style have been changed in this suggestion. + "alignmentSuggested": True or False, # Indicates if there was a suggested change to alignment. + "avoidWidowAndOrphanSuggested": True or False, # Indicates if there was a suggested change to avoid_widow_and_orphan. + "borderBetweenSuggested": True or False, # Indicates if there was a suggested change to border_between. + "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. + "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. + "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. + "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. + "directionSuggested": True or False, # Indicates if there was a suggested change to direction. + "headingIdSuggested": True or False, # Indicates if there was a suggested change to heading_id. + "indentEndSuggested": True or False, # Indicates if there was a suggested change to indent_end. + "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line. + "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start. + "keepLinesTogetherSuggested": True or False, # Indicates if there was a suggested change to keep_lines_together. + "keepWithNextSuggested": True or False, # Indicates if there was a suggested change to keep_with_next. + "lineSpacingSuggested": True or False, # Indicates if there was a suggested change to line_spacing. + "namedStyleTypeSuggested": True or False, # Indicates if there was a suggested change to named_style_type. + "pageBreakBeforeSuggested": True or False, # Indicates if there was a suggested change to page_break_before. + "shadingSuggestionState": { # A mask that indicates which of the fields on the base Shading have been changed in this suggested change. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in shading have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to the Shading. + }, + "spaceAboveSuggested": True or False, # Indicates if there was a suggested change to space_above. + "spaceBelowSuggested": True or False, # Indicates if there was a suggested change to space_below. + "spacingModeSuggested": True or False, # Indicates if there was a suggested change to spacing_mode. + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + ], + }, + }, + }, + }, + "tabProperties": { # Properties of a tab. # The properties of the tab, like ID and title. + "index": 42, # The index of the tab within the parent. + "nestingLevel": 42, # Output only. The depth of the tab within the document. Root-level tabs start at 0. + "parentTabId": "A String", # Optional. The ID of the parent tab. Empty when the current tab is a root-level tab, which means it doesn't have any parents. + "tabId": "A String", # Output only. The ID of the tab. This field can't be changed. + "title": "A String", # The user-visible name of the tab. + }, + }, + ], + "title": "A String", # The title of the document. +}
+
+ +
+ get(documentId, includeTabsContent=None, suggestionsViewMode=None, x__xgafv=None) +
Gets the latest version of the specified document.
+
+Args:
+  documentId: string, The ID of the document to retrieve. (required)
+  includeTabsContent: boolean, Whether to populate the Document.tabs field instead of the text content fields like body and documentStyle on Document. - When `True`: Document content populates in the Document.tabs field instead of the text content fields in Document. - When `False`: The content of the document's first tab populates the content fields in Document excluding Document.tabs. If a document has only one tab, then that tab is used to populate the document content. Document.tabs will be empty.
+  suggestionsViewMode: string, The suggestions view mode to apply to the document. This allows viewing the document with all suggestions inline, accepted or rejected. If one is not specified, DEFAULT_FOR_CURRENT_ACCESS is used.
+    Allowed values
+      DEFAULT_FOR_CURRENT_ACCESS - The SuggestionsViewMode applied to the returned document depends on the user's current access level. If the user only has view access, PREVIEW_WITHOUT_SUGGESTIONS is applied. Otherwise, SUGGESTIONS_INLINE is applied. This is the default suggestions view mode.
+      SUGGESTIONS_INLINE - The returned document has suggestions inline. Suggested changes will be differentiated from base content within the document. Requests to retrieve a document using this mode will return a 403 error if the user does not have permission to view suggested changes.
+      PREVIEW_SUGGESTIONS_ACCEPTED - The returned document is a preview with all suggested changes accepted. Requests to retrieve a document using this mode will return a 403 error if the user does not have permission to view suggested changes.
+      PREVIEW_WITHOUT_SUGGESTIONS - The returned document is a preview with all suggested changes rejected if there are any suggestions in the document.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A Google Docs document.
+  "body": { # The document body. The body typically contains the full document contents except for headers, footers, and footnotes. # Output only. The main body of the document.
+    "content": [ # The contents of the body. The indexes for the body's content begin at zero.
+      { # A StructuralElement describes content that provides structure to the document.
+        "endIndex": 42, # The zero-based end index of this structural element, exclusive, in UTF-16 code units.
+        "paragraph": { # A StructuralElement representing a paragraph. A paragraph is a range of content that's terminated with a newline character. # A paragraph type of structural element.
+          "bullet": { # Describes the bullet of a paragraph. # The bullet for this paragraph. If not present, the paragraph does not belong to a list.
+            "listId": "A String", # The ID of the list this paragraph belongs to.
+            "nestingLevel": 42, # The nesting level of this paragraph in the list.
+            "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet.
+              "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                  "rgbColor": { # An RGB color. # The RGB color value.
+                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                  },
+                },
+              },
+              "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+              "bold": True or False, # Whether or not the text is rendered as bold.
+              "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                  "rgbColor": { # An RGB color. # The RGB color value.
+                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                  },
+                },
+              },
+              "italic": True or False, # Whether or not the text is italicized.
+              "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                  "id": "A String", # The ID of a bookmark in this document.
+                  "tabId": "A String", # The ID of the tab containing this bookmark.
+                },
+                "bookmarkId": "A String", # The ID of a bookmark in this document.
+                "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                  "id": "A String", # The ID of a heading in this document.
+                  "tabId": "A String", # The ID of the tab containing this heading.
+                },
+                "headingId": "A String", # The ID of a heading in this document.
+                "tabId": "A String", # The ID of a tab in this document.
+                "url": "A String", # An external URL.
+              },
+              "smallCaps": True or False, # Whether or not the text is in small capital letters.
+              "strikethrough": True or False, # Whether or not the text is struck through.
+              "underline": True or False, # Whether or not the text is underlined.
+              "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+              },
+            },
+          },
+          "elements": [ # The content of the paragraph, broken down into its component parts.
+            { # A ParagraphElement describes content within a Paragraph.
+              "autoText": { # A ParagraphElement representing a spot in the text that's dynamically replaced with content that can change over time, like a page number. # An auto text paragraph element.
+                "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                  "A String",
+                ],
+                "suggestedInsertionIds": [ # The suggested insertion IDs. An AutoText may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                  "A String",
+                ],
+                "suggestedTextStyleChanges": { # The suggested text style changes to this AutoText, keyed by suggestion ID.
+                  "a_key": { # A suggested change to a TextStyle.
+                    "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                      "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                      "bold": True or False, # Whether or not the text is rendered as bold.
+                      "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "italic": True or False, # Whether or not the text is italicized.
+                      "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                        "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                          "id": "A String", # The ID of a bookmark in this document.
+                          "tabId": "A String", # The ID of the tab containing this bookmark.
+                        },
+                        "bookmarkId": "A String", # The ID of a bookmark in this document.
+                        "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                          "id": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of the tab containing this heading.
+                        },
+                        "headingId": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of a tab in this document.
+                        "url": "A String", # An external URL.
+                      },
+                      "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                      "strikethrough": True or False, # Whether or not the text is struck through.
+                      "underline": True or False, # Whether or not the text is underlined.
+                      "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                        "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                        "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                      },
+                    },
+                    "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                      "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                      "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                      "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                      "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                      "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                      "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                      "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                      "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                      "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                      "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                      "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                    },
+                  },
+                },
+                "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this AutoText.
+                  "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                      "rgbColor": { # An RGB color. # The RGB color value.
+                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                      },
+                    },
+                  },
+                  "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                  "bold": True or False, # Whether or not the text is rendered as bold.
+                  "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                      "rgbColor": { # An RGB color. # The RGB color value.
+                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                      },
+                    },
+                  },
+                  "italic": True or False, # Whether or not the text is italicized.
+                  "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                    "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                      "id": "A String", # The ID of a bookmark in this document.
+                      "tabId": "A String", # The ID of the tab containing this bookmark.
+                    },
+                    "bookmarkId": "A String", # The ID of a bookmark in this document.
+                    "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                      "id": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of the tab containing this heading.
+                    },
+                    "headingId": "A String", # The ID of a heading in this document.
+                    "tabId": "A String", # The ID of a tab in this document.
+                    "url": "A String", # An external URL.
+                  },
+                  "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                  "strikethrough": True or False, # Whether or not the text is struck through.
+                  "underline": True or False, # Whether or not the text is underlined.
+                  "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                    "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                    "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                  },
+                },
+                "type": "A String", # The type of this auto text.
+              },
+              "columnBreak": { # A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column. # A column break paragraph element.
+                "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                  "A String",
+                ],
+                "suggestedInsertionIds": [ # The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                  "A String",
+                ],
+                "suggestedTextStyleChanges": { # The suggested text style changes to this ColumnBreak, keyed by suggestion ID.
+                  "a_key": { # A suggested change to a TextStyle.
+                    "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                      "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                      "bold": True or False, # Whether or not the text is rendered as bold.
+                      "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "italic": True or False, # Whether or not the text is italicized.
+                      "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                        "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                          "id": "A String", # The ID of a bookmark in this document.
+                          "tabId": "A String", # The ID of the tab containing this bookmark.
+                        },
+                        "bookmarkId": "A String", # The ID of a bookmark in this document.
+                        "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                          "id": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of the tab containing this heading.
+                        },
+                        "headingId": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of a tab in this document.
+                        "url": "A String", # An external URL.
+                      },
+                      "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                      "strikethrough": True or False, # Whether or not the text is struck through.
+                      "underline": True or False, # Whether or not the text is underlined.
+                      "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                        "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                        "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                      },
+                    },
+                    "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                      "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                      "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                      "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                      "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                      "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                      "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                      "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                      "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                      "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                      "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                      "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                    },
+                  },
+                },
+                "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it.
+                  "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                      "rgbColor": { # An RGB color. # The RGB color value.
+                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                      },
+                    },
+                  },
+                  "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                  "bold": True or False, # Whether or not the text is rendered as bold.
+                  "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                      "rgbColor": { # An RGB color. # The RGB color value.
+                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                      },
+                    },
+                  },
+                  "italic": True or False, # Whether or not the text is italicized.
+                  "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                    "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                      "id": "A String", # The ID of a bookmark in this document.
+                      "tabId": "A String", # The ID of the tab containing this bookmark.
+                    },
+                    "bookmarkId": "A String", # The ID of a bookmark in this document.
+                    "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                      "id": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of the tab containing this heading.
+                    },
+                    "headingId": "A String", # The ID of a heading in this document.
+                    "tabId": "A String", # The ID of a tab in this document.
+                    "url": "A String", # An external URL.
+                  },
+                  "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                  "strikethrough": True or False, # Whether or not the text is struck through.
+                  "underline": True or False, # Whether or not the text is underlined.
+                  "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                    "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                    "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                  },
+                },
+              },
+              "endIndex": 42, # The zero-base end index of this paragraph element, exclusive, in UTF-16 code units.
+              "equation": { # A ParagraphElement representing an equation. # An equation paragraph element.
+                "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                  "A String",
+                ],
+                "suggestedInsertionIds": [ # The suggested insertion IDs. An Equation may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                  "A String",
+                ],
+              },
+              "footnoteReference": { # A ParagraphElement representing a footnote reference. A footnote reference is the inline content rendered with a number and is used to identify the footnote. # A footnote reference paragraph element.
+                "footnoteId": "A String", # The ID of the footnote that contains the content of this footnote reference.
+                "footnoteNumber": "A String", # The rendered number of this footnote.
+                "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                  "A String",
+                ],
+                "suggestedInsertionIds": [ # The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                  "A String",
+                ],
+                "suggestedTextStyleChanges": { # The suggested text style changes to this FootnoteReference, keyed by suggestion ID.
+                  "a_key": { # A suggested change to a TextStyle.
+                    "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                      "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                      "bold": True or False, # Whether or not the text is rendered as bold.
+                      "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "italic": True or False, # Whether or not the text is italicized.
+                      "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                        "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                          "id": "A String", # The ID of a bookmark in this document.
+                          "tabId": "A String", # The ID of the tab containing this bookmark.
+                        },
+                        "bookmarkId": "A String", # The ID of a bookmark in this document.
+                        "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                          "id": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of the tab containing this heading.
+                        },
+                        "headingId": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of a tab in this document.
+                        "url": "A String", # An external URL.
+                      },
+                      "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                      "strikethrough": True or False, # Whether or not the text is struck through.
+                      "underline": True or False, # Whether or not the text is underlined.
+                      "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                        "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                        "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                      },
+                    },
+                    "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                      "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                      "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                      "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                      "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                      "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                      "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                      "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                      "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                      "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                      "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                      "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                    },
+                  },
+                },
+                "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this FootnoteReference.
+                  "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                      "rgbColor": { # An RGB color. # The RGB color value.
+                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                      },
+                    },
+                  },
+                  "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                  "bold": True or False, # Whether or not the text is rendered as bold.
+                  "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                      "rgbColor": { # An RGB color. # The RGB color value.
+                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                      },
+                    },
+                  },
+                  "italic": True or False, # Whether or not the text is italicized.
+                  "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                    "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                      "id": "A String", # The ID of a bookmark in this document.
+                      "tabId": "A String", # The ID of the tab containing this bookmark.
+                    },
+                    "bookmarkId": "A String", # The ID of a bookmark in this document.
+                    "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                      "id": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of the tab containing this heading.
+                    },
+                    "headingId": "A String", # The ID of a heading in this document.
+                    "tabId": "A String", # The ID of a tab in this document.
+                    "url": "A String", # An external URL.
+                  },
+                  "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                  "strikethrough": True or False, # Whether or not the text is struck through.
+                  "underline": True or False, # Whether or not the text is underlined.
+                  "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                    "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                    "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                  },
+                },
+              },
+              "horizontalRule": { # A ParagraphElement representing a horizontal line. # A horizontal rule paragraph element.
+                "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                  "A String",
+                ],
+                "suggestedInsertionIds": [ # The suggested insertion IDs. A HorizontalRule may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion.
+                  "A String",
+                ],
+                "suggestedTextStyleChanges": { # The suggested text style changes to this HorizontalRule, keyed by suggestion ID.
+                  "a_key": { # A suggested change to a TextStyle.
+                    "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                      "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                      "bold": True or False, # Whether or not the text is rendered as bold.
+                      "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "italic": True or False, # Whether or not the text is italicized.
+                      "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                        "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                          "id": "A String", # The ID of a bookmark in this document.
+                          "tabId": "A String", # The ID of the tab containing this bookmark.
+                        },
+                        "bookmarkId": "A String", # The ID of a bookmark in this document.
+                        "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                          "id": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of the tab containing this heading.
+                        },
+                        "headingId": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of a tab in this document.
+                        "url": "A String", # An external URL.
+                      },
+                      "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                      "strikethrough": True or False, # Whether or not the text is struck through.
+                      "underline": True or False, # Whether or not the text is underlined.
+                      "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                        "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                        "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                      },
+                    },
+                    "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                      "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                      "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                      "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                      "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                      "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                      "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                      "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                      "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                      "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                      "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                      "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                    },
+                  },
+                },
+                "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this HorizontalRule. Similar to text content, like text runs and footnote references, the text style of a horizontal rule can affect content layout as well as the styling of text inserted next to it.
+                  "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                      "rgbColor": { # An RGB color. # The RGB color value.
+                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                      },
+                    },
+                  },
+                  "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                  "bold": True or False, # Whether or not the text is rendered as bold.
+                  "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                      "rgbColor": { # An RGB color. # The RGB color value.
+                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                      },
+                    },
+                  },
+                  "italic": True or False, # Whether or not the text is italicized.
+                  "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                    "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                      "id": "A String", # The ID of a bookmark in this document.
+                      "tabId": "A String", # The ID of the tab containing this bookmark.
+                    },
+                    "bookmarkId": "A String", # The ID of a bookmark in this document.
+                    "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                      "id": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of the tab containing this heading.
+                    },
+                    "headingId": "A String", # The ID of a heading in this document.
+                    "tabId": "A String", # The ID of a tab in this document.
+                    "url": "A String", # An external URL.
+                  },
+                  "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                  "strikethrough": True or False, # Whether or not the text is struck through.
+                  "underline": True or False, # Whether or not the text is underlined.
+                  "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                    "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                    "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                  },
+                },
+              },
+              "inlineObjectElement": { # A ParagraphElement that contains an InlineObject. # An inline object paragraph element.
+                "inlineObjectId": "A String", # The ID of the InlineObject this element contains.
+                "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                  "A String",
+                ],
+                "suggestedInsertionIds": [ # The suggested insertion IDs. An InlineObjectElement may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                  "A String",
+                ],
+                "suggestedTextStyleChanges": { # The suggested text style changes to this InlineObject, keyed by suggestion ID.
+                  "a_key": { # A suggested change to a TextStyle.
+                    "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                      "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                      "bold": True or False, # Whether or not the text is rendered as bold.
+                      "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "italic": True or False, # Whether or not the text is italicized.
+                      "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                        "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                          "id": "A String", # The ID of a bookmark in this document.
+                          "tabId": "A String", # The ID of the tab containing this bookmark.
+                        },
+                        "bookmarkId": "A String", # The ID of a bookmark in this document.
+                        "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                          "id": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of the tab containing this heading.
+                        },
+                        "headingId": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of a tab in this document.
+                        "url": "A String", # An external URL.
+                      },
+                      "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                      "strikethrough": True or False, # Whether or not the text is struck through.
+                      "underline": True or False, # Whether or not the text is underlined.
+                      "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                        "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                        "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                      },
+                    },
+                    "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                      "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                      "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                      "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                      "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                      "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                      "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                      "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                      "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                      "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                      "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                      "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                    },
+                  },
+                },
+                "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this InlineObjectElement. Similar to text content, like text runs and footnote references, the text style of an inline object element can affect content layout as well as the styling of text inserted next to it.
+                  "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                      "rgbColor": { # An RGB color. # The RGB color value.
+                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                      },
+                    },
+                  },
+                  "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                  "bold": True or False, # Whether or not the text is rendered as bold.
+                  "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                      "rgbColor": { # An RGB color. # The RGB color value.
+                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                      },
+                    },
+                  },
+                  "italic": True or False, # Whether or not the text is italicized.
+                  "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                    "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                      "id": "A String", # The ID of a bookmark in this document.
+                      "tabId": "A String", # The ID of the tab containing this bookmark.
+                    },
+                    "bookmarkId": "A String", # The ID of a bookmark in this document.
+                    "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                      "id": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of the tab containing this heading.
+                    },
+                    "headingId": "A String", # The ID of a heading in this document.
+                    "tabId": "A String", # The ID of a tab in this document.
+                    "url": "A String", # An external URL.
+                  },
+                  "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                  "strikethrough": True or False, # Whether or not the text is struck through.
+                  "underline": True or False, # Whether or not the text is underlined.
+                  "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                    "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                    "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                  },
+                },
+              },
+              "pageBreak": { # A ParagraphElement representing a page break. A page break makes the subsequent text start at the top of the next page. # A page break paragraph element.
+                "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                  "A String",
+                ],
+                "suggestedInsertionIds": [ # The suggested insertion IDs. A PageBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                  "A String",
+                ],
+                "suggestedTextStyleChanges": { # The suggested text style changes to this PageBreak, keyed by suggestion ID.
+                  "a_key": { # A suggested change to a TextStyle.
+                    "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                      "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                      "bold": True or False, # Whether or not the text is rendered as bold.
+                      "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "italic": True or False, # Whether or not the text is italicized.
+                      "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                        "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                          "id": "A String", # The ID of a bookmark in this document.
+                          "tabId": "A String", # The ID of the tab containing this bookmark.
+                        },
+                        "bookmarkId": "A String", # The ID of a bookmark in this document.
+                        "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                          "id": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of the tab containing this heading.
+                        },
+                        "headingId": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of a tab in this document.
+                        "url": "A String", # An external URL.
+                      },
+                      "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                      "strikethrough": True or False, # Whether or not the text is struck through.
+                      "underline": True or False, # Whether or not the text is underlined.
+                      "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                        "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                        "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                      },
+                    },
+                    "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                      "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                      "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                      "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                      "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                      "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                      "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                      "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                      "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                      "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                      "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                      "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                    },
+                  },
+                },
+                "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this PageBreak. Similar to text content, like text runs and footnote references, the text style of a page break can affect content layout as well as the styling of text inserted next to it.
+                  "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                      "rgbColor": { # An RGB color. # The RGB color value.
+                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                      },
+                    },
+                  },
+                  "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                  "bold": True or False, # Whether or not the text is rendered as bold.
+                  "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                      "rgbColor": { # An RGB color. # The RGB color value.
+                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                      },
+                    },
+                  },
+                  "italic": True or False, # Whether or not the text is italicized.
+                  "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                    "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                      "id": "A String", # The ID of a bookmark in this document.
+                      "tabId": "A String", # The ID of the tab containing this bookmark.
+                    },
+                    "bookmarkId": "A String", # The ID of a bookmark in this document.
+                    "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                      "id": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of the tab containing this heading.
+                    },
+                    "headingId": "A String", # The ID of a heading in this document.
+                    "tabId": "A String", # The ID of a tab in this document.
+                    "url": "A String", # An external URL.
+                  },
+                  "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                  "strikethrough": True or False, # Whether or not the text is struck through.
+                  "underline": True or False, # Whether or not the text is underlined.
+                  "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                    "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                    "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                  },
+                },
+              },
+              "person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address.
+                "personId": "A String", # Output only. The unique ID of this link.
+                "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present.
+                  "email": "A String", # Output only. The email address linked to this Person. This field is always present.
+                  "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address.
+                },
+                "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion.
+                  "A String",
+                ],
+                "suggestedInsertionIds": [ # IDs for suggestions that insert this person link into the document. A Person might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion.
+                  "A String",
+                ],
+                "suggestedTextStyleChanges": { # The suggested text style changes to this Person, keyed by suggestion ID.
+                  "a_key": { # A suggested change to a TextStyle.
+                    "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                      "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                      "bold": True or False, # Whether or not the text is rendered as bold.
+                      "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "italic": True or False, # Whether or not the text is italicized.
+                      "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                        "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                          "id": "A String", # The ID of a bookmark in this document.
+                          "tabId": "A String", # The ID of the tab containing this bookmark.
+                        },
+                        "bookmarkId": "A String", # The ID of a bookmark in this document.
+                        "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                          "id": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of the tab containing this heading.
+                        },
+                        "headingId": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of a tab in this document.
+                        "url": "A String", # An external URL.
+                      },
+                      "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                      "strikethrough": True or False, # Whether or not the text is struck through.
+                      "underline": True or False, # Whether or not the text is underlined.
+                      "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                        "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                        "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                      },
+                    },
+                    "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                      "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                      "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                      "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                      "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                      "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                      "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                      "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                      "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                      "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                      "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                      "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                    },
+                  },
+                },
+                "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this Person.
+                  "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                      "rgbColor": { # An RGB color. # The RGB color value.
+                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                      },
+                    },
+                  },
+                  "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                  "bold": True or False, # Whether or not the text is rendered as bold.
+                  "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                      "rgbColor": { # An RGB color. # The RGB color value.
+                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                      },
+                    },
+                  },
+                  "italic": True or False, # Whether or not the text is italicized.
+                  "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                    "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                      "id": "A String", # The ID of a bookmark in this document.
+                      "tabId": "A String", # The ID of the tab containing this bookmark.
+                    },
+                    "bookmarkId": "A String", # The ID of a bookmark in this document.
+                    "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                      "id": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of the tab containing this heading.
+                    },
+                    "headingId": "A String", # The ID of a heading in this document.
+                    "tabId": "A String", # The ID of a tab in this document.
+                    "url": "A String", # An external URL.
+                  },
+                  "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                  "strikethrough": True or False, # Whether or not the text is struck through.
+                  "underline": True or False, # Whether or not the text is underlined.
+                  "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                    "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                    "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                  },
+                },
+              },
+              "richLink": { # A link to a Google resource (such as a file in Drive, a YouTube video, or a Calendar event). # A paragraph element that links to a Google resource (such as a file in Google Drive, a YouTube video, or a Calendar event.)
+                "richLinkId": "A String", # Output only. The ID of this link.
+                "richLinkProperties": { # Properties specific to a RichLink. # Output only. The properties of this RichLink. This field is always present.
+                  "mimeType": "A String", # Output only. The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the RichLink, if there's one (for example, when it's a file in Drive).
+                  "title": "A String", # Output only. The title of the RichLink as displayed in the link. This title matches the title of the linked resource at the time of the insertion or last update of the link. This field is always present.
+                  "uri": "A String", # Output only. The URI to the RichLink. This is always present.
+                },
+                "suggestedDeletionIds": [ # IDs for suggestions that remove this link from the document. A RichLink might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion.
+                  "A String",
+                ],
+                "suggestedInsertionIds": [ # IDs for suggestions that insert this link into the document. A RichLink might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion.
+                  "A String",
+                ],
+                "suggestedTextStyleChanges": { # The suggested text style changes to this RichLink, keyed by suggestion ID.
+                  "a_key": { # A suggested change to a TextStyle.
+                    "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                      "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                      "bold": True or False, # Whether or not the text is rendered as bold.
+                      "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "italic": True or False, # Whether or not the text is italicized.
+                      "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                        "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                          "id": "A String", # The ID of a bookmark in this document.
+                          "tabId": "A String", # The ID of the tab containing this bookmark.
+                        },
+                        "bookmarkId": "A String", # The ID of a bookmark in this document.
+                        "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                          "id": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of the tab containing this heading.
+                        },
+                        "headingId": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of a tab in this document.
+                        "url": "A String", # An external URL.
+                      },
+                      "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                      "strikethrough": True or False, # Whether or not the text is struck through.
+                      "underline": True or False, # Whether or not the text is underlined.
+                      "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                        "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                        "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                      },
+                    },
+                    "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                      "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                      "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                      "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                      "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                      "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                      "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                      "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                      "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                      "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                      "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                      "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                    },
+                  },
+                },
+                "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this RichLink.
+                  "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                      "rgbColor": { # An RGB color. # The RGB color value.
+                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                      },
+                    },
+                  },
+                  "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                  "bold": True or False, # Whether or not the text is rendered as bold.
+                  "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                      "rgbColor": { # An RGB color. # The RGB color value.
+                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                      },
+                    },
+                  },
+                  "italic": True or False, # Whether or not the text is italicized.
+                  "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                    "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                      "id": "A String", # The ID of a bookmark in this document.
+                      "tabId": "A String", # The ID of the tab containing this bookmark.
+                    },
+                    "bookmarkId": "A String", # The ID of a bookmark in this document.
+                    "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                      "id": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of the tab containing this heading.
+                    },
+                    "headingId": "A String", # The ID of a heading in this document.
+                    "tabId": "A String", # The ID of a tab in this document.
+                    "url": "A String", # An external URL.
+                  },
+                  "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                  "strikethrough": True or False, # Whether or not the text is struck through.
+                  "underline": True or False, # Whether or not the text is underlined.
+                  "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                    "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                    "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                  },
+                },
+              },
+              "startIndex": 42, # The zero-based start index of this paragraph element, in UTF-16 code units.
+              "textRun": { # A ParagraphElement that represents a run of text that all has the same styling. # A text run paragraph element.
+                "content": "A String", # The text of this run. Any non-text elements in the run are replaced with the Unicode character U+E907.
+                "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                  "A String",
+                ],
+                "suggestedInsertionIds": [ # The suggested insertion IDs. A TextRun may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                  "A String",
+                ],
+                "suggestedTextStyleChanges": { # The suggested text style changes to this run, keyed by suggestion ID.
+                  "a_key": { # A suggested change to a TextStyle.
+                    "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                      "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                      "bold": True or False, # Whether or not the text is rendered as bold.
+                      "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "italic": True or False, # Whether or not the text is italicized.
+                      "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                        "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                          "id": "A String", # The ID of a bookmark in this document.
+                          "tabId": "A String", # The ID of the tab containing this bookmark.
+                        },
+                        "bookmarkId": "A String", # The ID of a bookmark in this document.
+                        "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                          "id": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of the tab containing this heading.
+                        },
+                        "headingId": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of a tab in this document.
+                        "url": "A String", # An external URL.
+                      },
+                      "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                      "strikethrough": True or False, # Whether or not the text is struck through.
+                      "underline": True or False, # Whether or not the text is underlined.
+                      "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                        "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                        "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                      },
+                    },
+                    "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                      "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                      "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                      "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                      "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                      "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                      "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                      "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                      "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                      "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                      "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                      "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                    },
+                  },
+                },
+                "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this run.
+                  "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                      "rgbColor": { # An RGB color. # The RGB color value.
+                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                      },
+                    },
+                  },
+                  "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                  "bold": True or False, # Whether or not the text is rendered as bold.
+                  "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                      "rgbColor": { # An RGB color. # The RGB color value.
+                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                      },
+                    },
+                  },
+                  "italic": True or False, # Whether or not the text is italicized.
+                  "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                    "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                      "id": "A String", # The ID of a bookmark in this document.
+                      "tabId": "A String", # The ID of the tab containing this bookmark.
+                    },
+                    "bookmarkId": "A String", # The ID of a bookmark in this document.
+                    "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                      "id": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of the tab containing this heading.
+                    },
+                    "headingId": "A String", # The ID of a heading in this document.
+                    "tabId": "A String", # The ID of a tab in this document.
+                    "url": "A String", # An external URL.
+                  },
+                  "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                  "strikethrough": True or False, # Whether or not the text is struck through.
+                  "underline": True or False, # Whether or not the text is underlined.
+                  "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                    "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                    "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                  },
+                },
+              },
+            },
+          ],
+          "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The style of this paragraph.
+            "alignment": "A String", # The text alignment for this paragraph.
+            "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent.
+            "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+              "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                  "rgbColor": { # An RGB color. # The RGB color value.
+                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                  },
+                },
+              },
+              "dashStyle": "A String", # The dash style of the border.
+              "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+            },
+            "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+              "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                  "rgbColor": { # An RGB color. # The RGB color value.
+                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                  },
+                },
+              },
+              "dashStyle": "A String", # The dash style of the border.
+              "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+            },
+            "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+              "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                  "rgbColor": { # An RGB color. # The RGB color value.
+                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                  },
+                },
+              },
+              "dashStyle": "A String", # The dash style of the border.
+              "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+            },
+            "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+              "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                  "rgbColor": { # An RGB color. # The RGB color value.
+                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                  },
+                },
+              },
+              "dashStyle": "A String", # The dash style of the border.
+              "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+            },
+            "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+              "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                  "rgbColor": { # An RGB color. # The RGB color value.
+                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                  },
+                },
+              },
+              "dashStyle": "A String", # The dash style of the border.
+              "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+            },
+            "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited.
+            "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only.
+            "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
+              "magnitude": 3.14, # The magnitude.
+              "unit": "A String", # The units for magnitude.
+            },
+            "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent.
+              "magnitude": 3.14, # The magnitude.
+              "unit": "A String", # The units for magnitude.
+            },
+            "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
+              "magnitude": 3.14, # The magnitude.
+              "unit": "A String", # The units for magnitude.
+            },
+            "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent.
+            "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent.
+            "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent.
+            "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated.
+            "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error.
+            "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent.
+              "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading.
+                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                  "rgbColor": { # An RGB color. # The RGB color value.
+                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                  },
+                },
+              },
+            },
+            "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent.
+              "magnitude": 3.14, # The magnitude.
+              "unit": "A String", # The units for magnitude.
+            },
+            "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent.
+              "magnitude": 3.14, # The magnitude.
+              "unit": "A String", # The units for magnitude.
+            },
+            "spacingMode": "A String", # The spacing mode for the paragraph.
+            "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only.
+              { # A tab stop within a paragraph.
+                "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START.
+                "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+              },
+            ],
+          },
+          "positionedObjectIds": [ # The IDs of the positioned objects tethered to this paragraph.
+            "A String",
+          ],
+          "suggestedBulletChanges": { # The suggested changes to this paragraph's bullet.
+            "a_key": { # A suggested change to a Bullet.
+              "bullet": { # Describes the bullet of a paragraph. # A Bullet that only includes the changes made in this suggestion. This can be used along with the bullet_suggestion_state to see which fields have changed and their new values.
+                "listId": "A String", # The ID of the list this paragraph belongs to.
+                "nestingLevel": 42, # The nesting level of this paragraph in the list.
+                "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet.
+                  "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                      "rgbColor": { # An RGB color. # The RGB color value.
+                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                      },
+                    },
+                  },
+                  "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                  "bold": True or False, # Whether or not the text is rendered as bold.
+                  "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                      "rgbColor": { # An RGB color. # The RGB color value.
+                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                      },
+                    },
+                  },
+                  "italic": True or False, # Whether or not the text is italicized.
+                  "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                    "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                      "id": "A String", # The ID of a bookmark in this document.
+                      "tabId": "A String", # The ID of the tab containing this bookmark.
+                    },
+                    "bookmarkId": "A String", # The ID of a bookmark in this document.
+                    "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                      "id": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of the tab containing this heading.
+                    },
+                    "headingId": "A String", # The ID of a heading in this document.
+                    "tabId": "A String", # The ID of a tab in this document.
+                    "url": "A String", # An external URL.
+                  },
+                  "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                  "strikethrough": True or False, # Whether or not the text is struck through.
+                  "underline": True or False, # Whether or not the text is underlined.
+                  "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                    "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                    "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                  },
+                },
+              },
+              "bulletSuggestionState": { # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion.
+                "listIdSuggested": True or False, # Indicates if there was a suggested change to the list_id.
+                "nestingLevelSuggested": True or False, # Indicates if there was a suggested change to the nesting_level.
+                "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion.
+                  "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                  "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                  "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                  "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                  "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                  "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                  "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                  "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                  "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                  "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                  "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                },
+              },
+            },
+          },
+          "suggestedParagraphStyleChanges": { # The suggested paragraph style changes to this paragraph, keyed by suggestion ID.
+            "a_key": { # A suggested change to a ParagraphStyle.
+              "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A ParagraphStyle that only includes the changes made in this suggestion. This can be used along with the paragraph_style_suggestion_state to see which fields have changed and their new values.
+                "alignment": "A String", # The text alignment for this paragraph.
+                "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent.
+                "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                  "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                      "rgbColor": { # An RGB color. # The RGB color value.
+                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                      },
+                    },
+                  },
+                  "dashStyle": "A String", # The dash style of the border.
+                  "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                },
+                "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                  "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                      "rgbColor": { # An RGB color. # The RGB color value.
+                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                      },
+                    },
+                  },
+                  "dashStyle": "A String", # The dash style of the border.
+                  "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                },
+                "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                  "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                      "rgbColor": { # An RGB color. # The RGB color value.
+                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                      },
+                    },
+                  },
+                  "dashStyle": "A String", # The dash style of the border.
+                  "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                },
+                "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                  "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                      "rgbColor": { # An RGB color. # The RGB color value.
+                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                      },
+                    },
+                  },
+                  "dashStyle": "A String", # The dash style of the border.
+                  "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                },
+                "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                  "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                      "rgbColor": { # An RGB color. # The RGB color value.
+                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                      },
+                    },
+                  },
+                  "dashStyle": "A String", # The dash style of the border.
+                  "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                },
+                "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited.
+                "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only.
+                "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent.
+                "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent.
+                "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent.
+                "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated.
+                "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error.
+                "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent.
+                  "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading.
+                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                      "rgbColor": { # An RGB color. # The RGB color value.
+                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                      },
+                    },
+                  },
+                },
+                "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "spacingMode": "A String", # The spacing mode for the paragraph.
+                "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only.
+                  { # A tab stop within a paragraph.
+                    "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START.
+                    "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                  },
+                ],
+              },
+              "paragraphStyleSuggestionState": { # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion.
+                "alignmentSuggested": True or False, # Indicates if there was a suggested change to alignment.
+                "avoidWidowAndOrphanSuggested": True or False, # Indicates if there was a suggested change to avoid_widow_and_orphan.
+                "borderBetweenSuggested": True or False, # Indicates if there was a suggested change to border_between.
+                "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom.
+                "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left.
+                "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right.
+                "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top.
+                "directionSuggested": True or False, # Indicates if there was a suggested change to direction.
+                "headingIdSuggested": True or False, # Indicates if there was a suggested change to heading_id.
+                "indentEndSuggested": True or False, # Indicates if there was a suggested change to indent_end.
+                "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line.
+                "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start.
+                "keepLinesTogetherSuggested": True or False, # Indicates if there was a suggested change to keep_lines_together.
+                "keepWithNextSuggested": True or False, # Indicates if there was a suggested change to keep_with_next.
+                "lineSpacingSuggested": True or False, # Indicates if there was a suggested change to line_spacing.
+                "namedStyleTypeSuggested": True or False, # Indicates if there was a suggested change to named_style_type.
+                "pageBreakBeforeSuggested": True or False, # Indicates if there was a suggested change to page_break_before.
+                "shadingSuggestionState": { # A mask that indicates which of the fields on the base Shading have been changed in this suggested change. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in shading have been changed in this suggestion.
+                  "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to the Shading.
+                },
+                "spaceAboveSuggested": True or False, # Indicates if there was a suggested change to space_above.
+                "spaceBelowSuggested": True or False, # Indicates if there was a suggested change to space_below.
+                "spacingModeSuggested": True or False, # Indicates if there was a suggested change to spacing_mode.
+              },
+            },
+          },
+          "suggestedPositionedObjectIds": { # The IDs of the positioned objects suggested to be attached to this paragraph, keyed by suggestion ID.
+            "a_key": { # A collection of object IDs.
+              "objectIds": [ # The object IDs.
+                "A String",
+              ],
+            },
+          },
+        },
+        "sectionBreak": { # A StructuralElement representing a section break. A section is a range of content that has the same SectionStyle. A section break represents the start of a new section, and the section style applies to the section after the section break. The document body always begins with a section break. # A section break type of structural element.
+          "sectionStyle": { # The styling that applies to a section. # The style of the section after this section break.
+            "columnProperties": [ # The section's columns properties. If empty, the section contains one column with the default properties in the Docs editor. A section can be updated to have no more than 3 columns. When updating this property, setting a concrete value is required. Unsetting this property will result in a 400 bad request error.
+              { # Properties that apply to a section's column.
+                "paddingEnd": { # A magnitude in a single direction in the specified units. # The padding at the end of the column.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "width": { # A magnitude in a single direction in the specified units. # Output only. The width of the column.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+              },
+            ],
+            "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+            "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+            "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only.
+            "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only.
+            "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only.
+            "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only.
+            "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only.
+            "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only.
+            "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+            "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+              "magnitude": 3.14, # The magnitude.
+              "unit": "A String", # The units for magnitude.
+            },
+            "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+              "magnitude": 3.14, # The magnitude.
+              "unit": "A String", # The units for magnitude.
+            },
+            "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+              "magnitude": 3.14, # The magnitude.
+              "unit": "A String", # The units for magnitude.
+            },
+            "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+              "magnitude": 3.14, # The magnitude.
+              "unit": "A String", # The units for magnitude.
+            },
+            "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+              "magnitude": 3.14, # The magnitude.
+              "unit": "A String", # The units for magnitude.
+            },
+            "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+              "magnitude": 3.14, # The magnitude.
+              "unit": "A String", # The units for magnitude.
+            },
+            "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+            "sectionType": "A String", # Output only. The type of section.
+            "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+          },
+          "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+            "A String",
+          ],
+          "suggestedInsertionIds": [ # The suggested insertion IDs. A SectionBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+            "A String",
+          ],
+        },
+        "startIndex": 42, # The zero-based start index of this structural element, in UTF-16 code units.
+        "table": { # A StructuralElement representing a table. # A table type of structural element.
+          "columns": 42, # Number of columns in the table. It's possible for a table to be non-rectangular, so some rows may have a different number of cells.
+          "rows": 42, # Number of rows in the table.
+          "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+            "A String",
+          ],
+          "suggestedInsertionIds": [ # The suggested insertion IDs. A Table may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+            "A String",
+          ],
+          "tableRows": [ # The contents and style of each row.
+            { # The contents and style of a row in a Table.
+              "endIndex": 42, # The zero-based end index of this row, exclusive, in UTF-16 code units.
+              "startIndex": 42, # The zero-based start index of this row, in UTF-16 code units.
+              "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                "A String",
+              ],
+              "suggestedInsertionIds": [ # The suggested insertion IDs. A TableRow may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                "A String",
+              ],
+              "suggestedTableRowStyleChanges": { # The suggested style changes to this row, keyed by suggestion ID.
+                "a_key": { # A suggested change to a TableRowStyle.
+                  "tableRowStyle": { # Styles that apply to a table row. # A TableRowStyle that only includes the changes made in this suggestion. This can be used along with the table_row_style_suggestion_state to see which fields have changed and their new values.
+                    "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries.
+                    "tableHeader": True or False, # Whether the row is a table header.
+                  },
+                  "tableRowStyleSuggestionState": { # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion.
+                    "minRowHeightSuggested": True or False, # Indicates if there was a suggested change to min_row_height.
+                  },
+                },
+              },
+              "tableCells": [ # The contents and style of each cell in this row. It's possible for a table to be non-rectangular, so some rows may have a different number of cells than other rows in the same table.
+                { # The contents and style of a cell in a Table.
+                  "content": [ # The content of the cell.
+                    # Object with schema name: StructuralElement
+                  ],
+                  "endIndex": 42, # The zero-based end index of this cell, exclusive, in UTF-16 code units.
+                  "startIndex": 42, # The zero-based start index of this cell, in UTF-16 code units.
+                  "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # The suggested insertion IDs. A TableCell may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                    "A String",
+                  ],
+                  "suggestedTableCellStyleChanges": { # The suggested changes to the table cell style, keyed by suggestion ID.
+                    "a_key": { # A suggested change to a TableCellStyle.
+                      "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # A TableCellStyle that only includes the changes made in this suggestion. This can be used along with the table_cell_style_suggestion_state to see which fields have changed and their new values.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell.
+                          "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "dashStyle": "A String", # The dash style of the border.
+                          "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                        },
+                        "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell.
+                          "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "dashStyle": "A String", # The dash style of the border.
+                          "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                        },
+                        "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell.
+                          "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "dashStyle": "A String", # The dash style of the border.
+                          "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                        },
+                        "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell.
+                          "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "dashStyle": "A String", # The dash style of the border.
+                          "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                        },
+                        "columnSpan": 42, # The column span of the cell. This property is read-only.
+                        "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor.
+                        "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "rowSpan": 42, # The row span of the cell. This property is read-only.
+                      },
+                      "tableCellStyleSuggestionState": { # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion.
+                        "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                        "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom.
+                        "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left.
+                        "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right.
+                        "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top.
+                        "columnSpanSuggested": True or False, # Indicates if there was a suggested change to column_span.
+                        "contentAlignmentSuggested": True or False, # Indicates if there was a suggested change to content_alignment.
+                        "paddingBottomSuggested": True or False, # Indicates if there was a suggested change to padding_bottom.
+                        "paddingLeftSuggested": True or False, # Indicates if there was a suggested change to padding_left.
+                        "paddingRightSuggested": True or False, # Indicates if there was a suggested change to padding_right.
+                        "paddingTopSuggested": True or False, # Indicates if there was a suggested change to padding_top.
+                        "rowSpanSuggested": True or False, # Indicates if there was a suggested change to row_span.
+                      },
+                    },
+                  },
+                  "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # The style of the cell.
+                    "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell.
+                      "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "dashStyle": "A String", # The dash style of the border.
+                      "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                    },
+                    "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell.
+                      "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "dashStyle": "A String", # The dash style of the border.
+                      "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                    },
+                    "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell.
+                      "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "dashStyle": "A String", # The dash style of the border.
+                      "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                    },
+                    "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell.
+                      "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "dashStyle": "A String", # The dash style of the border.
+                      "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                    },
+                    "columnSpan": 42, # The column span of the cell. This property is read-only.
+                    "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor.
+                    "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "rowSpan": 42, # The row span of the cell. This property is read-only.
+                  },
+                },
+              ],
+              "tableRowStyle": { # Styles that apply to a table row. # The style of the table row.
+                "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries.
+                "tableHeader": True or False, # Whether the row is a table header.
+              },
+            },
+          ],
+          "tableStyle": { # Styles that apply to a table. # The style of the table.
+            "tableColumnProperties": [ # The properties of each column. Note that in Docs, tables contain rows and rows contain cells, similar to HTML. So the properties for a row can be found on the row's table_row_style.
+              { # The properties of a column in a table.
+                "width": { # A magnitude in a single direction in the specified units. # The width of the column. Set when the column's `width_type` is FIXED_WIDTH.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "widthType": "A String", # The width type of the column.
+              },
+            ],
+          },
+        },
+        "tableOfContents": { # A StructuralElement representing a table of contents. # A table of contents type of structural element.
+          "content": [ # The content of the table of contents.
+            # Object with schema name: StructuralElement
+          ],
+          "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+            "A String",
+          ],
+          "suggestedInsertionIds": [ # The suggested insertion IDs. A TableOfContents may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion.
+            "A String",
+          ],
+        },
+      },
+    ],
+  },
+  "documentId": "A String", # Output only. The ID of the document.
+  "documentStyle": { # The style of the document. # Output only. The style of the document.
+    "background": { # Represents the background of a document. # The background of the document. Documents cannot have a transparent background color.
+      "color": { # A color that can either be fully opaque or fully transparent. # The background color.
+        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+          "rgbColor": { # An RGB color. # The RGB color value.
+            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+          },
+        },
+      },
+    },
+    "defaultFooterId": "A String", # The ID of the default footer. If not set, there's no default footer. This property is read-only.
+    "defaultHeaderId": "A String", # The ID of the default header. If not set, there's no default header. This property is read-only.
+    "evenPageFooterId": "A String", # The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. This property is read-only.
+    "evenPageHeaderId": "A String", # The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. This property is read-only.
+    "firstPageFooterId": "A String", # The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. This property is read-only.
+    "firstPageHeaderId": "A String", # The ID of the header used only for the first page. If not set then a unique header for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_header_id or this value for the header on the first page. If not set, there's no first page header. This property is read-only.
+    "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of the page_size, which allows changing the page orientation between portrait and landscape.
+    "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin. Updating the bottom page margin on the document style clears the bottom page margin on all section styles.
+      "magnitude": 3.14, # The magnitude.
+      "unit": "A String", # The units for magnitude.
+    },
+    "marginFooter": { # A magnitude in a single direction in the specified units. # The amount of space between the bottom of the page and the contents of the footer.
+      "magnitude": 3.14, # The magnitude.
+      "unit": "A String", # The units for magnitude.
+    },
+    "marginHeader": { # A magnitude in a single direction in the specified units. # The amount of space between the top of the page and the contents of the header.
+      "magnitude": 3.14, # The magnitude.
+      "unit": "A String", # The units for magnitude.
+    },
+    "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin. Updating the left page margin on the document style clears the left page margin on all section styles. It may also cause columns to resize in all sections.
+      "magnitude": 3.14, # The magnitude.
+      "unit": "A String", # The units for magnitude.
+    },
+    "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin. Updating the right page margin on the document style clears the right page margin on all section styles. It may also cause columns to resize in all sections.
+      "magnitude": 3.14, # The magnitude.
+      "unit": "A String", # The units for magnitude.
+    },
+    "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin. Updating the top page margin on the document style clears the top page margin on all section styles.
+      "magnitude": 3.14, # The magnitude.
+      "unit": "A String", # The units for magnitude.
+    },
+    "pageNumberStart": 42, # The page number from which to start counting the number of pages.
+    "pageSize": { # A width and height. # The size of a page in the document.
+      "height": { # A magnitude in a single direction in the specified units. # The height of the object.
+        "magnitude": 3.14, # The magnitude.
+        "unit": "A String", # The units for magnitude.
+      },
+      "width": { # A magnitude in a single direction in the specified units. # The width of the object.
+        "magnitude": 3.14, # The magnitude.
+        "unit": "A String", # The units for magnitude.
+      },
+    },
+    "useCustomHeaderFooterMargins": True or False, # Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected. When false, the default values in the Docs editor for header and footer margin are used. This property is read-only.
+    "useEvenPageHeaderFooter": True or False, # Indicates whether to use the even page header / footer IDs for the even pages.
+    "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page.
+  },
+  "footers": { # Output only. The footers in the document, keyed by footer ID.
+    "a_key": { # A document footer.
+      "content": [ # The contents of the footer. The indexes for a footer's content begin at zero.
+        { # A StructuralElement describes content that provides structure to the document.
+          "endIndex": 42, # The zero-based end index of this structural element, exclusive, in UTF-16 code units.
+          "paragraph": { # A StructuralElement representing a paragraph. A paragraph is a range of content that's terminated with a newline character. # A paragraph type of structural element.
+            "bullet": { # Describes the bullet of a paragraph. # The bullet for this paragraph. If not present, the paragraph does not belong to a list.
+              "listId": "A String", # The ID of the list this paragraph belongs to.
+              "nestingLevel": 42, # The nesting level of this paragraph in the list.
+              "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet.
+                "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                  "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                    "rgbColor": { # An RGB color. # The RGB color value.
+                      "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                      "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                      "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                    },
+                  },
+                },
+                "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                "bold": True or False, # Whether or not the text is rendered as bold.
+                "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                  "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                    "rgbColor": { # An RGB color. # The RGB color value.
+                      "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                      "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                      "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                    },
+                  },
+                },
+                "italic": True or False, # Whether or not the text is italicized.
+                "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                  "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                    "id": "A String", # The ID of a bookmark in this document.
+                    "tabId": "A String", # The ID of the tab containing this bookmark.
+                  },
+                  "bookmarkId": "A String", # The ID of a bookmark in this document.
+                  "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                    "id": "A String", # The ID of a heading in this document.
+                    "tabId": "A String", # The ID of the tab containing this heading.
+                  },
+                  "headingId": "A String", # The ID of a heading in this document.
+                  "tabId": "A String", # The ID of a tab in this document.
+                  "url": "A String", # An external URL.
+                },
+                "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                "strikethrough": True or False, # Whether or not the text is struck through.
+                "underline": True or False, # Whether or not the text is underlined.
+                "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                  "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                  "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                },
+              },
+            },
+            "elements": [ # The content of the paragraph, broken down into its component parts.
+              { # A ParagraphElement describes content within a Paragraph.
+                "autoText": { # A ParagraphElement representing a spot in the text that's dynamically replaced with content that can change over time, like a page number. # An auto text paragraph element.
+                  "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # The suggested insertion IDs. An AutoText may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                    "A String",
+                  ],
+                  "suggestedTextStyleChanges": { # The suggested text style changes to this AutoText, keyed by suggestion ID.
+                    "a_key": { # A suggested change to a TextStyle.
+                      "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                        "bold": True or False, # Whether or not the text is rendered as bold.
+                        "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "italic": True or False, # Whether or not the text is italicized.
+                        "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                          "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a bookmark in this document.
+                            "tabId": "A String", # The ID of the tab containing this bookmark.
+                          },
+                          "bookmarkId": "A String", # The ID of a bookmark in this document.
+                          "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of the tab containing this heading.
+                          },
+                          "headingId": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of a tab in this document.
+                          "url": "A String", # An external URL.
+                        },
+                        "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                        "strikethrough": True or False, # Whether or not the text is struck through.
+                        "underline": True or False, # Whether or not the text is underlined.
+                        "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                          "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                          "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                        },
+                      },
+                      "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                        "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                        "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                        "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                        "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                        "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                        "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                        "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                        "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                        "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                        "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                        "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                      },
+                    },
+                  },
+                  "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this AutoText.
+                    "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                    "bold": True or False, # Whether or not the text is rendered as bold.
+                    "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "italic": True or False, # Whether or not the text is italicized.
+                    "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                      "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a bookmark in this document.
+                        "tabId": "A String", # The ID of the tab containing this bookmark.
+                      },
+                      "bookmarkId": "A String", # The ID of a bookmark in this document.
+                      "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of the tab containing this heading.
+                      },
+                      "headingId": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of a tab in this document.
+                      "url": "A String", # An external URL.
+                    },
+                    "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                    "strikethrough": True or False, # Whether or not the text is struck through.
+                    "underline": True or False, # Whether or not the text is underlined.
+                    "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                      "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                      "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                    },
+                  },
+                  "type": "A String", # The type of this auto text.
+                },
+                "columnBreak": { # A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column. # A column break paragraph element.
+                  "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                    "A String",
+                  ],
+                  "suggestedTextStyleChanges": { # The suggested text style changes to this ColumnBreak, keyed by suggestion ID.
+                    "a_key": { # A suggested change to a TextStyle.
+                      "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                        "bold": True or False, # Whether or not the text is rendered as bold.
+                        "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "italic": True or False, # Whether or not the text is italicized.
+                        "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                          "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a bookmark in this document.
+                            "tabId": "A String", # The ID of the tab containing this bookmark.
+                          },
+                          "bookmarkId": "A String", # The ID of a bookmark in this document.
+                          "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of the tab containing this heading.
+                          },
+                          "headingId": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of a tab in this document.
+                          "url": "A String", # An external URL.
+                        },
+                        "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                        "strikethrough": True or False, # Whether or not the text is struck through.
+                        "underline": True or False, # Whether or not the text is underlined.
+                        "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                          "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                          "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                        },
+                      },
+                      "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                        "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                        "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                        "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                        "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                        "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                        "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                        "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                        "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                        "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                        "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                        "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                      },
+                    },
+                  },
+                  "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it.
+                    "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                    "bold": True or False, # Whether or not the text is rendered as bold.
+                    "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "italic": True or False, # Whether or not the text is italicized.
+                    "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                      "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a bookmark in this document.
+                        "tabId": "A String", # The ID of the tab containing this bookmark.
+                      },
+                      "bookmarkId": "A String", # The ID of a bookmark in this document.
+                      "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of the tab containing this heading.
+                      },
+                      "headingId": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of a tab in this document.
+                      "url": "A String", # An external URL.
+                    },
+                    "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                    "strikethrough": True or False, # Whether or not the text is struck through.
+                    "underline": True or False, # Whether or not the text is underlined.
+                    "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                      "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                      "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                    },
+                  },
+                },
+                "endIndex": 42, # The zero-base end index of this paragraph element, exclusive, in UTF-16 code units.
+                "equation": { # A ParagraphElement representing an equation. # An equation paragraph element.
+                  "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # The suggested insertion IDs. An Equation may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                    "A String",
+                  ],
+                },
+                "footnoteReference": { # A ParagraphElement representing a footnote reference. A footnote reference is the inline content rendered with a number and is used to identify the footnote. # A footnote reference paragraph element.
+                  "footnoteId": "A String", # The ID of the footnote that contains the content of this footnote reference.
+                  "footnoteNumber": "A String", # The rendered number of this footnote.
+                  "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                    "A String",
+                  ],
+                  "suggestedTextStyleChanges": { # The suggested text style changes to this FootnoteReference, keyed by suggestion ID.
+                    "a_key": { # A suggested change to a TextStyle.
+                      "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                        "bold": True or False, # Whether or not the text is rendered as bold.
+                        "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "italic": True or False, # Whether or not the text is italicized.
+                        "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                          "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a bookmark in this document.
+                            "tabId": "A String", # The ID of the tab containing this bookmark.
+                          },
+                          "bookmarkId": "A String", # The ID of a bookmark in this document.
+                          "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of the tab containing this heading.
+                          },
+                          "headingId": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of a tab in this document.
+                          "url": "A String", # An external URL.
+                        },
+                        "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                        "strikethrough": True or False, # Whether or not the text is struck through.
+                        "underline": True or False, # Whether or not the text is underlined.
+                        "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                          "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                          "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                        },
+                      },
+                      "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                        "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                        "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                        "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                        "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                        "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                        "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                        "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                        "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                        "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                        "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                        "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                      },
+                    },
+                  },
+                  "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this FootnoteReference.
+                    "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                    "bold": True or False, # Whether or not the text is rendered as bold.
+                    "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "italic": True or False, # Whether or not the text is italicized.
+                    "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                      "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a bookmark in this document.
+                        "tabId": "A String", # The ID of the tab containing this bookmark.
+                      },
+                      "bookmarkId": "A String", # The ID of a bookmark in this document.
+                      "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of the tab containing this heading.
+                      },
+                      "headingId": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of a tab in this document.
+                      "url": "A String", # An external URL.
+                    },
+                    "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                    "strikethrough": True or False, # Whether or not the text is struck through.
+                    "underline": True or False, # Whether or not the text is underlined.
+                    "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                      "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                      "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                    },
+                  },
+                },
+                "horizontalRule": { # A ParagraphElement representing a horizontal line. # A horizontal rule paragraph element.
+                  "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # The suggested insertion IDs. A HorizontalRule may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion.
+                    "A String",
+                  ],
+                  "suggestedTextStyleChanges": { # The suggested text style changes to this HorizontalRule, keyed by suggestion ID.
+                    "a_key": { # A suggested change to a TextStyle.
+                      "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                        "bold": True or False, # Whether or not the text is rendered as bold.
+                        "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "italic": True or False, # Whether or not the text is italicized.
+                        "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                          "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a bookmark in this document.
+                            "tabId": "A String", # The ID of the tab containing this bookmark.
+                          },
+                          "bookmarkId": "A String", # The ID of a bookmark in this document.
+                          "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of the tab containing this heading.
+                          },
+                          "headingId": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of a tab in this document.
+                          "url": "A String", # An external URL.
+                        },
+                        "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                        "strikethrough": True or False, # Whether or not the text is struck through.
+                        "underline": True or False, # Whether or not the text is underlined.
+                        "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                          "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                          "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                        },
+                      },
+                      "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                        "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                        "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                        "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                        "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                        "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                        "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                        "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                        "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                        "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                        "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                        "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                      },
+                    },
+                  },
+                  "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this HorizontalRule. Similar to text content, like text runs and footnote references, the text style of a horizontal rule can affect content layout as well as the styling of text inserted next to it.
+                    "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                    "bold": True or False, # Whether or not the text is rendered as bold.
+                    "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "italic": True or False, # Whether or not the text is italicized.
+                    "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                      "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a bookmark in this document.
+                        "tabId": "A String", # The ID of the tab containing this bookmark.
+                      },
+                      "bookmarkId": "A String", # The ID of a bookmark in this document.
+                      "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of the tab containing this heading.
+                      },
+                      "headingId": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of a tab in this document.
+                      "url": "A String", # An external URL.
+                    },
+                    "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                    "strikethrough": True or False, # Whether or not the text is struck through.
+                    "underline": True or False, # Whether or not the text is underlined.
+                    "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                      "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                      "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                    },
+                  },
+                },
+                "inlineObjectElement": { # A ParagraphElement that contains an InlineObject. # An inline object paragraph element.
+                  "inlineObjectId": "A String", # The ID of the InlineObject this element contains.
+                  "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # The suggested insertion IDs. An InlineObjectElement may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                    "A String",
+                  ],
+                  "suggestedTextStyleChanges": { # The suggested text style changes to this InlineObject, keyed by suggestion ID.
+                    "a_key": { # A suggested change to a TextStyle.
+                      "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                        "bold": True or False, # Whether or not the text is rendered as bold.
+                        "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "italic": True or False, # Whether or not the text is italicized.
+                        "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                          "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a bookmark in this document.
+                            "tabId": "A String", # The ID of the tab containing this bookmark.
+                          },
+                          "bookmarkId": "A String", # The ID of a bookmark in this document.
+                          "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of the tab containing this heading.
+                          },
+                          "headingId": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of a tab in this document.
+                          "url": "A String", # An external URL.
+                        },
+                        "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                        "strikethrough": True or False, # Whether or not the text is struck through.
+                        "underline": True or False, # Whether or not the text is underlined.
+                        "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                          "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                          "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                        },
+                      },
+                      "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                        "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                        "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                        "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                        "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                        "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                        "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                        "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                        "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                        "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                        "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                        "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                      },
+                    },
+                  },
+                  "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this InlineObjectElement. Similar to text content, like text runs and footnote references, the text style of an inline object element can affect content layout as well as the styling of text inserted next to it.
+                    "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                    "bold": True or False, # Whether or not the text is rendered as bold.
+                    "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "italic": True or False, # Whether or not the text is italicized.
+                    "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                      "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a bookmark in this document.
+                        "tabId": "A String", # The ID of the tab containing this bookmark.
+                      },
+                      "bookmarkId": "A String", # The ID of a bookmark in this document.
+                      "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of the tab containing this heading.
+                      },
+                      "headingId": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of a tab in this document.
+                      "url": "A String", # An external URL.
+                    },
+                    "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                    "strikethrough": True or False, # Whether or not the text is struck through.
+                    "underline": True or False, # Whether or not the text is underlined.
+                    "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                      "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                      "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                    },
+                  },
+                },
+                "pageBreak": { # A ParagraphElement representing a page break. A page break makes the subsequent text start at the top of the next page. # A page break paragraph element.
+                  "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # The suggested insertion IDs. A PageBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                    "A String",
+                  ],
+                  "suggestedTextStyleChanges": { # The suggested text style changes to this PageBreak, keyed by suggestion ID.
+                    "a_key": { # A suggested change to a TextStyle.
+                      "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                        "bold": True or False, # Whether or not the text is rendered as bold.
+                        "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "italic": True or False, # Whether or not the text is italicized.
+                        "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                          "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a bookmark in this document.
+                            "tabId": "A String", # The ID of the tab containing this bookmark.
+                          },
+                          "bookmarkId": "A String", # The ID of a bookmark in this document.
+                          "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of the tab containing this heading.
+                          },
+                          "headingId": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of a tab in this document.
+                          "url": "A String", # An external URL.
+                        },
+                        "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                        "strikethrough": True or False, # Whether or not the text is struck through.
+                        "underline": True or False, # Whether or not the text is underlined.
+                        "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                          "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                          "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                        },
+                      },
+                      "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                        "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                        "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                        "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                        "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                        "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                        "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                        "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                        "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                        "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                        "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                        "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                      },
+                    },
+                  },
+                  "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this PageBreak. Similar to text content, like text runs and footnote references, the text style of a page break can affect content layout as well as the styling of text inserted next to it.
+                    "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                    "bold": True or False, # Whether or not the text is rendered as bold.
+                    "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "italic": True or False, # Whether or not the text is italicized.
+                    "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                      "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a bookmark in this document.
+                        "tabId": "A String", # The ID of the tab containing this bookmark.
+                      },
+                      "bookmarkId": "A String", # The ID of a bookmark in this document.
+                      "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of the tab containing this heading.
+                      },
+                      "headingId": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of a tab in this document.
+                      "url": "A String", # An external URL.
+                    },
+                    "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                    "strikethrough": True or False, # Whether or not the text is struck through.
+                    "underline": True or False, # Whether or not the text is underlined.
+                    "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                      "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                      "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                    },
+                  },
+                },
+                "person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address.
+                  "personId": "A String", # Output only. The unique ID of this link.
+                  "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present.
+                    "email": "A String", # Output only. The email address linked to this Person. This field is always present.
+                    "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address.
+                  },
+                  "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # IDs for suggestions that insert this person link into the document. A Person might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion.
+                    "A String",
+                  ],
+                  "suggestedTextStyleChanges": { # The suggested text style changes to this Person, keyed by suggestion ID.
+                    "a_key": { # A suggested change to a TextStyle.
+                      "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                        "bold": True or False, # Whether or not the text is rendered as bold.
+                        "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "italic": True or False, # Whether or not the text is italicized.
+                        "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                          "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a bookmark in this document.
+                            "tabId": "A String", # The ID of the tab containing this bookmark.
+                          },
+                          "bookmarkId": "A String", # The ID of a bookmark in this document.
+                          "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of the tab containing this heading.
+                          },
+                          "headingId": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of a tab in this document.
+                          "url": "A String", # An external URL.
+                        },
+                        "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                        "strikethrough": True or False, # Whether or not the text is struck through.
+                        "underline": True or False, # Whether or not the text is underlined.
+                        "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                          "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                          "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                        },
+                      },
+                      "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                        "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                        "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                        "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                        "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                        "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                        "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                        "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                        "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                        "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                        "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                        "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                      },
+                    },
+                  },
+                  "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this Person.
+                    "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                    "bold": True or False, # Whether or not the text is rendered as bold.
+                    "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "italic": True or False, # Whether or not the text is italicized.
+                    "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                      "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a bookmark in this document.
+                        "tabId": "A String", # The ID of the tab containing this bookmark.
+                      },
+                      "bookmarkId": "A String", # The ID of a bookmark in this document.
+                      "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of the tab containing this heading.
+                      },
+                      "headingId": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of a tab in this document.
+                      "url": "A String", # An external URL.
+                    },
+                    "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                    "strikethrough": True or False, # Whether or not the text is struck through.
+                    "underline": True or False, # Whether or not the text is underlined.
+                    "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                      "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                      "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                    },
+                  },
+                },
+                "richLink": { # A link to a Google resource (such as a file in Drive, a YouTube video, or a Calendar event). # A paragraph element that links to a Google resource (such as a file in Google Drive, a YouTube video, or a Calendar event.)
+                  "richLinkId": "A String", # Output only. The ID of this link.
+                  "richLinkProperties": { # Properties specific to a RichLink. # Output only. The properties of this RichLink. This field is always present.
+                    "mimeType": "A String", # Output only. The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the RichLink, if there's one (for example, when it's a file in Drive).
+                    "title": "A String", # Output only. The title of the RichLink as displayed in the link. This title matches the title of the linked resource at the time of the insertion or last update of the link. This field is always present.
+                    "uri": "A String", # Output only. The URI to the RichLink. This is always present.
+                  },
+                  "suggestedDeletionIds": [ # IDs for suggestions that remove this link from the document. A RichLink might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # IDs for suggestions that insert this link into the document. A RichLink might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion.
+                    "A String",
+                  ],
+                  "suggestedTextStyleChanges": { # The suggested text style changes to this RichLink, keyed by suggestion ID.
+                    "a_key": { # A suggested change to a TextStyle.
+                      "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                        "bold": True or False, # Whether or not the text is rendered as bold.
+                        "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "italic": True or False, # Whether or not the text is italicized.
+                        "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                          "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a bookmark in this document.
+                            "tabId": "A String", # The ID of the tab containing this bookmark.
+                          },
+                          "bookmarkId": "A String", # The ID of a bookmark in this document.
+                          "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of the tab containing this heading.
+                          },
+                          "headingId": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of a tab in this document.
+                          "url": "A String", # An external URL.
+                        },
+                        "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                        "strikethrough": True or False, # Whether or not the text is struck through.
+                        "underline": True or False, # Whether or not the text is underlined.
+                        "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                          "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                          "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                        },
+                      },
+                      "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                        "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                        "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                        "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                        "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                        "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                        "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                        "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                        "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                        "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                        "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                        "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                      },
+                    },
+                  },
+                  "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this RichLink.
+                    "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                    "bold": True or False, # Whether or not the text is rendered as bold.
+                    "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "italic": True or False, # Whether or not the text is italicized.
+                    "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                      "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a bookmark in this document.
+                        "tabId": "A String", # The ID of the tab containing this bookmark.
+                      },
+                      "bookmarkId": "A String", # The ID of a bookmark in this document.
+                      "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of the tab containing this heading.
+                      },
+                      "headingId": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of a tab in this document.
+                      "url": "A String", # An external URL.
+                    },
+                    "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                    "strikethrough": True or False, # Whether or not the text is struck through.
+                    "underline": True or False, # Whether or not the text is underlined.
+                    "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                      "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                      "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                    },
+                  },
+                },
+                "startIndex": 42, # The zero-based start index of this paragraph element, in UTF-16 code units.
+                "textRun": { # A ParagraphElement that represents a run of text that all has the same styling. # A text run paragraph element.
+                  "content": "A String", # The text of this run. Any non-text elements in the run are replaced with the Unicode character U+E907.
+                  "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # The suggested insertion IDs. A TextRun may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                    "A String",
+                  ],
+                  "suggestedTextStyleChanges": { # The suggested text style changes to this run, keyed by suggestion ID.
+                    "a_key": { # A suggested change to a TextStyle.
+                      "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                        "bold": True or False, # Whether or not the text is rendered as bold.
+                        "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "italic": True or False, # Whether or not the text is italicized.
+                        "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                          "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a bookmark in this document.
+                            "tabId": "A String", # The ID of the tab containing this bookmark.
+                          },
+                          "bookmarkId": "A String", # The ID of a bookmark in this document.
+                          "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of the tab containing this heading.
+                          },
+                          "headingId": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of a tab in this document.
+                          "url": "A String", # An external URL.
+                        },
+                        "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                        "strikethrough": True or False, # Whether or not the text is struck through.
+                        "underline": True or False, # Whether or not the text is underlined.
+                        "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                          "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                          "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                        },
+                      },
+                      "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                        "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                        "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                        "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                        "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                        "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                        "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                        "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                        "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                        "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                        "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                        "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                      },
+                    },
+                  },
+                  "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this run.
+                    "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                    "bold": True or False, # Whether or not the text is rendered as bold.
+                    "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "italic": True or False, # Whether or not the text is italicized.
+                    "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                      "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a bookmark in this document.
+                        "tabId": "A String", # The ID of the tab containing this bookmark.
+                      },
+                      "bookmarkId": "A String", # The ID of a bookmark in this document.
+                      "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of the tab containing this heading.
+                      },
+                      "headingId": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of a tab in this document.
+                      "url": "A String", # An external URL.
+                    },
+                    "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                    "strikethrough": True or False, # Whether or not the text is struck through.
+                    "underline": True or False, # Whether or not the text is underlined.
+                    "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                      "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                      "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                    },
+                  },
+                },
+              },
+            ],
+            "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The style of this paragraph.
+              "alignment": "A String", # The text alignment for this paragraph.
+              "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent.
+              "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                  "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                    "rgbColor": { # An RGB color. # The RGB color value.
+                      "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                      "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                      "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                    },
+                  },
+                },
+                "dashStyle": "A String", # The dash style of the border.
+                "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+              },
+              "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                  "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                    "rgbColor": { # An RGB color. # The RGB color value.
+                      "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                      "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                      "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                    },
+                  },
+                },
+                "dashStyle": "A String", # The dash style of the border.
+                "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+              },
+              "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                  "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                    "rgbColor": { # An RGB color. # The RGB color value.
+                      "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                      "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                      "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                    },
+                  },
+                },
+                "dashStyle": "A String", # The dash style of the border.
+                "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+              },
+              "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                  "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                    "rgbColor": { # An RGB color. # The RGB color value.
+                      "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                      "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                      "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                    },
+                  },
+                },
+                "dashStyle": "A String", # The dash style of the border.
+                "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+              },
+              "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                  "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                    "rgbColor": { # An RGB color. # The RGB color value.
+                      "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                      "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                      "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                    },
+                  },
+                },
+                "dashStyle": "A String", # The dash style of the border.
+                "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+              },
+              "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited.
+              "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only.
+              "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent.
+              "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent.
+              "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent.
+              "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated.
+              "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error.
+              "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent.
+                "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading.
+                  "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                    "rgbColor": { # An RGB color. # The RGB color value.
+                      "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                      "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                      "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                    },
+                  },
+                },
+              },
+              "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "spacingMode": "A String", # The spacing mode for the paragraph.
+              "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only.
+                { # A tab stop within a paragraph.
+                  "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START.
+                  "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                },
+              ],
+            },
+            "positionedObjectIds": [ # The IDs of the positioned objects tethered to this paragraph.
+              "A String",
+            ],
+            "suggestedBulletChanges": { # The suggested changes to this paragraph's bullet.
+              "a_key": { # A suggested change to a Bullet.
+                "bullet": { # Describes the bullet of a paragraph. # A Bullet that only includes the changes made in this suggestion. This can be used along with the bullet_suggestion_state to see which fields have changed and their new values.
+                  "listId": "A String", # The ID of the list this paragraph belongs to.
+                  "nestingLevel": 42, # The nesting level of this paragraph in the list.
+                  "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet.
+                    "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                    "bold": True or False, # Whether or not the text is rendered as bold.
+                    "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "italic": True or False, # Whether or not the text is italicized.
+                    "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                      "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a bookmark in this document.
+                        "tabId": "A String", # The ID of the tab containing this bookmark.
+                      },
+                      "bookmarkId": "A String", # The ID of a bookmark in this document.
+                      "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of the tab containing this heading.
+                      },
+                      "headingId": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of a tab in this document.
+                      "url": "A String", # An external URL.
+                    },
+                    "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                    "strikethrough": True or False, # Whether or not the text is struck through.
+                    "underline": True or False, # Whether or not the text is underlined.
+                    "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                      "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                      "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                    },
+                  },
+                },
+                "bulletSuggestionState": { # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion.
+                  "listIdSuggested": True or False, # Indicates if there was a suggested change to the list_id.
+                  "nestingLevelSuggested": True or False, # Indicates if there was a suggested change to the nesting_level.
+                  "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion.
+                    "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                    "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                    "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                    "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                    "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                    "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                    "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                    "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                    "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                    "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                    "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                  },
+                },
+              },
+            },
+            "suggestedParagraphStyleChanges": { # The suggested paragraph style changes to this paragraph, keyed by suggestion ID.
+              "a_key": { # A suggested change to a ParagraphStyle.
+                "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A ParagraphStyle that only includes the changes made in this suggestion. This can be used along with the paragraph_style_suggestion_state to see which fields have changed and their new values.
+                  "alignment": "A String", # The text alignment for this paragraph.
+                  "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent.
+                  "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                    "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "dashStyle": "A String", # The dash style of the border.
+                    "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                  },
+                  "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                    "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "dashStyle": "A String", # The dash style of the border.
+                    "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                  },
+                  "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                    "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "dashStyle": "A String", # The dash style of the border.
+                    "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                  },
+                  "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                    "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "dashStyle": "A String", # The dash style of the border.
+                    "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                  },
+                  "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                    "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "dashStyle": "A String", # The dash style of the border.
+                    "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                  },
+                  "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited.
+                  "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only.
+                  "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent.
+                  "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent.
+                  "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent.
+                  "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated.
+                  "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error.
+                  "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent.
+                    "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                  },
+                  "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "spacingMode": "A String", # The spacing mode for the paragraph.
+                  "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only.
+                    { # A tab stop within a paragraph.
+                      "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START.
+                      "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                    },
+                  ],
+                },
+                "paragraphStyleSuggestionState": { # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion.
+                  "alignmentSuggested": True or False, # Indicates if there was a suggested change to alignment.
+                  "avoidWidowAndOrphanSuggested": True or False, # Indicates if there was a suggested change to avoid_widow_and_orphan.
+                  "borderBetweenSuggested": True or False, # Indicates if there was a suggested change to border_between.
+                  "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom.
+                  "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left.
+                  "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right.
+                  "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top.
+                  "directionSuggested": True or False, # Indicates if there was a suggested change to direction.
+                  "headingIdSuggested": True or False, # Indicates if there was a suggested change to heading_id.
+                  "indentEndSuggested": True or False, # Indicates if there was a suggested change to indent_end.
+                  "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line.
+                  "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start.
+                  "keepLinesTogetherSuggested": True or False, # Indicates if there was a suggested change to keep_lines_together.
+                  "keepWithNextSuggested": True or False, # Indicates if there was a suggested change to keep_with_next.
+                  "lineSpacingSuggested": True or False, # Indicates if there was a suggested change to line_spacing.
+                  "namedStyleTypeSuggested": True or False, # Indicates if there was a suggested change to named_style_type.
+                  "pageBreakBeforeSuggested": True or False, # Indicates if there was a suggested change to page_break_before.
+                  "shadingSuggestionState": { # A mask that indicates which of the fields on the base Shading have been changed in this suggested change. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in shading have been changed in this suggestion.
+                    "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to the Shading.
+                  },
+                  "spaceAboveSuggested": True or False, # Indicates if there was a suggested change to space_above.
+                  "spaceBelowSuggested": True or False, # Indicates if there was a suggested change to space_below.
+                  "spacingModeSuggested": True or False, # Indicates if there was a suggested change to spacing_mode.
+                },
+              },
+            },
+            "suggestedPositionedObjectIds": { # The IDs of the positioned objects suggested to be attached to this paragraph, keyed by suggestion ID.
+              "a_key": { # A collection of object IDs.
+                "objectIds": [ # The object IDs.
+                  "A String",
+                ],
+              },
+            },
+          },
+          "sectionBreak": { # A StructuralElement representing a section break. A section is a range of content that has the same SectionStyle. A section break represents the start of a new section, and the section style applies to the section after the section break. The document body always begins with a section break. # A section break type of structural element.
+            "sectionStyle": { # The styling that applies to a section. # The style of the section after this section break.
+              "columnProperties": [ # The section's columns properties. If empty, the section contains one column with the default properties in the Docs editor. A section can be updated to have no more than 3 columns. When updating this property, setting a concrete value is required. Unsetting this property will result in a 400 bad request error.
+                { # Properties that apply to a section's column.
+                  "paddingEnd": { # A magnitude in a single direction in the specified units. # The padding at the end of the column.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "width": { # A magnitude in a single direction in the specified units. # Output only. The width of the column.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                },
+              ],
+              "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+              "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+              "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only.
+              "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only.
+              "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only.
+              "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only.
+              "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only.
+              "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only.
+              "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+              "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+              "sectionType": "A String", # Output only. The type of section.
+              "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+            },
+            "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+              "A String",
+            ],
+            "suggestedInsertionIds": [ # The suggested insertion IDs. A SectionBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+              "A String",
+            ],
+          },
+          "startIndex": 42, # The zero-based start index of this structural element, in UTF-16 code units.
+          "table": { # A StructuralElement representing a table. # A table type of structural element.
+            "columns": 42, # Number of columns in the table. It's possible for a table to be non-rectangular, so some rows may have a different number of cells.
+            "rows": 42, # Number of rows in the table.
+            "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+              "A String",
+            ],
+            "suggestedInsertionIds": [ # The suggested insertion IDs. A Table may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+              "A String",
+            ],
+            "tableRows": [ # The contents and style of each row.
+              { # The contents and style of a row in a Table.
+                "endIndex": 42, # The zero-based end index of this row, exclusive, in UTF-16 code units.
+                "startIndex": 42, # The zero-based start index of this row, in UTF-16 code units.
+                "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                  "A String",
+                ],
+                "suggestedInsertionIds": [ # The suggested insertion IDs. A TableRow may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                  "A String",
+                ],
+                "suggestedTableRowStyleChanges": { # The suggested style changes to this row, keyed by suggestion ID.
+                  "a_key": { # A suggested change to a TableRowStyle.
+                    "tableRowStyle": { # Styles that apply to a table row. # A TableRowStyle that only includes the changes made in this suggestion. This can be used along with the table_row_style_suggestion_state to see which fields have changed and their new values.
+                      "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries.
+                      "tableHeader": True or False, # Whether the row is a table header.
+                    },
+                    "tableRowStyleSuggestionState": { # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion.
+                      "minRowHeightSuggested": True or False, # Indicates if there was a suggested change to min_row_height.
+                    },
+                  },
+                },
+                "tableCells": [ # The contents and style of each cell in this row. It's possible for a table to be non-rectangular, so some rows may have a different number of cells than other rows in the same table.
+                  { # The contents and style of a cell in a Table.
+                    "content": [ # The content of the cell.
+                      # Object with schema name: StructuralElement
+                    ],
+                    "endIndex": 42, # The zero-based end index of this cell, exclusive, in UTF-16 code units.
+                    "startIndex": 42, # The zero-based start index of this cell, in UTF-16 code units.
+                    "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                      "A String",
+                    ],
+                    "suggestedInsertionIds": [ # The suggested insertion IDs. A TableCell may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                      "A String",
+                    ],
+                    "suggestedTableCellStyleChanges": { # The suggested changes to the table cell style, keyed by suggestion ID.
+                      "a_key": { # A suggested change to a TableCellStyle.
+                        "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # A TableCellStyle that only includes the changes made in this suggestion. This can be used along with the table_cell_style_suggestion_state to see which fields have changed and their new values.
+                          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell.
+                            "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "dashStyle": "A String", # The dash style of the border.
+                            "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                          },
+                          "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell.
+                            "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "dashStyle": "A String", # The dash style of the border.
+                            "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                          },
+                          "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell.
+                            "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "dashStyle": "A String", # The dash style of the border.
+                            "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                          },
+                          "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell.
+                            "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "dashStyle": "A String", # The dash style of the border.
+                            "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                          },
+                          "columnSpan": 42, # The column span of the cell. This property is read-only.
+                          "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor.
+                          "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "rowSpan": 42, # The row span of the cell. This property is read-only.
+                        },
+                        "tableCellStyleSuggestionState": { # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion.
+                          "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                          "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom.
+                          "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left.
+                          "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right.
+                          "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top.
+                          "columnSpanSuggested": True or False, # Indicates if there was a suggested change to column_span.
+                          "contentAlignmentSuggested": True or False, # Indicates if there was a suggested change to content_alignment.
+                          "paddingBottomSuggested": True or False, # Indicates if there was a suggested change to padding_bottom.
+                          "paddingLeftSuggested": True or False, # Indicates if there was a suggested change to padding_left.
+                          "paddingRightSuggested": True or False, # Indicates if there was a suggested change to padding_right.
+                          "paddingTopSuggested": True or False, # Indicates if there was a suggested change to padding_top.
+                          "rowSpanSuggested": True or False, # Indicates if there was a suggested change to row_span.
+                        },
+                      },
+                    },
+                    "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # The style of the cell.
+                      "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell.
+                        "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "dashStyle": "A String", # The dash style of the border.
+                        "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                      },
+                      "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell.
+                        "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "dashStyle": "A String", # The dash style of the border.
+                        "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                      },
+                      "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell.
+                        "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "dashStyle": "A String", # The dash style of the border.
+                        "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                      },
+                      "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell.
+                        "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "dashStyle": "A String", # The dash style of the border.
+                        "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                      },
+                      "columnSpan": 42, # The column span of the cell. This property is read-only.
+                      "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor.
+                      "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "rowSpan": 42, # The row span of the cell. This property is read-only.
+                    },
+                  },
+                ],
+                "tableRowStyle": { # Styles that apply to a table row. # The style of the table row.
+                  "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries.
+                  "tableHeader": True or False, # Whether the row is a table header.
+                },
+              },
+            ],
+            "tableStyle": { # Styles that apply to a table. # The style of the table.
+              "tableColumnProperties": [ # The properties of each column. Note that in Docs, tables contain rows and rows contain cells, similar to HTML. So the properties for a row can be found on the row's table_row_style.
+                { # The properties of a column in a table.
+                  "width": { # A magnitude in a single direction in the specified units. # The width of the column. Set when the column's `width_type` is FIXED_WIDTH.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "widthType": "A String", # The width type of the column.
+                },
+              ],
+            },
+          },
+          "tableOfContents": { # A StructuralElement representing a table of contents. # A table of contents type of structural element.
+            "content": [ # The content of the table of contents.
+              # Object with schema name: StructuralElement
+            ],
+            "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+              "A String",
+            ],
+            "suggestedInsertionIds": [ # The suggested insertion IDs. A TableOfContents may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion.
+              "A String",
+            ],
+          },
+        },
+      ],
+      "footerId": "A String", # The ID of the footer.
+    },
+  },
+  "footnotes": { # Output only. The footnotes in the document, keyed by footnote ID.
+    "a_key": { # A document footnote.
+      "content": [ # The contents of the footnote. The indexes for a footnote's content begin at zero.
+        { # A StructuralElement describes content that provides structure to the document.
+          "endIndex": 42, # The zero-based end index of this structural element, exclusive, in UTF-16 code units.
+          "paragraph": { # A StructuralElement representing a paragraph. A paragraph is a range of content that's terminated with a newline character. # A paragraph type of structural element.
+            "bullet": { # Describes the bullet of a paragraph. # The bullet for this paragraph. If not present, the paragraph does not belong to a list.
+              "listId": "A String", # The ID of the list this paragraph belongs to.
+              "nestingLevel": 42, # The nesting level of this paragraph in the list.
+              "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet.
+                "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                  "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                    "rgbColor": { # An RGB color. # The RGB color value.
+                      "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                      "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                      "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                    },
+                  },
+                },
+                "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                "bold": True or False, # Whether or not the text is rendered as bold.
+                "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                  "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                    "rgbColor": { # An RGB color. # The RGB color value.
+                      "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                      "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                      "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                    },
+                  },
+                },
+                "italic": True or False, # Whether or not the text is italicized.
+                "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                  "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                    "id": "A String", # The ID of a bookmark in this document.
+                    "tabId": "A String", # The ID of the tab containing this bookmark.
+                  },
+                  "bookmarkId": "A String", # The ID of a bookmark in this document.
+                  "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                    "id": "A String", # The ID of a heading in this document.
+                    "tabId": "A String", # The ID of the tab containing this heading.
+                  },
+                  "headingId": "A String", # The ID of a heading in this document.
+                  "tabId": "A String", # The ID of a tab in this document.
+                  "url": "A String", # An external URL.
+                },
+                "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                "strikethrough": True or False, # Whether or not the text is struck through.
+                "underline": True or False, # Whether or not the text is underlined.
+                "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                  "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                  "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                },
+              },
+            },
+            "elements": [ # The content of the paragraph, broken down into its component parts.
+              { # A ParagraphElement describes content within a Paragraph.
+                "autoText": { # A ParagraphElement representing a spot in the text that's dynamically replaced with content that can change over time, like a page number. # An auto text paragraph element.
+                  "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # The suggested insertion IDs. An AutoText may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                    "A String",
+                  ],
+                  "suggestedTextStyleChanges": { # The suggested text style changes to this AutoText, keyed by suggestion ID.
+                    "a_key": { # A suggested change to a TextStyle.
+                      "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                        "bold": True or False, # Whether or not the text is rendered as bold.
+                        "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "italic": True or False, # Whether or not the text is italicized.
+                        "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                          "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a bookmark in this document.
+                            "tabId": "A String", # The ID of the tab containing this bookmark.
+                          },
+                          "bookmarkId": "A String", # The ID of a bookmark in this document.
+                          "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of the tab containing this heading.
+                          },
+                          "headingId": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of a tab in this document.
+                          "url": "A String", # An external URL.
+                        },
+                        "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                        "strikethrough": True or False, # Whether or not the text is struck through.
+                        "underline": True or False, # Whether or not the text is underlined.
+                        "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                          "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                          "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                        },
+                      },
+                      "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                        "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                        "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                        "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                        "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                        "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                        "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                        "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                        "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                        "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                        "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                        "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                      },
+                    },
+                  },
+                  "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this AutoText.
+                    "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                    "bold": True or False, # Whether or not the text is rendered as bold.
+                    "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "italic": True or False, # Whether or not the text is italicized.
+                    "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                      "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a bookmark in this document.
+                        "tabId": "A String", # The ID of the tab containing this bookmark.
+                      },
+                      "bookmarkId": "A String", # The ID of a bookmark in this document.
+                      "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of the tab containing this heading.
+                      },
+                      "headingId": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of a tab in this document.
+                      "url": "A String", # An external URL.
+                    },
+                    "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                    "strikethrough": True or False, # Whether or not the text is struck through.
+                    "underline": True or False, # Whether or not the text is underlined.
+                    "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                      "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                      "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                    },
+                  },
+                  "type": "A String", # The type of this auto text.
+                },
+                "columnBreak": { # A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column. # A column break paragraph element.
+                  "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                    "A String",
+                  ],
+                  "suggestedTextStyleChanges": { # The suggested text style changes to this ColumnBreak, keyed by suggestion ID.
+                    "a_key": { # A suggested change to a TextStyle.
+                      "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                        "bold": True or False, # Whether or not the text is rendered as bold.
+                        "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "italic": True or False, # Whether or not the text is italicized.
+                        "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                          "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a bookmark in this document.
+                            "tabId": "A String", # The ID of the tab containing this bookmark.
+                          },
+                          "bookmarkId": "A String", # The ID of a bookmark in this document.
+                          "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of the tab containing this heading.
+                          },
+                          "headingId": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of a tab in this document.
+                          "url": "A String", # An external URL.
+                        },
+                        "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                        "strikethrough": True or False, # Whether or not the text is struck through.
+                        "underline": True or False, # Whether or not the text is underlined.
+                        "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                          "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                          "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                        },
+                      },
+                      "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                        "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                        "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                        "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                        "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                        "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                        "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                        "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                        "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                        "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                        "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                        "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                      },
+                    },
+                  },
+                  "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it.
+                    "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                    "bold": True or False, # Whether or not the text is rendered as bold.
+                    "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "italic": True or False, # Whether or not the text is italicized.
+                    "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                      "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a bookmark in this document.
+                        "tabId": "A String", # The ID of the tab containing this bookmark.
+                      },
+                      "bookmarkId": "A String", # The ID of a bookmark in this document.
+                      "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of the tab containing this heading.
+                      },
+                      "headingId": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of a tab in this document.
+                      "url": "A String", # An external URL.
+                    },
+                    "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                    "strikethrough": True or False, # Whether or not the text is struck through.
+                    "underline": True or False, # Whether or not the text is underlined.
+                    "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                      "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                      "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                    },
+                  },
+                },
+                "endIndex": 42, # The zero-base end index of this paragraph element, exclusive, in UTF-16 code units.
+                "equation": { # A ParagraphElement representing an equation. # An equation paragraph element.
+                  "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # The suggested insertion IDs. An Equation may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                    "A String",
+                  ],
+                },
+                "footnoteReference": { # A ParagraphElement representing a footnote reference. A footnote reference is the inline content rendered with a number and is used to identify the footnote. # A footnote reference paragraph element.
+                  "footnoteId": "A String", # The ID of the footnote that contains the content of this footnote reference.
+                  "footnoteNumber": "A String", # The rendered number of this footnote.
+                  "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                    "A String",
+                  ],
+                  "suggestedTextStyleChanges": { # The suggested text style changes to this FootnoteReference, keyed by suggestion ID.
+                    "a_key": { # A suggested change to a TextStyle.
+                      "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                        "bold": True or False, # Whether or not the text is rendered as bold.
+                        "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "italic": True or False, # Whether or not the text is italicized.
+                        "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                          "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a bookmark in this document.
+                            "tabId": "A String", # The ID of the tab containing this bookmark.
+                          },
+                          "bookmarkId": "A String", # The ID of a bookmark in this document.
+                          "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of the tab containing this heading.
+                          },
+                          "headingId": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of a tab in this document.
+                          "url": "A String", # An external URL.
+                        },
+                        "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                        "strikethrough": True or False, # Whether or not the text is struck through.
+                        "underline": True or False, # Whether or not the text is underlined.
+                        "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                          "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                          "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                        },
+                      },
+                      "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                        "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                        "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                        "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                        "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                        "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                        "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                        "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                        "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                        "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                        "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                        "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                      },
+                    },
+                  },
+                  "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this FootnoteReference.
+                    "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                    "bold": True or False, # Whether or not the text is rendered as bold.
+                    "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "italic": True or False, # Whether or not the text is italicized.
+                    "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                      "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a bookmark in this document.
+                        "tabId": "A String", # The ID of the tab containing this bookmark.
+                      },
+                      "bookmarkId": "A String", # The ID of a bookmark in this document.
+                      "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of the tab containing this heading.
+                      },
+                      "headingId": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of a tab in this document.
+                      "url": "A String", # An external URL.
+                    },
+                    "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                    "strikethrough": True or False, # Whether or not the text is struck through.
+                    "underline": True or False, # Whether or not the text is underlined.
+                    "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                      "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                      "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                    },
+                  },
+                },
+                "horizontalRule": { # A ParagraphElement representing a horizontal line. # A horizontal rule paragraph element.
+                  "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # The suggested insertion IDs. A HorizontalRule may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion.
+                    "A String",
+                  ],
+                  "suggestedTextStyleChanges": { # The suggested text style changes to this HorizontalRule, keyed by suggestion ID.
+                    "a_key": { # A suggested change to a TextStyle.
+                      "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                        "bold": True or False, # Whether or not the text is rendered as bold.
+                        "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "italic": True or False, # Whether or not the text is italicized.
+                        "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                          "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a bookmark in this document.
+                            "tabId": "A String", # The ID of the tab containing this bookmark.
+                          },
+                          "bookmarkId": "A String", # The ID of a bookmark in this document.
+                          "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of the tab containing this heading.
+                          },
+                          "headingId": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of a tab in this document.
+                          "url": "A String", # An external URL.
+                        },
+                        "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                        "strikethrough": True or False, # Whether or not the text is struck through.
+                        "underline": True or False, # Whether or not the text is underlined.
+                        "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                          "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                          "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                        },
+                      },
+                      "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                        "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                        "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                        "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                        "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                        "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                        "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                        "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                        "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                        "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                        "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                        "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                      },
+                    },
+                  },
+                  "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this HorizontalRule. Similar to text content, like text runs and footnote references, the text style of a horizontal rule can affect content layout as well as the styling of text inserted next to it.
+                    "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                    "bold": True or False, # Whether or not the text is rendered as bold.
+                    "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "italic": True or False, # Whether or not the text is italicized.
+                    "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                      "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a bookmark in this document.
+                        "tabId": "A String", # The ID of the tab containing this bookmark.
+                      },
+                      "bookmarkId": "A String", # The ID of a bookmark in this document.
+                      "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of the tab containing this heading.
+                      },
+                      "headingId": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of a tab in this document.
+                      "url": "A String", # An external URL.
+                    },
+                    "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                    "strikethrough": True or False, # Whether or not the text is struck through.
+                    "underline": True or False, # Whether or not the text is underlined.
+                    "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                      "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                      "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                    },
+                  },
+                },
+                "inlineObjectElement": { # A ParagraphElement that contains an InlineObject. # An inline object paragraph element.
+                  "inlineObjectId": "A String", # The ID of the InlineObject this element contains.
+                  "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # The suggested insertion IDs. An InlineObjectElement may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                    "A String",
+                  ],
+                  "suggestedTextStyleChanges": { # The suggested text style changes to this InlineObject, keyed by suggestion ID.
+                    "a_key": { # A suggested change to a TextStyle.
+                      "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                        "bold": True or False, # Whether or not the text is rendered as bold.
+                        "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "italic": True or False, # Whether or not the text is italicized.
+                        "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                          "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a bookmark in this document.
+                            "tabId": "A String", # The ID of the tab containing this bookmark.
+                          },
+                          "bookmarkId": "A String", # The ID of a bookmark in this document.
+                          "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of the tab containing this heading.
+                          },
+                          "headingId": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of a tab in this document.
+                          "url": "A String", # An external URL.
+                        },
+                        "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                        "strikethrough": True or False, # Whether or not the text is struck through.
+                        "underline": True or False, # Whether or not the text is underlined.
+                        "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                          "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                          "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                        },
+                      },
+                      "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                        "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                        "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                        "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                        "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                        "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                        "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                        "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                        "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                        "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                        "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                        "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                      },
+                    },
+                  },
+                  "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this InlineObjectElement. Similar to text content, like text runs and footnote references, the text style of an inline object element can affect content layout as well as the styling of text inserted next to it.
+                    "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                    "bold": True or False, # Whether or not the text is rendered as bold.
+                    "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "italic": True or False, # Whether or not the text is italicized.
+                    "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                      "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a bookmark in this document.
+                        "tabId": "A String", # The ID of the tab containing this bookmark.
+                      },
+                      "bookmarkId": "A String", # The ID of a bookmark in this document.
+                      "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of the tab containing this heading.
+                      },
+                      "headingId": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of a tab in this document.
+                      "url": "A String", # An external URL.
+                    },
+                    "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                    "strikethrough": True or False, # Whether or not the text is struck through.
+                    "underline": True or False, # Whether or not the text is underlined.
+                    "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                      "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                      "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                    },
+                  },
+                },
+                "pageBreak": { # A ParagraphElement representing a page break. A page break makes the subsequent text start at the top of the next page. # A page break paragraph element.
+                  "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # The suggested insertion IDs. A PageBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                    "A String",
+                  ],
+                  "suggestedTextStyleChanges": { # The suggested text style changes to this PageBreak, keyed by suggestion ID.
+                    "a_key": { # A suggested change to a TextStyle.
+                      "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                        "bold": True or False, # Whether or not the text is rendered as bold.
+                        "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "italic": True or False, # Whether or not the text is italicized.
+                        "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                          "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a bookmark in this document.
+                            "tabId": "A String", # The ID of the tab containing this bookmark.
+                          },
+                          "bookmarkId": "A String", # The ID of a bookmark in this document.
+                          "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of the tab containing this heading.
+                          },
+                          "headingId": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of a tab in this document.
+                          "url": "A String", # An external URL.
+                        },
+                        "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                        "strikethrough": True or False, # Whether or not the text is struck through.
+                        "underline": True or False, # Whether or not the text is underlined.
+                        "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                          "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                          "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                        },
+                      },
+                      "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                        "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                        "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                        "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                        "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                        "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                        "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                        "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                        "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                        "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                        "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                        "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                      },
+                    },
+                  },
+                  "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this PageBreak. Similar to text content, like text runs and footnote references, the text style of a page break can affect content layout as well as the styling of text inserted next to it.
+                    "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                    "bold": True or False, # Whether or not the text is rendered as bold.
+                    "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "italic": True or False, # Whether or not the text is italicized.
+                    "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                      "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a bookmark in this document.
+                        "tabId": "A String", # The ID of the tab containing this bookmark.
+                      },
+                      "bookmarkId": "A String", # The ID of a bookmark in this document.
+                      "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of the tab containing this heading.
+                      },
+                      "headingId": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of a tab in this document.
+                      "url": "A String", # An external URL.
+                    },
+                    "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                    "strikethrough": True or False, # Whether or not the text is struck through.
+                    "underline": True or False, # Whether or not the text is underlined.
+                    "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                      "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                      "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                    },
+                  },
+                },
+                "person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address.
+                  "personId": "A String", # Output only. The unique ID of this link.
+                  "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present.
+                    "email": "A String", # Output only. The email address linked to this Person. This field is always present.
+                    "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address.
+                  },
+                  "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # IDs for suggestions that insert this person link into the document. A Person might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion.
+                    "A String",
+                  ],
+                  "suggestedTextStyleChanges": { # The suggested text style changes to this Person, keyed by suggestion ID.
+                    "a_key": { # A suggested change to a TextStyle.
+                      "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                        "bold": True or False, # Whether or not the text is rendered as bold.
+                        "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "italic": True or False, # Whether or not the text is italicized.
+                        "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                          "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a bookmark in this document.
+                            "tabId": "A String", # The ID of the tab containing this bookmark.
+                          },
+                          "bookmarkId": "A String", # The ID of a bookmark in this document.
+                          "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of the tab containing this heading.
+                          },
+                          "headingId": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of a tab in this document.
+                          "url": "A String", # An external URL.
+                        },
+                        "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                        "strikethrough": True or False, # Whether or not the text is struck through.
+                        "underline": True or False, # Whether or not the text is underlined.
+                        "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                          "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                          "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                        },
+                      },
+                      "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                        "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                        "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                        "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                        "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                        "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                        "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                        "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                        "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                        "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                        "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                        "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                      },
+                    },
+                  },
+                  "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this Person.
+                    "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                    "bold": True or False, # Whether or not the text is rendered as bold.
+                    "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "italic": True or False, # Whether or not the text is italicized.
+                    "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                      "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a bookmark in this document.
+                        "tabId": "A String", # The ID of the tab containing this bookmark.
+                      },
+                      "bookmarkId": "A String", # The ID of a bookmark in this document.
+                      "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of the tab containing this heading.
+                      },
+                      "headingId": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of a tab in this document.
+                      "url": "A String", # An external URL.
+                    },
+                    "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                    "strikethrough": True or False, # Whether or not the text is struck through.
+                    "underline": True or False, # Whether or not the text is underlined.
+                    "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                      "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                      "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                    },
+                  },
+                },
+                "richLink": { # A link to a Google resource (such as a file in Drive, a YouTube video, or a Calendar event). # A paragraph element that links to a Google resource (such as a file in Google Drive, a YouTube video, or a Calendar event.)
+                  "richLinkId": "A String", # Output only. The ID of this link.
+                  "richLinkProperties": { # Properties specific to a RichLink. # Output only. The properties of this RichLink. This field is always present.
+                    "mimeType": "A String", # Output only. The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the RichLink, if there's one (for example, when it's a file in Drive).
+                    "title": "A String", # Output only. The title of the RichLink as displayed in the link. This title matches the title of the linked resource at the time of the insertion or last update of the link. This field is always present.
+                    "uri": "A String", # Output only. The URI to the RichLink. This is always present.
+                  },
+                  "suggestedDeletionIds": [ # IDs for suggestions that remove this link from the document. A RichLink might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # IDs for suggestions that insert this link into the document. A RichLink might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion.
+                    "A String",
+                  ],
+                  "suggestedTextStyleChanges": { # The suggested text style changes to this RichLink, keyed by suggestion ID.
+                    "a_key": { # A suggested change to a TextStyle.
+                      "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                        "bold": True or False, # Whether or not the text is rendered as bold.
+                        "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "italic": True or False, # Whether or not the text is italicized.
+                        "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                          "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a bookmark in this document.
+                            "tabId": "A String", # The ID of the tab containing this bookmark.
+                          },
+                          "bookmarkId": "A String", # The ID of a bookmark in this document.
+                          "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of the tab containing this heading.
+                          },
+                          "headingId": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of a tab in this document.
+                          "url": "A String", # An external URL.
+                        },
+                        "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                        "strikethrough": True or False, # Whether or not the text is struck through.
+                        "underline": True or False, # Whether or not the text is underlined.
+                        "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                          "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                          "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                        },
+                      },
+                      "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                        "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                        "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                        "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                        "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                        "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                        "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                        "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                        "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                        "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                        "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                        "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                      },
+                    },
+                  },
+                  "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this RichLink.
+                    "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                    "bold": True or False, # Whether or not the text is rendered as bold.
+                    "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "italic": True or False, # Whether or not the text is italicized.
+                    "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                      "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a bookmark in this document.
+                        "tabId": "A String", # The ID of the tab containing this bookmark.
+                      },
+                      "bookmarkId": "A String", # The ID of a bookmark in this document.
+                      "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of the tab containing this heading.
+                      },
+                      "headingId": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of a tab in this document.
+                      "url": "A String", # An external URL.
+                    },
+                    "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                    "strikethrough": True or False, # Whether or not the text is struck through.
+                    "underline": True or False, # Whether or not the text is underlined.
+                    "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                      "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                      "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                    },
+                  },
+                },
+                "startIndex": 42, # The zero-based start index of this paragraph element, in UTF-16 code units.
+                "textRun": { # A ParagraphElement that represents a run of text that all has the same styling. # A text run paragraph element.
+                  "content": "A String", # The text of this run. Any non-text elements in the run are replaced with the Unicode character U+E907.
+                  "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # The suggested insertion IDs. A TextRun may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                    "A String",
+                  ],
+                  "suggestedTextStyleChanges": { # The suggested text style changes to this run, keyed by suggestion ID.
+                    "a_key": { # A suggested change to a TextStyle.
+                      "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                        "bold": True or False, # Whether or not the text is rendered as bold.
+                        "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "italic": True or False, # Whether or not the text is italicized.
+                        "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                          "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a bookmark in this document.
+                            "tabId": "A String", # The ID of the tab containing this bookmark.
+                          },
+                          "bookmarkId": "A String", # The ID of a bookmark in this document.
+                          "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of the tab containing this heading.
+                          },
+                          "headingId": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of a tab in this document.
+                          "url": "A String", # An external URL.
+                        },
+                        "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                        "strikethrough": True or False, # Whether or not the text is struck through.
+                        "underline": True or False, # Whether or not the text is underlined.
+                        "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                          "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                          "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                        },
+                      },
+                      "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                        "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                        "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                        "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                        "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                        "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                        "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                        "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                        "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                        "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                        "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                        "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                      },
+                    },
+                  },
+                  "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this run.
+                    "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                    "bold": True or False, # Whether or not the text is rendered as bold.
+                    "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "italic": True or False, # Whether or not the text is italicized.
+                    "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                      "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a bookmark in this document.
+                        "tabId": "A String", # The ID of the tab containing this bookmark.
+                      },
+                      "bookmarkId": "A String", # The ID of a bookmark in this document.
+                      "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of the tab containing this heading.
+                      },
+                      "headingId": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of a tab in this document.
+                      "url": "A String", # An external URL.
+                    },
+                    "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                    "strikethrough": True or False, # Whether or not the text is struck through.
+                    "underline": True or False, # Whether or not the text is underlined.
+                    "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                      "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                      "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                    },
+                  },
+                },
+              },
+            ],
+            "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The style of this paragraph.
+              "alignment": "A String", # The text alignment for this paragraph.
+              "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent.
+              "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                  "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                    "rgbColor": { # An RGB color. # The RGB color value.
+                      "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                      "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                      "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                    },
+                  },
+                },
+                "dashStyle": "A String", # The dash style of the border.
+                "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+              },
+              "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                  "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                    "rgbColor": { # An RGB color. # The RGB color value.
+                      "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                      "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                      "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                    },
+                  },
+                },
+                "dashStyle": "A String", # The dash style of the border.
+                "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+              },
+              "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                  "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                    "rgbColor": { # An RGB color. # The RGB color value.
+                      "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                      "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                      "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                    },
+                  },
+                },
+                "dashStyle": "A String", # The dash style of the border.
+                "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+              },
+              "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                  "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                    "rgbColor": { # An RGB color. # The RGB color value.
+                      "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                      "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                      "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                    },
+                  },
+                },
+                "dashStyle": "A String", # The dash style of the border.
+                "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+              },
+              "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                  "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                    "rgbColor": { # An RGB color. # The RGB color value.
+                      "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                      "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                      "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                    },
+                  },
+                },
+                "dashStyle": "A String", # The dash style of the border.
+                "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+              },
+              "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited.
+              "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only.
+              "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent.
+              "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent.
+              "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent.
+              "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated.
+              "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error.
+              "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent.
+                "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading.
+                  "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                    "rgbColor": { # An RGB color. # The RGB color value.
+                      "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                      "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                      "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                    },
+                  },
+                },
+              },
+              "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "spacingMode": "A String", # The spacing mode for the paragraph.
+              "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only.
+                { # A tab stop within a paragraph.
+                  "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START.
+                  "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                },
+              ],
+            },
+            "positionedObjectIds": [ # The IDs of the positioned objects tethered to this paragraph.
+              "A String",
+            ],
+            "suggestedBulletChanges": { # The suggested changes to this paragraph's bullet.
+              "a_key": { # A suggested change to a Bullet.
+                "bullet": { # Describes the bullet of a paragraph. # A Bullet that only includes the changes made in this suggestion. This can be used along with the bullet_suggestion_state to see which fields have changed and their new values.
+                  "listId": "A String", # The ID of the list this paragraph belongs to.
+                  "nestingLevel": 42, # The nesting level of this paragraph in the list.
+                  "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet.
+                    "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                    "bold": True or False, # Whether or not the text is rendered as bold.
+                    "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "italic": True or False, # Whether or not the text is italicized.
+                    "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                      "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a bookmark in this document.
+                        "tabId": "A String", # The ID of the tab containing this bookmark.
+                      },
+                      "bookmarkId": "A String", # The ID of a bookmark in this document.
+                      "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of the tab containing this heading.
+                      },
+                      "headingId": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of a tab in this document.
+                      "url": "A String", # An external URL.
+                    },
+                    "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                    "strikethrough": True or False, # Whether or not the text is struck through.
+                    "underline": True or False, # Whether or not the text is underlined.
+                    "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                      "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                      "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                    },
+                  },
+                },
+                "bulletSuggestionState": { # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion.
+                  "listIdSuggested": True or False, # Indicates if there was a suggested change to the list_id.
+                  "nestingLevelSuggested": True or False, # Indicates if there was a suggested change to the nesting_level.
+                  "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion.
+                    "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                    "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                    "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                    "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                    "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                    "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                    "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                    "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                    "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                    "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                    "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                  },
+                },
+              },
+            },
+            "suggestedParagraphStyleChanges": { # The suggested paragraph style changes to this paragraph, keyed by suggestion ID.
+              "a_key": { # A suggested change to a ParagraphStyle.
+                "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A ParagraphStyle that only includes the changes made in this suggestion. This can be used along with the paragraph_style_suggestion_state to see which fields have changed and their new values.
+                  "alignment": "A String", # The text alignment for this paragraph.
+                  "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent.
+                  "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                    "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "dashStyle": "A String", # The dash style of the border.
+                    "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                  },
+                  "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                    "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "dashStyle": "A String", # The dash style of the border.
+                    "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                  },
+                  "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                    "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "dashStyle": "A String", # The dash style of the border.
+                    "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                  },
+                  "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                    "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "dashStyle": "A String", # The dash style of the border.
+                    "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                  },
+                  "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                    "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "dashStyle": "A String", # The dash style of the border.
+                    "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                  },
+                  "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited.
+                  "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only.
+                  "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent.
+                  "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent.
+                  "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent.
+                  "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated.
+                  "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error.
+                  "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent.
+                    "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                  },
+                  "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "spacingMode": "A String", # The spacing mode for the paragraph.
+                  "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only.
+                    { # A tab stop within a paragraph.
+                      "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START.
+                      "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                    },
+                  ],
+                },
+                "paragraphStyleSuggestionState": { # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion.
+                  "alignmentSuggested": True or False, # Indicates if there was a suggested change to alignment.
+                  "avoidWidowAndOrphanSuggested": True or False, # Indicates if there was a suggested change to avoid_widow_and_orphan.
+                  "borderBetweenSuggested": True or False, # Indicates if there was a suggested change to border_between.
+                  "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom.
+                  "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left.
+                  "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right.
+                  "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top.
+                  "directionSuggested": True or False, # Indicates if there was a suggested change to direction.
+                  "headingIdSuggested": True or False, # Indicates if there was a suggested change to heading_id.
+                  "indentEndSuggested": True or False, # Indicates if there was a suggested change to indent_end.
+                  "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line.
+                  "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start.
+                  "keepLinesTogetherSuggested": True or False, # Indicates if there was a suggested change to keep_lines_together.
+                  "keepWithNextSuggested": True or False, # Indicates if there was a suggested change to keep_with_next.
+                  "lineSpacingSuggested": True or False, # Indicates if there was a suggested change to line_spacing.
+                  "namedStyleTypeSuggested": True or False, # Indicates if there was a suggested change to named_style_type.
+                  "pageBreakBeforeSuggested": True or False, # Indicates if there was a suggested change to page_break_before.
+                  "shadingSuggestionState": { # A mask that indicates which of the fields on the base Shading have been changed in this suggested change. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in shading have been changed in this suggestion.
+                    "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to the Shading.
+                  },
+                  "spaceAboveSuggested": True or False, # Indicates if there was a suggested change to space_above.
+                  "spaceBelowSuggested": True or False, # Indicates if there was a suggested change to space_below.
+                  "spacingModeSuggested": True or False, # Indicates if there was a suggested change to spacing_mode.
+                },
+              },
+            },
+            "suggestedPositionedObjectIds": { # The IDs of the positioned objects suggested to be attached to this paragraph, keyed by suggestion ID.
+              "a_key": { # A collection of object IDs.
+                "objectIds": [ # The object IDs.
+                  "A String",
+                ],
+              },
+            },
+          },
+          "sectionBreak": { # A StructuralElement representing a section break. A section is a range of content that has the same SectionStyle. A section break represents the start of a new section, and the section style applies to the section after the section break. The document body always begins with a section break. # A section break type of structural element.
+            "sectionStyle": { # The styling that applies to a section. # The style of the section after this section break.
+              "columnProperties": [ # The section's columns properties. If empty, the section contains one column with the default properties in the Docs editor. A section can be updated to have no more than 3 columns. When updating this property, setting a concrete value is required. Unsetting this property will result in a 400 bad request error.
+                { # Properties that apply to a section's column.
+                  "paddingEnd": { # A magnitude in a single direction in the specified units. # The padding at the end of the column.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "width": { # A magnitude in a single direction in the specified units. # Output only. The width of the column.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                },
+              ],
+              "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+              "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+              "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only.
+              "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only.
+              "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only.
+              "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only.
+              "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only.
+              "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only.
+              "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+              "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+              "sectionType": "A String", # Output only. The type of section.
+              "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+            },
+            "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+              "A String",
+            ],
+            "suggestedInsertionIds": [ # The suggested insertion IDs. A SectionBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+              "A String",
+            ],
+          },
+          "startIndex": 42, # The zero-based start index of this structural element, in UTF-16 code units.
+          "table": { # A StructuralElement representing a table. # A table type of structural element.
+            "columns": 42, # Number of columns in the table. It's possible for a table to be non-rectangular, so some rows may have a different number of cells.
+            "rows": 42, # Number of rows in the table.
+            "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+              "A String",
+            ],
+            "suggestedInsertionIds": [ # The suggested insertion IDs. A Table may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+              "A String",
+            ],
+            "tableRows": [ # The contents and style of each row.
+              { # The contents and style of a row in a Table.
+                "endIndex": 42, # The zero-based end index of this row, exclusive, in UTF-16 code units.
+                "startIndex": 42, # The zero-based start index of this row, in UTF-16 code units.
+                "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                  "A String",
+                ],
+                "suggestedInsertionIds": [ # The suggested insertion IDs. A TableRow may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                  "A String",
+                ],
+                "suggestedTableRowStyleChanges": { # The suggested style changes to this row, keyed by suggestion ID.
+                  "a_key": { # A suggested change to a TableRowStyle.
+                    "tableRowStyle": { # Styles that apply to a table row. # A TableRowStyle that only includes the changes made in this suggestion. This can be used along with the table_row_style_suggestion_state to see which fields have changed and their new values.
+                      "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries.
+                      "tableHeader": True or False, # Whether the row is a table header.
+                    },
+                    "tableRowStyleSuggestionState": { # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion.
+                      "minRowHeightSuggested": True or False, # Indicates if there was a suggested change to min_row_height.
+                    },
+                  },
+                },
+                "tableCells": [ # The contents and style of each cell in this row. It's possible for a table to be non-rectangular, so some rows may have a different number of cells than other rows in the same table.
+                  { # The contents and style of a cell in a Table.
+                    "content": [ # The content of the cell.
+                      # Object with schema name: StructuralElement
+                    ],
+                    "endIndex": 42, # The zero-based end index of this cell, exclusive, in UTF-16 code units.
+                    "startIndex": 42, # The zero-based start index of this cell, in UTF-16 code units.
+                    "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                      "A String",
+                    ],
+                    "suggestedInsertionIds": [ # The suggested insertion IDs. A TableCell may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                      "A String",
+                    ],
+                    "suggestedTableCellStyleChanges": { # The suggested changes to the table cell style, keyed by suggestion ID.
+                      "a_key": { # A suggested change to a TableCellStyle.
+                        "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # A TableCellStyle that only includes the changes made in this suggestion. This can be used along with the table_cell_style_suggestion_state to see which fields have changed and their new values.
+                          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell.
+                            "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "dashStyle": "A String", # The dash style of the border.
+                            "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                          },
+                          "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell.
+                            "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "dashStyle": "A String", # The dash style of the border.
+                            "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                          },
+                          "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell.
+                            "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "dashStyle": "A String", # The dash style of the border.
+                            "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                          },
+                          "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell.
+                            "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "dashStyle": "A String", # The dash style of the border.
+                            "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                          },
+                          "columnSpan": 42, # The column span of the cell. This property is read-only.
+                          "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor.
+                          "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "rowSpan": 42, # The row span of the cell. This property is read-only.
+                        },
+                        "tableCellStyleSuggestionState": { # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion.
+                          "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                          "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom.
+                          "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left.
+                          "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right.
+                          "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top.
+                          "columnSpanSuggested": True or False, # Indicates if there was a suggested change to column_span.
+                          "contentAlignmentSuggested": True or False, # Indicates if there was a suggested change to content_alignment.
+                          "paddingBottomSuggested": True or False, # Indicates if there was a suggested change to padding_bottom.
+                          "paddingLeftSuggested": True or False, # Indicates if there was a suggested change to padding_left.
+                          "paddingRightSuggested": True or False, # Indicates if there was a suggested change to padding_right.
+                          "paddingTopSuggested": True or False, # Indicates if there was a suggested change to padding_top.
+                          "rowSpanSuggested": True or False, # Indicates if there was a suggested change to row_span.
+                        },
+                      },
+                    },
+                    "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # The style of the cell.
+                      "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell.
+                        "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "dashStyle": "A String", # The dash style of the border.
+                        "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                      },
+                      "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell.
+                        "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "dashStyle": "A String", # The dash style of the border.
+                        "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                      },
+                      "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell.
+                        "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "dashStyle": "A String", # The dash style of the border.
+                        "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                      },
+                      "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell.
+                        "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "dashStyle": "A String", # The dash style of the border.
+                        "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                      },
+                      "columnSpan": 42, # The column span of the cell. This property is read-only.
+                      "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor.
+                      "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "rowSpan": 42, # The row span of the cell. This property is read-only.
+                    },
+                  },
+                ],
+                "tableRowStyle": { # Styles that apply to a table row. # The style of the table row.
+                  "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries.
+                  "tableHeader": True or False, # Whether the row is a table header.
+                },
+              },
+            ],
+            "tableStyle": { # Styles that apply to a table. # The style of the table.
+              "tableColumnProperties": [ # The properties of each column. Note that in Docs, tables contain rows and rows contain cells, similar to HTML. So the properties for a row can be found on the row's table_row_style.
+                { # The properties of a column in a table.
+                  "width": { # A magnitude in a single direction in the specified units. # The width of the column. Set when the column's `width_type` is FIXED_WIDTH.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "widthType": "A String", # The width type of the column.
+                },
+              ],
+            },
+          },
+          "tableOfContents": { # A StructuralElement representing a table of contents. # A table of contents type of structural element.
+            "content": [ # The content of the table of contents.
+              # Object with schema name: StructuralElement
+            ],
+            "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+              "A String",
+            ],
+            "suggestedInsertionIds": [ # The suggested insertion IDs. A TableOfContents may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion.
+              "A String",
+            ],
+          },
+        },
+      ],
+      "footnoteId": "A String", # The ID of the footnote.
+    },
+  },
+  "headers": { # Output only. The headers in the document, keyed by header ID.
+    "a_key": { # A document header.
+      "content": [ # The contents of the header. The indexes for a header's content begin at zero.
+        { # A StructuralElement describes content that provides structure to the document.
+          "endIndex": 42, # The zero-based end index of this structural element, exclusive, in UTF-16 code units.
+          "paragraph": { # A StructuralElement representing a paragraph. A paragraph is a range of content that's terminated with a newline character. # A paragraph type of structural element.
+            "bullet": { # Describes the bullet of a paragraph. # The bullet for this paragraph. If not present, the paragraph does not belong to a list.
+              "listId": "A String", # The ID of the list this paragraph belongs to.
+              "nestingLevel": 42, # The nesting level of this paragraph in the list.
+              "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet.
+                "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                  "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                    "rgbColor": { # An RGB color. # The RGB color value.
+                      "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                      "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                      "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                    },
+                  },
+                },
+                "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                "bold": True or False, # Whether or not the text is rendered as bold.
+                "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                  "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                    "rgbColor": { # An RGB color. # The RGB color value.
+                      "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                      "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                      "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                    },
+                  },
+                },
+                "italic": True or False, # Whether or not the text is italicized.
+                "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                  "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                    "id": "A String", # The ID of a bookmark in this document.
+                    "tabId": "A String", # The ID of the tab containing this bookmark.
+                  },
+                  "bookmarkId": "A String", # The ID of a bookmark in this document.
+                  "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                    "id": "A String", # The ID of a heading in this document.
+                    "tabId": "A String", # The ID of the tab containing this heading.
+                  },
+                  "headingId": "A String", # The ID of a heading in this document.
+                  "tabId": "A String", # The ID of a tab in this document.
+                  "url": "A String", # An external URL.
+                },
+                "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                "strikethrough": True or False, # Whether or not the text is struck through.
+                "underline": True or False, # Whether or not the text is underlined.
+                "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                  "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                  "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                },
+              },
+            },
+            "elements": [ # The content of the paragraph, broken down into its component parts.
+              { # A ParagraphElement describes content within a Paragraph.
+                "autoText": { # A ParagraphElement representing a spot in the text that's dynamically replaced with content that can change over time, like a page number. # An auto text paragraph element.
+                  "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # The suggested insertion IDs. An AutoText may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                    "A String",
+                  ],
+                  "suggestedTextStyleChanges": { # The suggested text style changes to this AutoText, keyed by suggestion ID.
+                    "a_key": { # A suggested change to a TextStyle.
+                      "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                        "bold": True or False, # Whether or not the text is rendered as bold.
+                        "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "italic": True or False, # Whether or not the text is italicized.
+                        "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                          "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a bookmark in this document.
+                            "tabId": "A String", # The ID of the tab containing this bookmark.
+                          },
+                          "bookmarkId": "A String", # The ID of a bookmark in this document.
+                          "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of the tab containing this heading.
+                          },
+                          "headingId": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of a tab in this document.
+                          "url": "A String", # An external URL.
+                        },
+                        "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                        "strikethrough": True or False, # Whether or not the text is struck through.
+                        "underline": True or False, # Whether or not the text is underlined.
+                        "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                          "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                          "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                        },
+                      },
+                      "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                        "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                        "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                        "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                        "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                        "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                        "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                        "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                        "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                        "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                        "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                        "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                      },
+                    },
+                  },
+                  "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this AutoText.
+                    "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                    "bold": True or False, # Whether or not the text is rendered as bold.
+                    "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "italic": True or False, # Whether or not the text is italicized.
+                    "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                      "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a bookmark in this document.
+                        "tabId": "A String", # The ID of the tab containing this bookmark.
+                      },
+                      "bookmarkId": "A String", # The ID of a bookmark in this document.
+                      "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of the tab containing this heading.
+                      },
+                      "headingId": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of a tab in this document.
+                      "url": "A String", # An external URL.
+                    },
+                    "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                    "strikethrough": True or False, # Whether or not the text is struck through.
+                    "underline": True or False, # Whether or not the text is underlined.
+                    "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                      "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                      "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                    },
+                  },
+                  "type": "A String", # The type of this auto text.
+                },
+                "columnBreak": { # A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column. # A column break paragraph element.
+                  "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                    "A String",
+                  ],
+                  "suggestedTextStyleChanges": { # The suggested text style changes to this ColumnBreak, keyed by suggestion ID.
+                    "a_key": { # A suggested change to a TextStyle.
+                      "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                        "bold": True or False, # Whether or not the text is rendered as bold.
+                        "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "italic": True or False, # Whether or not the text is italicized.
+                        "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                          "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a bookmark in this document.
+                            "tabId": "A String", # The ID of the tab containing this bookmark.
+                          },
+                          "bookmarkId": "A String", # The ID of a bookmark in this document.
+                          "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of the tab containing this heading.
+                          },
+                          "headingId": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of a tab in this document.
+                          "url": "A String", # An external URL.
+                        },
+                        "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                        "strikethrough": True or False, # Whether or not the text is struck through.
+                        "underline": True or False, # Whether or not the text is underlined.
+                        "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                          "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                          "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                        },
+                      },
+                      "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                        "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                        "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                        "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                        "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                        "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                        "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                        "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                        "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                        "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                        "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                        "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                      },
+                    },
+                  },
+                  "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it.
+                    "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                    "bold": True or False, # Whether or not the text is rendered as bold.
+                    "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "italic": True or False, # Whether or not the text is italicized.
+                    "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                      "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a bookmark in this document.
+                        "tabId": "A String", # The ID of the tab containing this bookmark.
+                      },
+                      "bookmarkId": "A String", # The ID of a bookmark in this document.
+                      "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of the tab containing this heading.
+                      },
+                      "headingId": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of a tab in this document.
+                      "url": "A String", # An external URL.
+                    },
+                    "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                    "strikethrough": True or False, # Whether or not the text is struck through.
+                    "underline": True or False, # Whether or not the text is underlined.
+                    "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                      "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                      "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                    },
+                  },
+                },
+                "endIndex": 42, # The zero-base end index of this paragraph element, exclusive, in UTF-16 code units.
+                "equation": { # A ParagraphElement representing an equation. # An equation paragraph element.
+                  "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # The suggested insertion IDs. An Equation may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                    "A String",
+                  ],
+                },
+                "footnoteReference": { # A ParagraphElement representing a footnote reference. A footnote reference is the inline content rendered with a number and is used to identify the footnote. # A footnote reference paragraph element.
+                  "footnoteId": "A String", # The ID of the footnote that contains the content of this footnote reference.
+                  "footnoteNumber": "A String", # The rendered number of this footnote.
+                  "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                    "A String",
+                  ],
+                  "suggestedTextStyleChanges": { # The suggested text style changes to this FootnoteReference, keyed by suggestion ID.
+                    "a_key": { # A suggested change to a TextStyle.
+                      "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                        "bold": True or False, # Whether or not the text is rendered as bold.
+                        "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "italic": True or False, # Whether or not the text is italicized.
+                        "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                          "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a bookmark in this document.
+                            "tabId": "A String", # The ID of the tab containing this bookmark.
+                          },
+                          "bookmarkId": "A String", # The ID of a bookmark in this document.
+                          "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of the tab containing this heading.
+                          },
+                          "headingId": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of a tab in this document.
+                          "url": "A String", # An external URL.
+                        },
+                        "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                        "strikethrough": True or False, # Whether or not the text is struck through.
+                        "underline": True or False, # Whether or not the text is underlined.
+                        "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                          "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                          "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                        },
+                      },
+                      "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                        "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                        "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                        "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                        "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                        "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                        "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                        "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                        "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                        "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                        "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                        "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                      },
+                    },
+                  },
+                  "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this FootnoteReference.
+                    "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                    "bold": True or False, # Whether or not the text is rendered as bold.
+                    "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "italic": True or False, # Whether or not the text is italicized.
+                    "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                      "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a bookmark in this document.
+                        "tabId": "A String", # The ID of the tab containing this bookmark.
+                      },
+                      "bookmarkId": "A String", # The ID of a bookmark in this document.
+                      "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of the tab containing this heading.
+                      },
+                      "headingId": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of a tab in this document.
+                      "url": "A String", # An external URL.
+                    },
+                    "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                    "strikethrough": True or False, # Whether or not the text is struck through.
+                    "underline": True or False, # Whether or not the text is underlined.
+                    "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                      "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                      "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                    },
+                  },
+                },
+                "horizontalRule": { # A ParagraphElement representing a horizontal line. # A horizontal rule paragraph element.
+                  "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # The suggested insertion IDs. A HorizontalRule may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion.
+                    "A String",
+                  ],
+                  "suggestedTextStyleChanges": { # The suggested text style changes to this HorizontalRule, keyed by suggestion ID.
+                    "a_key": { # A suggested change to a TextStyle.
+                      "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                        "bold": True or False, # Whether or not the text is rendered as bold.
+                        "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "italic": True or False, # Whether or not the text is italicized.
+                        "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                          "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a bookmark in this document.
+                            "tabId": "A String", # The ID of the tab containing this bookmark.
+                          },
+                          "bookmarkId": "A String", # The ID of a bookmark in this document.
+                          "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of the tab containing this heading.
+                          },
+                          "headingId": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of a tab in this document.
+                          "url": "A String", # An external URL.
+                        },
+                        "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                        "strikethrough": True or False, # Whether or not the text is struck through.
+                        "underline": True or False, # Whether or not the text is underlined.
+                        "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                          "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                          "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                        },
+                      },
+                      "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                        "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                        "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                        "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                        "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                        "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                        "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                        "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                        "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                        "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                        "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                        "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                      },
+                    },
+                  },
+                  "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this HorizontalRule. Similar to text content, like text runs and footnote references, the text style of a horizontal rule can affect content layout as well as the styling of text inserted next to it.
+                    "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                    "bold": True or False, # Whether or not the text is rendered as bold.
+                    "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "italic": True or False, # Whether or not the text is italicized.
+                    "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                      "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a bookmark in this document.
+                        "tabId": "A String", # The ID of the tab containing this bookmark.
+                      },
+                      "bookmarkId": "A String", # The ID of a bookmark in this document.
+                      "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of the tab containing this heading.
+                      },
+                      "headingId": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of a tab in this document.
+                      "url": "A String", # An external URL.
+                    },
+                    "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                    "strikethrough": True or False, # Whether or not the text is struck through.
+                    "underline": True or False, # Whether or not the text is underlined.
+                    "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                      "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                      "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                    },
+                  },
+                },
+                "inlineObjectElement": { # A ParagraphElement that contains an InlineObject. # An inline object paragraph element.
+                  "inlineObjectId": "A String", # The ID of the InlineObject this element contains.
+                  "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # The suggested insertion IDs. An InlineObjectElement may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                    "A String",
+                  ],
+                  "suggestedTextStyleChanges": { # The suggested text style changes to this InlineObject, keyed by suggestion ID.
+                    "a_key": { # A suggested change to a TextStyle.
+                      "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                        "bold": True or False, # Whether or not the text is rendered as bold.
+                        "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "italic": True or False, # Whether or not the text is italicized.
+                        "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                          "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a bookmark in this document.
+                            "tabId": "A String", # The ID of the tab containing this bookmark.
+                          },
+                          "bookmarkId": "A String", # The ID of a bookmark in this document.
+                          "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of the tab containing this heading.
+                          },
+                          "headingId": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of a tab in this document.
+                          "url": "A String", # An external URL.
+                        },
+                        "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                        "strikethrough": True or False, # Whether or not the text is struck through.
+                        "underline": True or False, # Whether or not the text is underlined.
+                        "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                          "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                          "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                        },
+                      },
+                      "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                        "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                        "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                        "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                        "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                        "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                        "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                        "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                        "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                        "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                        "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                        "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                      },
+                    },
+                  },
+                  "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this InlineObjectElement. Similar to text content, like text runs and footnote references, the text style of an inline object element can affect content layout as well as the styling of text inserted next to it.
+                    "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                    "bold": True or False, # Whether or not the text is rendered as bold.
+                    "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "italic": True or False, # Whether or not the text is italicized.
+                    "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                      "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a bookmark in this document.
+                        "tabId": "A String", # The ID of the tab containing this bookmark.
+                      },
+                      "bookmarkId": "A String", # The ID of a bookmark in this document.
+                      "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of the tab containing this heading.
+                      },
+                      "headingId": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of a tab in this document.
+                      "url": "A String", # An external URL.
+                    },
+                    "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                    "strikethrough": True or False, # Whether or not the text is struck through.
+                    "underline": True or False, # Whether or not the text is underlined.
+                    "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                      "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                      "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                    },
+                  },
+                },
+                "pageBreak": { # A ParagraphElement representing a page break. A page break makes the subsequent text start at the top of the next page. # A page break paragraph element.
+                  "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # The suggested insertion IDs. A PageBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                    "A String",
+                  ],
+                  "suggestedTextStyleChanges": { # The suggested text style changes to this PageBreak, keyed by suggestion ID.
+                    "a_key": { # A suggested change to a TextStyle.
+                      "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                        "bold": True or False, # Whether or not the text is rendered as bold.
+                        "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "italic": True or False, # Whether or not the text is italicized.
+                        "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                          "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a bookmark in this document.
+                            "tabId": "A String", # The ID of the tab containing this bookmark.
+                          },
+                          "bookmarkId": "A String", # The ID of a bookmark in this document.
+                          "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of the tab containing this heading.
+                          },
+                          "headingId": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of a tab in this document.
+                          "url": "A String", # An external URL.
+                        },
+                        "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                        "strikethrough": True or False, # Whether or not the text is struck through.
+                        "underline": True or False, # Whether or not the text is underlined.
+                        "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                          "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                          "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                        },
+                      },
+                      "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                        "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                        "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                        "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                        "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                        "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                        "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                        "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                        "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                        "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                        "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                        "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                      },
+                    },
+                  },
+                  "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this PageBreak. Similar to text content, like text runs and footnote references, the text style of a page break can affect content layout as well as the styling of text inserted next to it.
+                    "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                    "bold": True or False, # Whether or not the text is rendered as bold.
+                    "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "italic": True or False, # Whether or not the text is italicized.
+                    "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                      "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a bookmark in this document.
+                        "tabId": "A String", # The ID of the tab containing this bookmark.
+                      },
+                      "bookmarkId": "A String", # The ID of a bookmark in this document.
+                      "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of the tab containing this heading.
+                      },
+                      "headingId": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of a tab in this document.
+                      "url": "A String", # An external URL.
+                    },
+                    "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                    "strikethrough": True or False, # Whether or not the text is struck through.
+                    "underline": True or False, # Whether or not the text is underlined.
+                    "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                      "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                      "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                    },
+                  },
+                },
+                "person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address.
+                  "personId": "A String", # Output only. The unique ID of this link.
+                  "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present.
+                    "email": "A String", # Output only. The email address linked to this Person. This field is always present.
+                    "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address.
+                  },
+                  "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # IDs for suggestions that insert this person link into the document. A Person might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion.
+                    "A String",
+                  ],
+                  "suggestedTextStyleChanges": { # The suggested text style changes to this Person, keyed by suggestion ID.
+                    "a_key": { # A suggested change to a TextStyle.
+                      "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                        "bold": True or False, # Whether or not the text is rendered as bold.
+                        "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "italic": True or False, # Whether or not the text is italicized.
+                        "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                          "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a bookmark in this document.
+                            "tabId": "A String", # The ID of the tab containing this bookmark.
+                          },
+                          "bookmarkId": "A String", # The ID of a bookmark in this document.
+                          "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of the tab containing this heading.
+                          },
+                          "headingId": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of a tab in this document.
+                          "url": "A String", # An external URL.
+                        },
+                        "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                        "strikethrough": True or False, # Whether or not the text is struck through.
+                        "underline": True or False, # Whether or not the text is underlined.
+                        "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                          "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                          "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                        },
+                      },
+                      "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                        "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                        "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                        "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                        "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                        "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                        "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                        "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                        "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                        "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                        "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                        "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                      },
+                    },
+                  },
+                  "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this Person.
+                    "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                    "bold": True or False, # Whether or not the text is rendered as bold.
+                    "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "italic": True or False, # Whether or not the text is italicized.
+                    "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                      "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a bookmark in this document.
+                        "tabId": "A String", # The ID of the tab containing this bookmark.
+                      },
+                      "bookmarkId": "A String", # The ID of a bookmark in this document.
+                      "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of the tab containing this heading.
+                      },
+                      "headingId": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of a tab in this document.
+                      "url": "A String", # An external URL.
+                    },
+                    "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                    "strikethrough": True or False, # Whether or not the text is struck through.
+                    "underline": True or False, # Whether or not the text is underlined.
+                    "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                      "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                      "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                    },
+                  },
+                },
+                "richLink": { # A link to a Google resource (such as a file in Drive, a YouTube video, or a Calendar event). # A paragraph element that links to a Google resource (such as a file in Google Drive, a YouTube video, or a Calendar event.)
+                  "richLinkId": "A String", # Output only. The ID of this link.
+                  "richLinkProperties": { # Properties specific to a RichLink. # Output only. The properties of this RichLink. This field is always present.
+                    "mimeType": "A String", # Output only. The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the RichLink, if there's one (for example, when it's a file in Drive).
+                    "title": "A String", # Output only. The title of the RichLink as displayed in the link. This title matches the title of the linked resource at the time of the insertion or last update of the link. This field is always present.
+                    "uri": "A String", # Output only. The URI to the RichLink. This is always present.
+                  },
+                  "suggestedDeletionIds": [ # IDs for suggestions that remove this link from the document. A RichLink might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # IDs for suggestions that insert this link into the document. A RichLink might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion.
+                    "A String",
+                  ],
+                  "suggestedTextStyleChanges": { # The suggested text style changes to this RichLink, keyed by suggestion ID.
+                    "a_key": { # A suggested change to a TextStyle.
+                      "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                        "bold": True or False, # Whether or not the text is rendered as bold.
+                        "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "italic": True or False, # Whether or not the text is italicized.
+                        "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                          "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a bookmark in this document.
+                            "tabId": "A String", # The ID of the tab containing this bookmark.
+                          },
+                          "bookmarkId": "A String", # The ID of a bookmark in this document.
+                          "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of the tab containing this heading.
+                          },
+                          "headingId": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of a tab in this document.
+                          "url": "A String", # An external URL.
+                        },
+                        "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                        "strikethrough": True or False, # Whether or not the text is struck through.
+                        "underline": True or False, # Whether or not the text is underlined.
+                        "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                          "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                          "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                        },
+                      },
+                      "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                        "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                        "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                        "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                        "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                        "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                        "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                        "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                        "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                        "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                        "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                        "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                      },
+                    },
+                  },
+                  "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this RichLink.
+                    "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                    "bold": True or False, # Whether or not the text is rendered as bold.
+                    "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "italic": True or False, # Whether or not the text is italicized.
+                    "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                      "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a bookmark in this document.
+                        "tabId": "A String", # The ID of the tab containing this bookmark.
+                      },
+                      "bookmarkId": "A String", # The ID of a bookmark in this document.
+                      "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of the tab containing this heading.
+                      },
+                      "headingId": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of a tab in this document.
+                      "url": "A String", # An external URL.
+                    },
+                    "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                    "strikethrough": True or False, # Whether or not the text is struck through.
+                    "underline": True or False, # Whether or not the text is underlined.
+                    "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                      "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                      "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                    },
+                  },
+                },
+                "startIndex": 42, # The zero-based start index of this paragraph element, in UTF-16 code units.
+                "textRun": { # A ParagraphElement that represents a run of text that all has the same styling. # A text run paragraph element.
+                  "content": "A String", # The text of this run. Any non-text elements in the run are replaced with the Unicode character U+E907.
+                  "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # The suggested insertion IDs. A TextRun may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                    "A String",
+                  ],
+                  "suggestedTextStyleChanges": { # The suggested text style changes to this run, keyed by suggestion ID.
+                    "a_key": { # A suggested change to a TextStyle.
+                      "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                        "bold": True or False, # Whether or not the text is rendered as bold.
+                        "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "italic": True or False, # Whether or not the text is italicized.
+                        "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                          "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a bookmark in this document.
+                            "tabId": "A String", # The ID of the tab containing this bookmark.
+                          },
+                          "bookmarkId": "A String", # The ID of a bookmark in this document.
+                          "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of the tab containing this heading.
+                          },
+                          "headingId": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of a tab in this document.
+                          "url": "A String", # An external URL.
+                        },
+                        "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                        "strikethrough": True or False, # Whether or not the text is struck through.
+                        "underline": True or False, # Whether or not the text is underlined.
+                        "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                          "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                          "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                        },
+                      },
+                      "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                        "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                        "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                        "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                        "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                        "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                        "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                        "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                        "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                        "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                        "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                        "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                      },
+                    },
+                  },
+                  "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this run.
+                    "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                    "bold": True or False, # Whether or not the text is rendered as bold.
+                    "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "italic": True or False, # Whether or not the text is italicized.
+                    "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                      "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a bookmark in this document.
+                        "tabId": "A String", # The ID of the tab containing this bookmark.
+                      },
+                      "bookmarkId": "A String", # The ID of a bookmark in this document.
+                      "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of the tab containing this heading.
+                      },
+                      "headingId": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of a tab in this document.
+                      "url": "A String", # An external URL.
+                    },
+                    "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                    "strikethrough": True or False, # Whether or not the text is struck through.
+                    "underline": True or False, # Whether or not the text is underlined.
+                    "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                      "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                      "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                    },
+                  },
+                },
+              },
+            ],
+            "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The style of this paragraph.
+              "alignment": "A String", # The text alignment for this paragraph.
+              "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent.
+              "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                  "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                    "rgbColor": { # An RGB color. # The RGB color value.
+                      "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                      "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                      "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                    },
+                  },
+                },
+                "dashStyle": "A String", # The dash style of the border.
+                "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+              },
+              "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                  "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                    "rgbColor": { # An RGB color. # The RGB color value.
+                      "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                      "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                      "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                    },
+                  },
+                },
+                "dashStyle": "A String", # The dash style of the border.
+                "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+              },
+              "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                  "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                    "rgbColor": { # An RGB color. # The RGB color value.
+                      "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                      "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                      "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                    },
+                  },
+                },
+                "dashStyle": "A String", # The dash style of the border.
+                "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+              },
+              "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                  "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                    "rgbColor": { # An RGB color. # The RGB color value.
+                      "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                      "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                      "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                    },
+                  },
+                },
+                "dashStyle": "A String", # The dash style of the border.
+                "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+              },
+              "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                  "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                    "rgbColor": { # An RGB color. # The RGB color value.
+                      "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                      "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                      "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                    },
+                  },
+                },
+                "dashStyle": "A String", # The dash style of the border.
+                "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+              },
+              "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited.
+              "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only.
+              "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent.
+              "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent.
+              "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent.
+              "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated.
+              "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error.
+              "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent.
+                "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading.
+                  "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                    "rgbColor": { # An RGB color. # The RGB color value.
+                      "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                      "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                      "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                    },
+                  },
+                },
+              },
+              "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "spacingMode": "A String", # The spacing mode for the paragraph.
+              "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only.
+                { # A tab stop within a paragraph.
+                  "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START.
+                  "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                },
+              ],
+            },
+            "positionedObjectIds": [ # The IDs of the positioned objects tethered to this paragraph.
+              "A String",
+            ],
+            "suggestedBulletChanges": { # The suggested changes to this paragraph's bullet.
+              "a_key": { # A suggested change to a Bullet.
+                "bullet": { # Describes the bullet of a paragraph. # A Bullet that only includes the changes made in this suggestion. This can be used along with the bullet_suggestion_state to see which fields have changed and their new values.
+                  "listId": "A String", # The ID of the list this paragraph belongs to.
+                  "nestingLevel": 42, # The nesting level of this paragraph in the list.
+                  "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet.
+                    "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                    "bold": True or False, # Whether or not the text is rendered as bold.
+                    "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "italic": True or False, # Whether or not the text is italicized.
+                    "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                      "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a bookmark in this document.
+                        "tabId": "A String", # The ID of the tab containing this bookmark.
+                      },
+                      "bookmarkId": "A String", # The ID of a bookmark in this document.
+                      "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of the tab containing this heading.
+                      },
+                      "headingId": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of a tab in this document.
+                      "url": "A String", # An external URL.
+                    },
+                    "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                    "strikethrough": True or False, # Whether or not the text is struck through.
+                    "underline": True or False, # Whether or not the text is underlined.
+                    "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                      "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                      "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                    },
+                  },
+                },
+                "bulletSuggestionState": { # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion.
+                  "listIdSuggested": True or False, # Indicates if there was a suggested change to the list_id.
+                  "nestingLevelSuggested": True or False, # Indicates if there was a suggested change to the nesting_level.
+                  "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion.
+                    "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                    "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                    "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                    "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                    "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                    "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                    "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                    "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                    "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                    "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                    "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                  },
+                },
+              },
+            },
+            "suggestedParagraphStyleChanges": { # The suggested paragraph style changes to this paragraph, keyed by suggestion ID.
+              "a_key": { # A suggested change to a ParagraphStyle.
+                "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A ParagraphStyle that only includes the changes made in this suggestion. This can be used along with the paragraph_style_suggestion_state to see which fields have changed and their new values.
+                  "alignment": "A String", # The text alignment for this paragraph.
+                  "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent.
+                  "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                    "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "dashStyle": "A String", # The dash style of the border.
+                    "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                  },
+                  "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                    "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "dashStyle": "A String", # The dash style of the border.
+                    "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                  },
+                  "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                    "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "dashStyle": "A String", # The dash style of the border.
+                    "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                  },
+                  "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                    "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "dashStyle": "A String", # The dash style of the border.
+                    "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                  },
+                  "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                    "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "dashStyle": "A String", # The dash style of the border.
+                    "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                  },
+                  "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited.
+                  "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only.
+                  "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent.
+                  "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent.
+                  "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent.
+                  "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated.
+                  "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error.
+                  "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent.
+                    "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                  },
+                  "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "spacingMode": "A String", # The spacing mode for the paragraph.
+                  "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only.
+                    { # A tab stop within a paragraph.
+                      "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START.
+                      "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                    },
+                  ],
+                },
+                "paragraphStyleSuggestionState": { # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion.
+                  "alignmentSuggested": True or False, # Indicates if there was a suggested change to alignment.
+                  "avoidWidowAndOrphanSuggested": True or False, # Indicates if there was a suggested change to avoid_widow_and_orphan.
+                  "borderBetweenSuggested": True or False, # Indicates if there was a suggested change to border_between.
+                  "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom.
+                  "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left.
+                  "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right.
+                  "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top.
+                  "directionSuggested": True or False, # Indicates if there was a suggested change to direction.
+                  "headingIdSuggested": True or False, # Indicates if there was a suggested change to heading_id.
+                  "indentEndSuggested": True or False, # Indicates if there was a suggested change to indent_end.
+                  "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line.
+                  "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start.
+                  "keepLinesTogetherSuggested": True or False, # Indicates if there was a suggested change to keep_lines_together.
+                  "keepWithNextSuggested": True or False, # Indicates if there was a suggested change to keep_with_next.
+                  "lineSpacingSuggested": True or False, # Indicates if there was a suggested change to line_spacing.
+                  "namedStyleTypeSuggested": True or False, # Indicates if there was a suggested change to named_style_type.
+                  "pageBreakBeforeSuggested": True or False, # Indicates if there was a suggested change to page_break_before.
+                  "shadingSuggestionState": { # A mask that indicates which of the fields on the base Shading have been changed in this suggested change. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in shading have been changed in this suggestion.
+                    "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to the Shading.
+                  },
+                  "spaceAboveSuggested": True or False, # Indicates if there was a suggested change to space_above.
+                  "spaceBelowSuggested": True or False, # Indicates if there was a suggested change to space_below.
+                  "spacingModeSuggested": True or False, # Indicates if there was a suggested change to spacing_mode.
+                },
+              },
+            },
+            "suggestedPositionedObjectIds": { # The IDs of the positioned objects suggested to be attached to this paragraph, keyed by suggestion ID.
+              "a_key": { # A collection of object IDs.
+                "objectIds": [ # The object IDs.
+                  "A String",
+                ],
+              },
+            },
+          },
+          "sectionBreak": { # A StructuralElement representing a section break. A section is a range of content that has the same SectionStyle. A section break represents the start of a new section, and the section style applies to the section after the section break. The document body always begins with a section break. # A section break type of structural element.
+            "sectionStyle": { # The styling that applies to a section. # The style of the section after this section break.
+              "columnProperties": [ # The section's columns properties. If empty, the section contains one column with the default properties in the Docs editor. A section can be updated to have no more than 3 columns. When updating this property, setting a concrete value is required. Unsetting this property will result in a 400 bad request error.
+                { # Properties that apply to a section's column.
+                  "paddingEnd": { # A magnitude in a single direction in the specified units. # The padding at the end of the column.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "width": { # A magnitude in a single direction in the specified units. # Output only. The width of the column.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                },
+              ],
+              "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+              "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+              "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only.
+              "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only.
+              "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only.
+              "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only.
+              "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only.
+              "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only.
+              "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+              "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+              "sectionType": "A String", # Output only. The type of section.
+              "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+            },
+            "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+              "A String",
+            ],
+            "suggestedInsertionIds": [ # The suggested insertion IDs. A SectionBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+              "A String",
+            ],
+          },
+          "startIndex": 42, # The zero-based start index of this structural element, in UTF-16 code units.
+          "table": { # A StructuralElement representing a table. # A table type of structural element.
+            "columns": 42, # Number of columns in the table. It's possible for a table to be non-rectangular, so some rows may have a different number of cells.
+            "rows": 42, # Number of rows in the table.
+            "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+              "A String",
+            ],
+            "suggestedInsertionIds": [ # The suggested insertion IDs. A Table may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+              "A String",
+            ],
+            "tableRows": [ # The contents and style of each row.
+              { # The contents and style of a row in a Table.
+                "endIndex": 42, # The zero-based end index of this row, exclusive, in UTF-16 code units.
+                "startIndex": 42, # The zero-based start index of this row, in UTF-16 code units.
+                "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                  "A String",
+                ],
+                "suggestedInsertionIds": [ # The suggested insertion IDs. A TableRow may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                  "A String",
+                ],
+                "suggestedTableRowStyleChanges": { # The suggested style changes to this row, keyed by suggestion ID.
+                  "a_key": { # A suggested change to a TableRowStyle.
+                    "tableRowStyle": { # Styles that apply to a table row. # A TableRowStyle that only includes the changes made in this suggestion. This can be used along with the table_row_style_suggestion_state to see which fields have changed and their new values.
+                      "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries.
+                      "tableHeader": True or False, # Whether the row is a table header.
+                    },
+                    "tableRowStyleSuggestionState": { # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion.
+                      "minRowHeightSuggested": True or False, # Indicates if there was a suggested change to min_row_height.
+                    },
+                  },
+                },
+                "tableCells": [ # The contents and style of each cell in this row. It's possible for a table to be non-rectangular, so some rows may have a different number of cells than other rows in the same table.
+                  { # The contents and style of a cell in a Table.
+                    "content": [ # The content of the cell.
+                      # Object with schema name: StructuralElement
+                    ],
+                    "endIndex": 42, # The zero-based end index of this cell, exclusive, in UTF-16 code units.
+                    "startIndex": 42, # The zero-based start index of this cell, in UTF-16 code units.
+                    "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                      "A String",
+                    ],
+                    "suggestedInsertionIds": [ # The suggested insertion IDs. A TableCell may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                      "A String",
+                    ],
+                    "suggestedTableCellStyleChanges": { # The suggested changes to the table cell style, keyed by suggestion ID.
+                      "a_key": { # A suggested change to a TableCellStyle.
+                        "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # A TableCellStyle that only includes the changes made in this suggestion. This can be used along with the table_cell_style_suggestion_state to see which fields have changed and their new values.
+                          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell.
+                            "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "dashStyle": "A String", # The dash style of the border.
+                            "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                          },
+                          "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell.
+                            "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "dashStyle": "A String", # The dash style of the border.
+                            "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                          },
+                          "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell.
+                            "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "dashStyle": "A String", # The dash style of the border.
+                            "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                          },
+                          "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell.
+                            "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "dashStyle": "A String", # The dash style of the border.
+                            "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                          },
+                          "columnSpan": 42, # The column span of the cell. This property is read-only.
+                          "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor.
+                          "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "rowSpan": 42, # The row span of the cell. This property is read-only.
+                        },
+                        "tableCellStyleSuggestionState": { # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion.
+                          "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                          "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom.
+                          "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left.
+                          "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right.
+                          "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top.
+                          "columnSpanSuggested": True or False, # Indicates if there was a suggested change to column_span.
+                          "contentAlignmentSuggested": True or False, # Indicates if there was a suggested change to content_alignment.
+                          "paddingBottomSuggested": True or False, # Indicates if there was a suggested change to padding_bottom.
+                          "paddingLeftSuggested": True or False, # Indicates if there was a suggested change to padding_left.
+                          "paddingRightSuggested": True or False, # Indicates if there was a suggested change to padding_right.
+                          "paddingTopSuggested": True or False, # Indicates if there was a suggested change to padding_top.
+                          "rowSpanSuggested": True or False, # Indicates if there was a suggested change to row_span.
+                        },
+                      },
+                    },
+                    "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # The style of the cell.
+                      "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell.
+                        "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "dashStyle": "A String", # The dash style of the border.
+                        "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                      },
+                      "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell.
+                        "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "dashStyle": "A String", # The dash style of the border.
+                        "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                      },
+                      "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell.
+                        "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "dashStyle": "A String", # The dash style of the border.
+                        "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                      },
+                      "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell.
+                        "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "dashStyle": "A String", # The dash style of the border.
+                        "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                      },
+                      "columnSpan": 42, # The column span of the cell. This property is read-only.
+                      "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor.
+                      "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "rowSpan": 42, # The row span of the cell. This property is read-only.
+                    },
+                  },
+                ],
+                "tableRowStyle": { # Styles that apply to a table row. # The style of the table row.
+                  "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries.
+                  "tableHeader": True or False, # Whether the row is a table header.
+                },
+              },
+            ],
+            "tableStyle": { # Styles that apply to a table. # The style of the table.
+              "tableColumnProperties": [ # The properties of each column. Note that in Docs, tables contain rows and rows contain cells, similar to HTML. So the properties for a row can be found on the row's table_row_style.
+                { # The properties of a column in a table.
+                  "width": { # A magnitude in a single direction in the specified units. # The width of the column. Set when the column's `width_type` is FIXED_WIDTH.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "widthType": "A String", # The width type of the column.
+                },
+              ],
+            },
+          },
+          "tableOfContents": { # A StructuralElement representing a table of contents. # A table of contents type of structural element.
+            "content": [ # The content of the table of contents.
+              # Object with schema name: StructuralElement
+            ],
+            "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+              "A String",
+            ],
+            "suggestedInsertionIds": [ # The suggested insertion IDs. A TableOfContents may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion.
+              "A String",
+            ],
+          },
+        },
+      ],
+      "headerId": "A String", # The ID of the header.
+    },
+  },
+  "inlineObjects": { # Output only. The inline objects in the document, keyed by object ID.
+    "a_key": { # An object that appears inline with text. An InlineObject contains an EmbeddedObject such as an image.
+      "inlineObjectProperties": { # Properties of an InlineObject. # The properties of this inline object.
+        "embeddedObject": { # An embedded object in the document. # The embedded object of this inline object.
+          "description": "A String", # The description of the embedded object. The `title` and `description` are both combined to display alt text.
+          "embeddedDrawingProperties": { # The properties of an embedded drawing and used to differentiate the object type. An embedded drawing is one that's created and edited within a document. Note that extensive details are not supported. # The properties of an embedded drawing.
+          },
+          "embeddedObjectBorder": { # A border around an EmbeddedObject. # The border of the embedded object.
+            "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                "rgbColor": { # An RGB color. # The RGB color value.
+                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                },
+              },
+            },
+            "dashStyle": "A String", # The dash style of the border.
+            "propertyState": "A String", # The property state of the border property.
+            "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+              "magnitude": 3.14, # The magnitude.
+              "unit": "A String", # The units for magnitude.
+            },
+          },
+          "imageProperties": { # The properties of an image. # The properties of an image.
+            "angle": 3.14, # The clockwise rotation angle of the image, in radians.
+            "brightness": 3.14, # The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect.
+            "contentUri": "A String", # A URI to the image with a default lifetime of 30 minutes. This URI is tagged with the account of the requester. Anyone with the URI effectively accesses the image as the original requester. Access to the image may be lost if the document's sharing settings change.
+            "contrast": 3.14, # The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect.
+            "cropProperties": { # The crop properties of an image. The crop rectangle is represented using fractional offsets from the original content's 4 edges. - If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the image's original bounding rectangle. - If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the image's original bounding rectangle. - If all offsets and rotation angle are 0, the image is not cropped. # The crop properties of the image.
+              "angle": 3.14, # The clockwise rotation angle of the crop rectangle around its center, in radians. Rotation is applied after the offsets.
+              "offsetBottom": 3.14, # The offset specifies how far inwards the bottom edge of the crop rectangle is from the bottom edge of the original content as a fraction of the original content's height.
+              "offsetLeft": 3.14, # The offset specifies how far inwards the left edge of the crop rectangle is from the left edge of the original content as a fraction of the original content's width.
+              "offsetRight": 3.14, # The offset specifies how far inwards the right edge of the crop rectangle is from the right edge of the original content as a fraction of the original content's width.
+              "offsetTop": 3.14, # The offset specifies how far inwards the top edge of the crop rectangle is from the top edge of the original content as a fraction of the original content's height.
+            },
+            "sourceUri": "A String", # The source URI is the URI used to insert the image. The source URI can be empty.
+            "transparency": 3.14, # The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means transparent.
+          },
+          "linkedContentReference": { # A reference to the external linked source content. # A reference to the external linked source content. For example, it contains a reference to the source Google Sheets chart when the embedded object is a linked chart. If unset, then the embedded object is not linked.
+            "sheetsChartReference": { # A reference to a linked chart embedded from Google Sheets. # A reference to the linked chart.
+              "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that's embedded.
+              "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart.
+            },
+          },
+          "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom margin of the embedded object.
+            "magnitude": 3.14, # The magnitude.
+            "unit": "A String", # The units for magnitude.
+          },
+          "marginLeft": { # A magnitude in a single direction in the specified units. # The left margin of the embedded object.
+            "magnitude": 3.14, # The magnitude.
+            "unit": "A String", # The units for magnitude.
+          },
+          "marginRight": { # A magnitude in a single direction in the specified units. # The right margin of the embedded object.
+            "magnitude": 3.14, # The magnitude.
+            "unit": "A String", # The units for magnitude.
+          },
+          "marginTop": { # A magnitude in a single direction in the specified units. # The top margin of the embedded object.
+            "magnitude": 3.14, # The magnitude.
+            "unit": "A String", # The units for magnitude.
+          },
+          "size": { # A width and height. # The visible size of the image after cropping.
+            "height": { # A magnitude in a single direction in the specified units. # The height of the object.
+              "magnitude": 3.14, # The magnitude.
+              "unit": "A String", # The units for magnitude.
+            },
+            "width": { # A magnitude in a single direction in the specified units. # The width of the object.
+              "magnitude": 3.14, # The magnitude.
+              "unit": "A String", # The units for magnitude.
+            },
+          },
+          "title": "A String", # The title of the embedded object. The `title` and `description` are both combined to display alt text.
+        },
+      },
+      "objectId": "A String", # The ID of this inline object. Can be used to update an object’s properties.
+      "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+        "A String",
+      ],
+      "suggestedInlineObjectPropertiesChanges": { # The suggested changes to the inline object properties, keyed by suggestion ID.
+        "a_key": { # A suggested change to InlineObjectProperties.
+          "inlineObjectProperties": { # Properties of an InlineObject. # An InlineObjectProperties that only includes the changes made in this suggestion. This can be used along with the inline_object_properties_suggestion_state to see which fields have changed and their new values.
+            "embeddedObject": { # An embedded object in the document. # The embedded object of this inline object.
+              "description": "A String", # The description of the embedded object. The `title` and `description` are both combined to display alt text.
+              "embeddedDrawingProperties": { # The properties of an embedded drawing and used to differentiate the object type. An embedded drawing is one that's created and edited within a document. Note that extensive details are not supported. # The properties of an embedded drawing.
+              },
+              "embeddedObjectBorder": { # A border around an EmbeddedObject. # The border of the embedded object.
+                "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                  "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                    "rgbColor": { # An RGB color. # The RGB color value.
+                      "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                      "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                      "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                    },
+                  },
+                },
+                "dashStyle": "A String", # The dash style of the border.
+                "propertyState": "A String", # The property state of the border property.
+                "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+              },
+              "imageProperties": { # The properties of an image. # The properties of an image.
+                "angle": 3.14, # The clockwise rotation angle of the image, in radians.
+                "brightness": 3.14, # The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect.
+                "contentUri": "A String", # A URI to the image with a default lifetime of 30 minutes. This URI is tagged with the account of the requester. Anyone with the URI effectively accesses the image as the original requester. Access to the image may be lost if the document's sharing settings change.
+                "contrast": 3.14, # The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect.
+                "cropProperties": { # The crop properties of an image. The crop rectangle is represented using fractional offsets from the original content's 4 edges. - If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the image's original bounding rectangle. - If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the image's original bounding rectangle. - If all offsets and rotation angle are 0, the image is not cropped. # The crop properties of the image.
+                  "angle": 3.14, # The clockwise rotation angle of the crop rectangle around its center, in radians. Rotation is applied after the offsets.
+                  "offsetBottom": 3.14, # The offset specifies how far inwards the bottom edge of the crop rectangle is from the bottom edge of the original content as a fraction of the original content's height.
+                  "offsetLeft": 3.14, # The offset specifies how far inwards the left edge of the crop rectangle is from the left edge of the original content as a fraction of the original content's width.
+                  "offsetRight": 3.14, # The offset specifies how far inwards the right edge of the crop rectangle is from the right edge of the original content as a fraction of the original content's width.
+                  "offsetTop": 3.14, # The offset specifies how far inwards the top edge of the crop rectangle is from the top edge of the original content as a fraction of the original content's height.
+                },
+                "sourceUri": "A String", # The source URI is the URI used to insert the image. The source URI can be empty.
+                "transparency": 3.14, # The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means transparent.
+              },
+              "linkedContentReference": { # A reference to the external linked source content. # A reference to the external linked source content. For example, it contains a reference to the source Google Sheets chart when the embedded object is a linked chart. If unset, then the embedded object is not linked.
+                "sheetsChartReference": { # A reference to a linked chart embedded from Google Sheets. # A reference to the linked chart.
+                  "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that's embedded.
+                  "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart.
+                },
+              },
+              "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom margin of the embedded object.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "marginLeft": { # A magnitude in a single direction in the specified units. # The left margin of the embedded object.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "marginRight": { # A magnitude in a single direction in the specified units. # The right margin of the embedded object.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "marginTop": { # A magnitude in a single direction in the specified units. # The top margin of the embedded object.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "size": { # A width and height. # The visible size of the image after cropping.
+                "height": { # A magnitude in a single direction in the specified units. # The height of the object.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "width": { # A magnitude in a single direction in the specified units. # The width of the object.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+              },
+              "title": "A String", # The title of the embedded object. The `title` and `description` are both combined to display alt text.
+            },
+          },
+          "inlineObjectPropertiesSuggestionState": { # A mask that indicates which of the fields on the base InlineObjectProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base InlineObjectProperties have been changed in this suggestion.
+            "embeddedObjectSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedObject have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_object have been changed in this suggestion.
+              "descriptionSuggested": True or False, # Indicates if there was a suggested change to description.
+              "embeddedDrawingPropertiesSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedDrawingProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_drawing_properties have been changed in this suggestion.
+              },
+              "embeddedObjectBorderSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedObjectBorder have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_object_border have been changed in this suggestion.
+                "colorSuggested": True or False, # Indicates if there was a suggested change to color.
+                "dashStyleSuggested": True or False, # Indicates if there was a suggested change to dash_style.
+                "propertyStateSuggested": True or False, # Indicates if there was a suggested change to property_state.
+                "widthSuggested": True or False, # Indicates if there was a suggested change to width.
+              },
+              "imagePropertiesSuggestionState": { # A mask that indicates which of the fields on the base ImageProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in image_properties have been changed in this suggestion.
+                "angleSuggested": True or False, # Indicates if there was a suggested change to angle.
+                "brightnessSuggested": True or False, # Indicates if there was a suggested change to brightness.
+                "contentUriSuggested": True or False, # Indicates if there was a suggested change to content_uri.
+                "contrastSuggested": True or False, # Indicates if there was a suggested change to contrast.
+                "cropPropertiesSuggestionState": { # A mask that indicates which of the fields on the base CropProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in crop_properties have been changed in this suggestion.
+                  "angleSuggested": True or False, # Indicates if there was a suggested change to angle.
+                  "offsetBottomSuggested": True or False, # Indicates if there was a suggested change to offset_bottom.
+                  "offsetLeftSuggested": True or False, # Indicates if there was a suggested change to offset_left.
+                  "offsetRightSuggested": True or False, # Indicates if there was a suggested change to offset_right.
+                  "offsetTopSuggested": True or False, # Indicates if there was a suggested change to offset_top.
+                },
+                "sourceUriSuggested": True or False, # Indicates if there was a suggested change to source_uri.
+                "transparencySuggested": True or False, # Indicates if there was a suggested change to transparency.
+              },
+              "linkedContentReferenceSuggestionState": { # A mask that indicates which of the fields on the base LinkedContentReference have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in linked_content_reference have been changed in this suggestion.
+                "sheetsChartReferenceSuggestionState": { # A mask that indicates which of the fields on the base SheetsChartReference have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in sheets_chart_reference have been changed in this suggestion.
+                  "chartIdSuggested": True or False, # Indicates if there was a suggested change to chart_id.
+                  "spreadsheetIdSuggested": True or False, # Indicates if there was a suggested change to spreadsheet_id.
+                },
+              },
+              "marginBottomSuggested": True or False, # Indicates if there was a suggested change to margin_bottom.
+              "marginLeftSuggested": True or False, # Indicates if there was a suggested change to margin_left.
+              "marginRightSuggested": True or False, # Indicates if there was a suggested change to margin_right.
+              "marginTopSuggested": True or False, # Indicates if there was a suggested change to margin_top.
+              "sizeSuggestionState": { # A mask that indicates which of the fields on the base Size have been changed in this suggestion. For any field set to true, the Size has a new suggested value. # A mask that indicates which of the fields in size have been changed in this suggestion.
+                "heightSuggested": True or False, # Indicates if there was a suggested change to height.
+                "widthSuggested": True or False, # Indicates if there was a suggested change to width.
+              },
+              "titleSuggested": True or False, # Indicates if there was a suggested change to title.
+            },
+          },
+        },
+      },
+      "suggestedInsertionId": "A String", # The suggested insertion ID. If empty, then this is not a suggested insertion.
+    },
+  },
+  "lists": { # Output only. The lists in the document, keyed by list ID.
+    "a_key": { # A List represents the list attributes for a group of paragraphs that all belong to the same list. A paragraph that's part of a list has a reference to the list's ID in its bullet.
+      "listProperties": { # The properties of a list that describe the look and feel of bullets belonging to paragraphs associated with a list. # The properties of the list.
+        "nestingLevels": [ # Describes the properties of the bullets at the associated level. A list has at most 9 levels of nesting with nesting level 0 corresponding to the top-most level and nesting level 8 corresponding to the most nested level. The nesting levels are returned in ascending order with the least nested returned first.
+          { # Contains properties describing the look and feel of a list bullet at a given level of nesting.
+            "bulletAlignment": "A String", # The alignment of the bullet within the space allotted for rendering the bullet.
+            "glyphFormat": "A String", # The format string used by bullets at this level of nesting. The glyph format contains one or more placeholders, and these placeholders are replaced with the appropriate values depending on the glyph_type or glyph_symbol. The placeholders follow the pattern `%[nesting_level]`. Furthermore, placeholders can have prefixes and suffixes. Thus, the glyph format follows the pattern `%[nesting_level]`. Note that the prefix and suffix are optional and can be arbitrary strings. For example, the glyph format `%0.` indicates that the rendered glyph will replace the placeholder with the corresponding glyph for nesting level 0 followed by a period as the suffix. So a list with a glyph type of UPPER_ALPHA and glyph format `%0.` at nesting level 0 will result in a list with rendered glyphs `A.` `B.` `C.` The glyph format can contain placeholders for the current nesting level as well as placeholders for parent nesting levels. For example, a list can have a glyph format of `%0.` at nesting level 0 and a glyph format of `%0.%1.` at nesting level 1. Assuming both nesting levels have DECIMAL glyph types, this would result in a list with rendered glyphs `1.` `2.` ` 2.1.` ` 2.2.` `3.` For nesting levels that are ordered, the string that replaces a placeholder in the glyph format for a particular paragraph depends on the paragraph's order within the list.
+            "glyphSymbol": "A String", # A custom glyph symbol used by bullets when paragraphs at this level of nesting are unordered. The glyph symbol replaces placeholders within the glyph_format. For example, if the glyph_symbol is the solid circle corresponding to Unicode U+25cf code point and the glyph_format is `%0`, the rendered glyph would be the solid circle.
+            "glyphType": "A String", # The type of glyph used by bullets when paragraphs at this level of nesting are ordered. The glyph type determines the type of glyph used to replace placeholders within the glyph_format when paragraphs at this level of nesting are ordered. For example, if the nesting level is 0, the glyph_format is `%0.` and the glyph type is DECIMAL, then the rendered glyph would replace the placeholder `%0` in the glyph format with a number corresponding to list item's order within the list.
+            "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of paragraphs at this level of nesting.
+              "magnitude": 3.14, # The magnitude.
+              "unit": "A String", # The units for magnitude.
+            },
+            "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for paragraphs at this level of nesting. Applied to the side that corresponds to the start of the text, based on the paragraph's content direction.
+              "magnitude": 3.14, # The magnitude.
+              "unit": "A String", # The units for magnitude.
+            },
+            "startNumber": 42, # The number of the first list item at this nesting level. A value of 0 is treated as a value of 1 for lettered lists and Roman numeral lists. For values of both 0 and 1, lettered and Roman numeral lists will begin at `a` and `i` respectively. This value is ignored for nesting levels with unordered glyphs.
+            "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of bullets at this level of nesting.
+              "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                  "rgbColor": { # An RGB color. # The RGB color value.
+                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                  },
+                },
+              },
+              "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+              "bold": True or False, # Whether or not the text is rendered as bold.
+              "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                  "rgbColor": { # An RGB color. # The RGB color value.
+                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                  },
+                },
+              },
+              "italic": True or False, # Whether or not the text is italicized.
+              "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                  "id": "A String", # The ID of a bookmark in this document.
+                  "tabId": "A String", # The ID of the tab containing this bookmark.
+                },
+                "bookmarkId": "A String", # The ID of a bookmark in this document.
+                "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                  "id": "A String", # The ID of a heading in this document.
+                  "tabId": "A String", # The ID of the tab containing this heading.
+                },
+                "headingId": "A String", # The ID of a heading in this document.
+                "tabId": "A String", # The ID of a tab in this document.
+                "url": "A String", # An external URL.
+              },
+              "smallCaps": True or False, # Whether or not the text is in small capital letters.
+              "strikethrough": True or False, # Whether or not the text is struck through.
+              "underline": True or False, # Whether or not the text is underlined.
+              "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+              },
+            },
+          },
+        ],
+      },
+      "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this list.
+        "A String",
+      ],
+      "suggestedInsertionId": "A String", # The suggested insertion ID. If empty, then this is not a suggested insertion.
+      "suggestedListPropertiesChanges": { # The suggested changes to the list properties, keyed by suggestion ID.
+        "a_key": { # A suggested change to ListProperties.
+          "listProperties": { # The properties of a list that describe the look and feel of bullets belonging to paragraphs associated with a list. # A ListProperties that only includes the changes made in this suggestion. This can be used along with the list_properties_suggestion_state to see which fields have changed and their new values.
+            "nestingLevels": [ # Describes the properties of the bullets at the associated level. A list has at most 9 levels of nesting with nesting level 0 corresponding to the top-most level and nesting level 8 corresponding to the most nested level. The nesting levels are returned in ascending order with the least nested returned first.
+              { # Contains properties describing the look and feel of a list bullet at a given level of nesting.
+                "bulletAlignment": "A String", # The alignment of the bullet within the space allotted for rendering the bullet.
+                "glyphFormat": "A String", # The format string used by bullets at this level of nesting. The glyph format contains one or more placeholders, and these placeholders are replaced with the appropriate values depending on the glyph_type or glyph_symbol. The placeholders follow the pattern `%[nesting_level]`. Furthermore, placeholders can have prefixes and suffixes. Thus, the glyph format follows the pattern `%[nesting_level]`. Note that the prefix and suffix are optional and can be arbitrary strings. For example, the glyph format `%0.` indicates that the rendered glyph will replace the placeholder with the corresponding glyph for nesting level 0 followed by a period as the suffix. So a list with a glyph type of UPPER_ALPHA and glyph format `%0.` at nesting level 0 will result in a list with rendered glyphs `A.` `B.` `C.` The glyph format can contain placeholders for the current nesting level as well as placeholders for parent nesting levels. For example, a list can have a glyph format of `%0.` at nesting level 0 and a glyph format of `%0.%1.` at nesting level 1. Assuming both nesting levels have DECIMAL glyph types, this would result in a list with rendered glyphs `1.` `2.` ` 2.1.` ` 2.2.` `3.` For nesting levels that are ordered, the string that replaces a placeholder in the glyph format for a particular paragraph depends on the paragraph's order within the list.
+                "glyphSymbol": "A String", # A custom glyph symbol used by bullets when paragraphs at this level of nesting are unordered. The glyph symbol replaces placeholders within the glyph_format. For example, if the glyph_symbol is the solid circle corresponding to Unicode U+25cf code point and the glyph_format is `%0`, the rendered glyph would be the solid circle.
+                "glyphType": "A String", # The type of glyph used by bullets when paragraphs at this level of nesting are ordered. The glyph type determines the type of glyph used to replace placeholders within the glyph_format when paragraphs at this level of nesting are ordered. For example, if the nesting level is 0, the glyph_format is `%0.` and the glyph type is DECIMAL, then the rendered glyph would replace the placeholder `%0` in the glyph format with a number corresponding to list item's order within the list.
+                "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of paragraphs at this level of nesting.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for paragraphs at this level of nesting. Applied to the side that corresponds to the start of the text, based on the paragraph's content direction.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "startNumber": 42, # The number of the first list item at this nesting level. A value of 0 is treated as a value of 1 for lettered lists and Roman numeral lists. For values of both 0 and 1, lettered and Roman numeral lists will begin at `a` and `i` respectively. This value is ignored for nesting levels with unordered glyphs.
+                "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of bullets at this level of nesting.
+                  "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                      "rgbColor": { # An RGB color. # The RGB color value.
+                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                      },
+                    },
+                  },
+                  "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                  "bold": True or False, # Whether or not the text is rendered as bold.
+                  "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                      "rgbColor": { # An RGB color. # The RGB color value.
+                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                      },
+                    },
+                  },
+                  "italic": True or False, # Whether or not the text is italicized.
+                  "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                    "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                      "id": "A String", # The ID of a bookmark in this document.
+                      "tabId": "A String", # The ID of the tab containing this bookmark.
+                    },
+                    "bookmarkId": "A String", # The ID of a bookmark in this document.
+                    "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                      "id": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of the tab containing this heading.
+                    },
+                    "headingId": "A String", # The ID of a heading in this document.
+                    "tabId": "A String", # The ID of a tab in this document.
+                    "url": "A String", # An external URL.
+                  },
+                  "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                  "strikethrough": True or False, # Whether or not the text is struck through.
+                  "underline": True or False, # Whether or not the text is underlined.
+                  "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                    "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                    "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                  },
+                },
+              },
+            ],
+          },
+          "listPropertiesSuggestionState": { # A mask that indicates which of the fields on the base ListProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base ListProperties have been changed in this suggestion.
+            "nestingLevelsSuggestionStates": [ # A mask that indicates which of the fields on the corresponding NestingLevel in nesting_levels have been changed in this suggestion. The nesting level suggestion states are returned in ascending order of the nesting level with the least nested returned first.
+              { # A mask that indicates which of the fields on the base NestingLevel have been changed in this suggestion. For any field set to true, there's a new suggested value.
+                "bulletAlignmentSuggested": True or False, # Indicates if there was a suggested change to bullet_alignment.
+                "glyphFormatSuggested": True or False, # Indicates if there was a suggested change to glyph_format.
+                "glyphSymbolSuggested": True or False, # Indicates if there was a suggested change to glyph_symbol.
+                "glyphTypeSuggested": True or False, # Indicates if there was a suggested change to glyph_type.
+                "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line.
+                "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start.
+                "startNumberSuggested": True or False, # Indicates if there was a suggested change to start_number.
+                "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion.
+                  "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                  "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                  "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                  "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                  "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                  "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                  "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                  "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                  "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                  "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                  "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                },
+              },
+            ],
+          },
+        },
+      },
+    },
+  },
+  "namedRanges": { # Output only. The named ranges in the document, keyed by name.
+    "a_key": { # A collection of all the NamedRanges in the document that share a given name.
+      "name": "A String", # The name that all the named ranges share.
+      "namedRanges": [ # The NamedRanges that share the same name.
+        { # A collection of Ranges with the same named range ID. Named ranges allow developers to associate parts of a document with an arbitrary user-defined label so their contents can be programmatically read or edited later. A document can contain multiple named ranges with the same name, but every named range has a unique ID. A named range is created with a single Range, and content inserted inside a named range generally expands that range. However, certain document changes can cause the range to be split into multiple ranges. Named ranges are not private. All applications and collaborators that have access to the document can see its named ranges.
+          "name": "A String", # The name of the named range.
+          "namedRangeId": "A String", # The ID of the named range.
+          "ranges": [ # The ranges that belong to this named range.
+            { # Specifies a contiguous range of text.
+              "endIndex": 42, # The zero-based end index of this range, exclusive, in UTF-16 code units. In all current uses, an end index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges.
+              "segmentId": "A String", # The ID of the header, footer, or footnote that this range is contained in. An empty segment ID signifies the document's body.
+              "startIndex": 42, # The zero-based start index of this range, in UTF-16 code units. In all current uses, a start index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges.
+              "tabId": "A String", # The tab that contains this range. When omitted, the request applies to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document.
+            },
+          ],
+        },
+      ],
+    },
+  },
+  "namedStyles": { # The named styles. Paragraphs in the document can inherit their TextStyle and ParagraphStyle from these named styles. # Output only. The named styles of the document.
+    "styles": [ # The named styles. There's an entry for each of the possible named style types.
+      { # A named style. Paragraphs in the document can inherit their TextStyle and ParagraphStyle from this named style when they have the same named style type.
+        "namedStyleType": "A String", # The type of this named style.
+        "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph style of this named style.
+          "alignment": "A String", # The text alignment for this paragraph.
+          "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent.
+          "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+            "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                "rgbColor": { # An RGB color. # The RGB color value.
+                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                },
+              },
+            },
+            "dashStyle": "A String", # The dash style of the border.
+            "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+              "magnitude": 3.14, # The magnitude.
+              "unit": "A String", # The units for magnitude.
+            },
+            "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+              "magnitude": 3.14, # The magnitude.
+              "unit": "A String", # The units for magnitude.
+            },
+          },
+          "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+            "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                "rgbColor": { # An RGB color. # The RGB color value.
+                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                },
+              },
+            },
+            "dashStyle": "A String", # The dash style of the border.
+            "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+              "magnitude": 3.14, # The magnitude.
+              "unit": "A String", # The units for magnitude.
+            },
+            "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+              "magnitude": 3.14, # The magnitude.
+              "unit": "A String", # The units for magnitude.
+            },
+          },
+          "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+            "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                "rgbColor": { # An RGB color. # The RGB color value.
+                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                },
+              },
+            },
+            "dashStyle": "A String", # The dash style of the border.
+            "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+              "magnitude": 3.14, # The magnitude.
+              "unit": "A String", # The units for magnitude.
+            },
+            "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+              "magnitude": 3.14, # The magnitude.
+              "unit": "A String", # The units for magnitude.
+            },
+          },
+          "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+            "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                "rgbColor": { # An RGB color. # The RGB color value.
+                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                },
+              },
+            },
+            "dashStyle": "A String", # The dash style of the border.
+            "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+              "magnitude": 3.14, # The magnitude.
+              "unit": "A String", # The units for magnitude.
+            },
+            "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+              "magnitude": 3.14, # The magnitude.
+              "unit": "A String", # The units for magnitude.
+            },
+          },
+          "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+            "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                "rgbColor": { # An RGB color. # The RGB color value.
+                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                },
+              },
+            },
+            "dashStyle": "A String", # The dash style of the border.
+            "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+              "magnitude": 3.14, # The magnitude.
+              "unit": "A String", # The units for magnitude.
+            },
+            "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+              "magnitude": 3.14, # The magnitude.
+              "unit": "A String", # The units for magnitude.
+            },
+          },
+          "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited.
+          "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only.
+          "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
+            "magnitude": 3.14, # The magnitude.
+            "unit": "A String", # The units for magnitude.
+          },
+          "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent.
+            "magnitude": 3.14, # The magnitude.
+            "unit": "A String", # The units for magnitude.
+          },
+          "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
+            "magnitude": 3.14, # The magnitude.
+            "unit": "A String", # The units for magnitude.
+          },
+          "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent.
+          "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent.
+          "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent.
+          "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated.
+          "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error.
+          "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent.
+            "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading.
+              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                "rgbColor": { # An RGB color. # The RGB color value.
+                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                },
+              },
+            },
+          },
+          "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent.
+            "magnitude": 3.14, # The magnitude.
+            "unit": "A String", # The units for magnitude.
+          },
+          "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent.
+            "magnitude": 3.14, # The magnitude.
+            "unit": "A String", # The units for magnitude.
+          },
+          "spacingMode": "A String", # The spacing mode for the paragraph.
+          "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only.
+            { # A tab stop within a paragraph.
+              "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START.
+              "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+            },
+          ],
+        },
+        "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this named style.
+          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+              "rgbColor": { # An RGB color. # The RGB color value.
+                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+              },
+            },
+          },
+          "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+          "bold": True or False, # Whether or not the text is rendered as bold.
+          "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+            "magnitude": 3.14, # The magnitude.
+            "unit": "A String", # The units for magnitude.
+          },
+          "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+              "rgbColor": { # An RGB color. # The RGB color value.
+                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+              },
+            },
+          },
+          "italic": True or False, # Whether or not the text is italicized.
+          "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+            "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+              "id": "A String", # The ID of a bookmark in this document.
+              "tabId": "A String", # The ID of the tab containing this bookmark.
+            },
+            "bookmarkId": "A String", # The ID of a bookmark in this document.
+            "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+              "id": "A String", # The ID of a heading in this document.
+              "tabId": "A String", # The ID of the tab containing this heading.
+            },
+            "headingId": "A String", # The ID of a heading in this document.
+            "tabId": "A String", # The ID of a tab in this document.
+            "url": "A String", # An external URL.
+          },
+          "smallCaps": True or False, # Whether or not the text is in small capital letters.
+          "strikethrough": True or False, # Whether or not the text is struck through.
+          "underline": True or False, # Whether or not the text is underlined.
+          "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+            "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+            "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+          },
+        },
+      },
+    ],
+  },
+  "positionedObjects": { # Output only. The positioned objects in the document, keyed by object ID.
+    "a_key": { # An object that's tethered to a Paragraph and positioned relative to the beginning of the paragraph. A PositionedObject contains an EmbeddedObject such as an image.
+      "objectId": "A String", # The ID of this positioned object.
+      "positionedObjectProperties": { # Properties of a PositionedObject. # The properties of this positioned object.
+        "embeddedObject": { # An embedded object in the document. # The embedded object of this positioned object.
+          "description": "A String", # The description of the embedded object. The `title` and `description` are both combined to display alt text.
+          "embeddedDrawingProperties": { # The properties of an embedded drawing and used to differentiate the object type. An embedded drawing is one that's created and edited within a document. Note that extensive details are not supported. # The properties of an embedded drawing.
+          },
+          "embeddedObjectBorder": { # A border around an EmbeddedObject. # The border of the embedded object.
+            "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                "rgbColor": { # An RGB color. # The RGB color value.
+                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                },
+              },
+            },
+            "dashStyle": "A String", # The dash style of the border.
+            "propertyState": "A String", # The property state of the border property.
+            "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+              "magnitude": 3.14, # The magnitude.
+              "unit": "A String", # The units for magnitude.
+            },
+          },
+          "imageProperties": { # The properties of an image. # The properties of an image.
+            "angle": 3.14, # The clockwise rotation angle of the image, in radians.
+            "brightness": 3.14, # The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect.
+            "contentUri": "A String", # A URI to the image with a default lifetime of 30 minutes. This URI is tagged with the account of the requester. Anyone with the URI effectively accesses the image as the original requester. Access to the image may be lost if the document's sharing settings change.
+            "contrast": 3.14, # The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect.
+            "cropProperties": { # The crop properties of an image. The crop rectangle is represented using fractional offsets from the original content's 4 edges. - If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the image's original bounding rectangle. - If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the image's original bounding rectangle. - If all offsets and rotation angle are 0, the image is not cropped. # The crop properties of the image.
+              "angle": 3.14, # The clockwise rotation angle of the crop rectangle around its center, in radians. Rotation is applied after the offsets.
+              "offsetBottom": 3.14, # The offset specifies how far inwards the bottom edge of the crop rectangle is from the bottom edge of the original content as a fraction of the original content's height.
+              "offsetLeft": 3.14, # The offset specifies how far inwards the left edge of the crop rectangle is from the left edge of the original content as a fraction of the original content's width.
+              "offsetRight": 3.14, # The offset specifies how far inwards the right edge of the crop rectangle is from the right edge of the original content as a fraction of the original content's width.
+              "offsetTop": 3.14, # The offset specifies how far inwards the top edge of the crop rectangle is from the top edge of the original content as a fraction of the original content's height.
+            },
+            "sourceUri": "A String", # The source URI is the URI used to insert the image. The source URI can be empty.
+            "transparency": 3.14, # The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means transparent.
+          },
+          "linkedContentReference": { # A reference to the external linked source content. # A reference to the external linked source content. For example, it contains a reference to the source Google Sheets chart when the embedded object is a linked chart. If unset, then the embedded object is not linked.
+            "sheetsChartReference": { # A reference to a linked chart embedded from Google Sheets. # A reference to the linked chart.
+              "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that's embedded.
+              "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart.
+            },
+          },
+          "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom margin of the embedded object.
+            "magnitude": 3.14, # The magnitude.
+            "unit": "A String", # The units for magnitude.
+          },
+          "marginLeft": { # A magnitude in a single direction in the specified units. # The left margin of the embedded object.
+            "magnitude": 3.14, # The magnitude.
+            "unit": "A String", # The units for magnitude.
+          },
+          "marginRight": { # A magnitude in a single direction in the specified units. # The right margin of the embedded object.
+            "magnitude": 3.14, # The magnitude.
+            "unit": "A String", # The units for magnitude.
+          },
+          "marginTop": { # A magnitude in a single direction in the specified units. # The top margin of the embedded object.
+            "magnitude": 3.14, # The magnitude.
+            "unit": "A String", # The units for magnitude.
+          },
+          "size": { # A width and height. # The visible size of the image after cropping.
+            "height": { # A magnitude in a single direction in the specified units. # The height of the object.
+              "magnitude": 3.14, # The magnitude.
+              "unit": "A String", # The units for magnitude.
+            },
+            "width": { # A magnitude in a single direction in the specified units. # The width of the object.
+              "magnitude": 3.14, # The magnitude.
+              "unit": "A String", # The units for magnitude.
+            },
+          },
+          "title": "A String", # The title of the embedded object. The `title` and `description` are both combined to display alt text.
+        },
+        "positioning": { # The positioning of a PositionedObject. The positioned object is positioned relative to the beginning of the Paragraph it's tethered to. # The positioning of this positioned object relative to the newline of the Paragraph that references this positioned object.
+          "layout": "A String", # The layout of this positioned object.
+          "leftOffset": { # A magnitude in a single direction in the specified units. # The offset of the left edge of the positioned object relative to the beginning of the Paragraph it's tethered to. The exact positioning of the object can depend on other content in the document and the document's styling.
+            "magnitude": 3.14, # The magnitude.
+            "unit": "A String", # The units for magnitude.
+          },
+          "topOffset": { # A magnitude in a single direction in the specified units. # The offset of the top edge of the positioned object relative to the beginning of the Paragraph it's tethered to. The exact positioning of the object can depend on other content in the document and the document's styling.
+            "magnitude": 3.14, # The magnitude.
+            "unit": "A String", # The units for magnitude.
+          },
+        },
+      },
+      "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+        "A String",
+      ],
+      "suggestedInsertionId": "A String", # The suggested insertion ID. If empty, then this is not a suggested insertion.
+      "suggestedPositionedObjectPropertiesChanges": { # The suggested changes to the positioned object properties, keyed by suggestion ID.
+        "a_key": { # A suggested change to PositionedObjectProperties.
+          "positionedObjectProperties": { # Properties of a PositionedObject. # A PositionedObjectProperties that only includes the changes made in this suggestion. This can be used along with the positioned_object_properties_suggestion_state to see which fields have changed and their new values.
+            "embeddedObject": { # An embedded object in the document. # The embedded object of this positioned object.
+              "description": "A String", # The description of the embedded object. The `title` and `description` are both combined to display alt text.
+              "embeddedDrawingProperties": { # The properties of an embedded drawing and used to differentiate the object type. An embedded drawing is one that's created and edited within a document. Note that extensive details are not supported. # The properties of an embedded drawing.
+              },
+              "embeddedObjectBorder": { # A border around an EmbeddedObject. # The border of the embedded object.
+                "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                  "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                    "rgbColor": { # An RGB color. # The RGB color value.
+                      "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                      "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                      "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                    },
+                  },
+                },
+                "dashStyle": "A String", # The dash style of the border.
+                "propertyState": "A String", # The property state of the border property.
+                "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+              },
+              "imageProperties": { # The properties of an image. # The properties of an image.
+                "angle": 3.14, # The clockwise rotation angle of the image, in radians.
+                "brightness": 3.14, # The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect.
+                "contentUri": "A String", # A URI to the image with a default lifetime of 30 minutes. This URI is tagged with the account of the requester. Anyone with the URI effectively accesses the image as the original requester. Access to the image may be lost if the document's sharing settings change.
+                "contrast": 3.14, # The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect.
+                "cropProperties": { # The crop properties of an image. The crop rectangle is represented using fractional offsets from the original content's 4 edges. - If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the image's original bounding rectangle. - If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the image's original bounding rectangle. - If all offsets and rotation angle are 0, the image is not cropped. # The crop properties of the image.
+                  "angle": 3.14, # The clockwise rotation angle of the crop rectangle around its center, in radians. Rotation is applied after the offsets.
+                  "offsetBottom": 3.14, # The offset specifies how far inwards the bottom edge of the crop rectangle is from the bottom edge of the original content as a fraction of the original content's height.
+                  "offsetLeft": 3.14, # The offset specifies how far inwards the left edge of the crop rectangle is from the left edge of the original content as a fraction of the original content's width.
+                  "offsetRight": 3.14, # The offset specifies how far inwards the right edge of the crop rectangle is from the right edge of the original content as a fraction of the original content's width.
+                  "offsetTop": 3.14, # The offset specifies how far inwards the top edge of the crop rectangle is from the top edge of the original content as a fraction of the original content's height.
+                },
+                "sourceUri": "A String", # The source URI is the URI used to insert the image. The source URI can be empty.
+                "transparency": 3.14, # The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means transparent.
+              },
+              "linkedContentReference": { # A reference to the external linked source content. # A reference to the external linked source content. For example, it contains a reference to the source Google Sheets chart when the embedded object is a linked chart. If unset, then the embedded object is not linked.
+                "sheetsChartReference": { # A reference to a linked chart embedded from Google Sheets. # A reference to the linked chart.
+                  "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that's embedded.
+                  "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart.
+                },
+              },
+              "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom margin of the embedded object.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "marginLeft": { # A magnitude in a single direction in the specified units. # The left margin of the embedded object.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "marginRight": { # A magnitude in a single direction in the specified units. # The right margin of the embedded object.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "marginTop": { # A magnitude in a single direction in the specified units. # The top margin of the embedded object.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "size": { # A width and height. # The visible size of the image after cropping.
+                "height": { # A magnitude in a single direction in the specified units. # The height of the object.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "width": { # A magnitude in a single direction in the specified units. # The width of the object.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+              },
+              "title": "A String", # The title of the embedded object. The `title` and `description` are both combined to display alt text.
+            },
+            "positioning": { # The positioning of a PositionedObject. The positioned object is positioned relative to the beginning of the Paragraph it's tethered to. # The positioning of this positioned object relative to the newline of the Paragraph that references this positioned object.
+              "layout": "A String", # The layout of this positioned object.
+              "leftOffset": { # A magnitude in a single direction in the specified units. # The offset of the left edge of the positioned object relative to the beginning of the Paragraph it's tethered to. The exact positioning of the object can depend on other content in the document and the document's styling.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "topOffset": { # A magnitude in a single direction in the specified units. # The offset of the top edge of the positioned object relative to the beginning of the Paragraph it's tethered to. The exact positioning of the object can depend on other content in the document and the document's styling.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+            },
+          },
+          "positionedObjectPropertiesSuggestionState": { # A mask that indicates which of the fields on the base PositionedObjectProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base PositionedObjectProperties have been changed in this suggestion.
+            "embeddedObjectSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedObject have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_object have been changed in this suggestion.
+              "descriptionSuggested": True or False, # Indicates if there was a suggested change to description.
+              "embeddedDrawingPropertiesSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedDrawingProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_drawing_properties have been changed in this suggestion.
+              },
+              "embeddedObjectBorderSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedObjectBorder have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_object_border have been changed in this suggestion.
+                "colorSuggested": True or False, # Indicates if there was a suggested change to color.
+                "dashStyleSuggested": True or False, # Indicates if there was a suggested change to dash_style.
+                "propertyStateSuggested": True or False, # Indicates if there was a suggested change to property_state.
+                "widthSuggested": True or False, # Indicates if there was a suggested change to width.
+              },
+              "imagePropertiesSuggestionState": { # A mask that indicates which of the fields on the base ImageProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in image_properties have been changed in this suggestion.
+                "angleSuggested": True or False, # Indicates if there was a suggested change to angle.
+                "brightnessSuggested": True or False, # Indicates if there was a suggested change to brightness.
+                "contentUriSuggested": True or False, # Indicates if there was a suggested change to content_uri.
+                "contrastSuggested": True or False, # Indicates if there was a suggested change to contrast.
+                "cropPropertiesSuggestionState": { # A mask that indicates which of the fields on the base CropProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in crop_properties have been changed in this suggestion.
+                  "angleSuggested": True or False, # Indicates if there was a suggested change to angle.
+                  "offsetBottomSuggested": True or False, # Indicates if there was a suggested change to offset_bottom.
+                  "offsetLeftSuggested": True or False, # Indicates if there was a suggested change to offset_left.
+                  "offsetRightSuggested": True or False, # Indicates if there was a suggested change to offset_right.
+                  "offsetTopSuggested": True or False, # Indicates if there was a suggested change to offset_top.
+                },
+                "sourceUriSuggested": True or False, # Indicates if there was a suggested change to source_uri.
+                "transparencySuggested": True or False, # Indicates if there was a suggested change to transparency.
+              },
+              "linkedContentReferenceSuggestionState": { # A mask that indicates which of the fields on the base LinkedContentReference have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in linked_content_reference have been changed in this suggestion.
+                "sheetsChartReferenceSuggestionState": { # A mask that indicates which of the fields on the base SheetsChartReference have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in sheets_chart_reference have been changed in this suggestion.
+                  "chartIdSuggested": True or False, # Indicates if there was a suggested change to chart_id.
+                  "spreadsheetIdSuggested": True or False, # Indicates if there was a suggested change to spreadsheet_id.
+                },
+              },
+              "marginBottomSuggested": True or False, # Indicates if there was a suggested change to margin_bottom.
+              "marginLeftSuggested": True or False, # Indicates if there was a suggested change to margin_left.
+              "marginRightSuggested": True or False, # Indicates if there was a suggested change to margin_right.
+              "marginTopSuggested": True or False, # Indicates if there was a suggested change to margin_top.
+              "sizeSuggestionState": { # A mask that indicates which of the fields on the base Size have been changed in this suggestion. For any field set to true, the Size has a new suggested value. # A mask that indicates which of the fields in size have been changed in this suggestion.
+                "heightSuggested": True or False, # Indicates if there was a suggested change to height.
+                "widthSuggested": True or False, # Indicates if there was a suggested change to width.
+              },
+              "titleSuggested": True or False, # Indicates if there was a suggested change to title.
+            },
+            "positioningSuggestionState": { # A mask that indicates which of the fields on the base PositionedObjectPositioning have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in positioning have been changed in this suggestion.
+              "layoutSuggested": True or False, # Indicates if there was a suggested change to layout.
+              "leftOffsetSuggested": True or False, # Indicates if there was a suggested change to left_offset.
+              "topOffsetSuggested": True or False, # Indicates if there was a suggested change to top_offset.
+            },
+          },
+        },
+      },
+    },
+  },
+  "revisionId": "A String", # Output only. The revision ID of the document. Can be used in update requests to specify which revision of a document to apply updates to and how the request should behave if the document has been edited since that revision. Only populated if the user has edit access to the document. The revision ID is not a sequential number but an opaque string. The format of the revision ID might change over time. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the document has not changed. Conversely, a changed ID (for the same document and user) usually means the document has been updated. However, a changed ID can also be due to internal factors such as ID format changes.
+  "suggestedDocumentStyleChanges": { # Output only. The suggested changes to the style of the document, keyed by suggestion ID.
+    "a_key": { # A suggested change to the DocumentStyle.
+      "documentStyle": { # The style of the document. # A DocumentStyle that only includes the changes made in this suggestion. This can be used along with the document_style_suggestion_state to see which fields have changed and their new values.
+        "background": { # Represents the background of a document. # The background of the document. Documents cannot have a transparent background color.
+          "color": { # A color that can either be fully opaque or fully transparent. # The background color.
+            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+              "rgbColor": { # An RGB color. # The RGB color value.
+                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+              },
+            },
+          },
+        },
+        "defaultFooterId": "A String", # The ID of the default footer. If not set, there's no default footer. This property is read-only.
+        "defaultHeaderId": "A String", # The ID of the default header. If not set, there's no default header. This property is read-only.
+        "evenPageFooterId": "A String", # The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. This property is read-only.
+        "evenPageHeaderId": "A String", # The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. This property is read-only.
+        "firstPageFooterId": "A String", # The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. This property is read-only.
+        "firstPageHeaderId": "A String", # The ID of the header used only for the first page. If not set then a unique header for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_header_id or this value for the header on the first page. If not set, there's no first page header. This property is read-only.
+        "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of the page_size, which allows changing the page orientation between portrait and landscape.
+        "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin. Updating the bottom page margin on the document style clears the bottom page margin on all section styles.
+          "magnitude": 3.14, # The magnitude.
+          "unit": "A String", # The units for magnitude.
+        },
+        "marginFooter": { # A magnitude in a single direction in the specified units. # The amount of space between the bottom of the page and the contents of the footer.
+          "magnitude": 3.14, # The magnitude.
+          "unit": "A String", # The units for magnitude.
+        },
+        "marginHeader": { # A magnitude in a single direction in the specified units. # The amount of space between the top of the page and the contents of the header.
+          "magnitude": 3.14, # The magnitude.
+          "unit": "A String", # The units for magnitude.
+        },
+        "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin. Updating the left page margin on the document style clears the left page margin on all section styles. It may also cause columns to resize in all sections.
+          "magnitude": 3.14, # The magnitude.
+          "unit": "A String", # The units for magnitude.
+        },
+        "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin. Updating the right page margin on the document style clears the right page margin on all section styles. It may also cause columns to resize in all sections.
+          "magnitude": 3.14, # The magnitude.
+          "unit": "A String", # The units for magnitude.
+        },
+        "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin. Updating the top page margin on the document style clears the top page margin on all section styles.
+          "magnitude": 3.14, # The magnitude.
+          "unit": "A String", # The units for magnitude.
+        },
+        "pageNumberStart": 42, # The page number from which to start counting the number of pages.
+        "pageSize": { # A width and height. # The size of a page in the document.
+          "height": { # A magnitude in a single direction in the specified units. # The height of the object.
+            "magnitude": 3.14, # The magnitude.
+            "unit": "A String", # The units for magnitude.
+          },
+          "width": { # A magnitude in a single direction in the specified units. # The width of the object.
+            "magnitude": 3.14, # The magnitude.
+            "unit": "A String", # The units for magnitude.
+          },
+        },
+        "useCustomHeaderFooterMargins": True or False, # Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected. When false, the default values in the Docs editor for header and footer margin are used. This property is read-only.
+        "useEvenPageHeaderFooter": True or False, # Indicates whether to use the even page header / footer IDs for the even pages.
+        "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page.
+      },
+      "documentStyleSuggestionState": { # A mask that indicates which of the fields on the base DocumentStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DocumentStyle have been changed in this suggestion.
+        "backgroundSuggestionState": { # A mask that indicates which of the fields on the base Background have been changed in this suggestion. For any field set to true, the Backgound has a new suggested value. # A mask that indicates which of the fields in background have been changed in this suggestion.
+          "backgroundColorSuggested": True or False, # Indicates whether the current background color has been modified in this suggestion.
+        },
+        "defaultFooterIdSuggested": True or False, # Indicates if there was a suggested change to default_footer_id.
+        "defaultHeaderIdSuggested": True or False, # Indicates if there was a suggested change to default_header_id.
+        "evenPageFooterIdSuggested": True or False, # Indicates if there was a suggested change to even_page_footer_id.
+        "evenPageHeaderIdSuggested": True or False, # Indicates if there was a suggested change to even_page_header_id.
+        "firstPageFooterIdSuggested": True or False, # Indicates if there was a suggested change to first_page_footer_id.
+        "firstPageHeaderIdSuggested": True or False, # Indicates if there was a suggested change to first_page_header_id.
+        "flipPageOrientationSuggested": True or False, # Optional. Indicates if there was a suggested change to flip_page_orientation.
+        "marginBottomSuggested": True or False, # Indicates if there was a suggested change to margin_bottom.
+        "marginFooterSuggested": True or False, # Indicates if there was a suggested change to margin_footer.
+        "marginHeaderSuggested": True or False, # Indicates if there was a suggested change to margin_header.
+        "marginLeftSuggested": True or False, # Indicates if there was a suggested change to margin_left.
+        "marginRightSuggested": True or False, # Indicates if there was a suggested change to margin_right.
+        "marginTopSuggested": True or False, # Indicates if there was a suggested change to margin_top.
+        "pageNumberStartSuggested": True or False, # Indicates if there was a suggested change to page_number_start.
+        "pageSizeSuggestionState": { # A mask that indicates which of the fields on the base Size have been changed in this suggestion. For any field set to true, the Size has a new suggested value. # A mask that indicates which of the fields in size have been changed in this suggestion.
+          "heightSuggested": True or False, # Indicates if there was a suggested change to height.
+          "widthSuggested": True or False, # Indicates if there was a suggested change to width.
+        },
+        "useCustomHeaderFooterMarginsSuggested": True or False, # Indicates if there was a suggested change to use_custom_header_footer_margins.
+        "useEvenPageHeaderFooterSuggested": True or False, # Indicates if there was a suggested change to use_even_page_header_footer.
+        "useFirstPageHeaderFooterSuggested": True or False, # Indicates if there was a suggested change to use_first_page_header_footer.
+      },
+    },
+  },
+  "suggestedNamedStylesChanges": { # Output only. The suggested changes to the named styles of the document, keyed by suggestion ID.
+    "a_key": { # A suggested change to the NamedStyles.
+      "namedStyles": { # The named styles. Paragraphs in the document can inherit their TextStyle and ParagraphStyle from these named styles. # A NamedStyles that only includes the changes made in this suggestion. This can be used along with the named_styles_suggestion_state to see which fields have changed and their new values.
+        "styles": [ # The named styles. There's an entry for each of the possible named style types.
+          { # A named style. Paragraphs in the document can inherit their TextStyle and ParagraphStyle from this named style when they have the same named style type.
+            "namedStyleType": "A String", # The type of this named style.
+            "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph style of this named style.
+              "alignment": "A String", # The text alignment for this paragraph.
+              "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent.
+              "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                  "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                    "rgbColor": { # An RGB color. # The RGB color value.
+                      "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                      "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                      "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                    },
+                  },
+                },
+                "dashStyle": "A String", # The dash style of the border.
+                "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+              },
+              "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                  "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                    "rgbColor": { # An RGB color. # The RGB color value.
+                      "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                      "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                      "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                    },
+                  },
+                },
+                "dashStyle": "A String", # The dash style of the border.
+                "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+              },
+              "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                  "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                    "rgbColor": { # An RGB color. # The RGB color value.
+                      "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                      "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                      "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                    },
+                  },
+                },
+                "dashStyle": "A String", # The dash style of the border.
+                "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+              },
+              "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                  "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                    "rgbColor": { # An RGB color. # The RGB color value.
+                      "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                      "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                      "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                    },
+                  },
+                },
+                "dashStyle": "A String", # The dash style of the border.
+                "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+              },
+              "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                  "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                    "rgbColor": { # An RGB color. # The RGB color value.
+                      "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                      "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                      "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                    },
+                  },
+                },
+                "dashStyle": "A String", # The dash style of the border.
+                "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+              },
+              "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited.
+              "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only.
+              "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent.
+              "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent.
+              "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent.
+              "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated.
+              "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error.
+              "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent.
+                "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading.
+                  "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                    "rgbColor": { # An RGB color. # The RGB color value.
+                      "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                      "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                      "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                    },
+                  },
+                },
+              },
+              "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "spacingMode": "A String", # The spacing mode for the paragraph.
+              "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only.
+                { # A tab stop within a paragraph.
+                  "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START.
+                  "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                },
+              ],
+            },
+            "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this named style.
+              "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                  "rgbColor": { # An RGB color. # The RGB color value.
+                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                  },
+                },
+              },
+              "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+              "bold": True or False, # Whether or not the text is rendered as bold.
+              "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
                 "magnitude": 3.14, # The magnitude.
                 "unit": "A String", # The units for magnitude.
               },
-              "marginTop": { # A magnitude in a single direction in the specified units. # The top margin of the embedded object.
-                "magnitude": 3.14, # The magnitude.
-                "unit": "A String", # The units for magnitude.
+              "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                  "rgbColor": { # An RGB color. # The RGB color value.
+                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                  },
+                },
+              },
+              "italic": True or False, # Whether or not the text is italicized.
+              "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                  "id": "A String", # The ID of a bookmark in this document.
+                  "tabId": "A String", # The ID of the tab containing this bookmark.
+                },
+                "bookmarkId": "A String", # The ID of a bookmark in this document.
+                "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                  "id": "A String", # The ID of a heading in this document.
+                  "tabId": "A String", # The ID of the tab containing this heading.
+                },
+                "headingId": "A String", # The ID of a heading in this document.
+                "tabId": "A String", # The ID of a tab in this document.
+                "url": "A String", # An external URL.
+              },
+              "smallCaps": True or False, # Whether or not the text is in small capital letters.
+              "strikethrough": True or False, # Whether or not the text is struck through.
+              "underline": True or False, # Whether or not the text is underlined.
+              "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+              },
+            },
+          },
+        ],
+      },
+      "namedStylesSuggestionState": { # The suggestion state of a NamedStyles message. # A mask that indicates which of the fields on the base NamedStyles have been changed in this suggestion.
+        "stylesSuggestionStates": [ # A mask that indicates which of the fields on the corresponding NamedStyle in styles have been changed in this suggestion. The order of these named style suggestion states matches the order of the corresponding named style within the named styles suggestion.
+          { # A suggestion state of a NamedStyle message.
+            "namedStyleType": "A String", # The named style type that this suggestion state corresponds to. This field is provided as a convenience for matching the NamedStyleSuggestionState with its corresponding NamedStyle.
+            "paragraphStyleSuggestionState": { # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in paragraph style have been changed in this suggestion.
+              "alignmentSuggested": True or False, # Indicates if there was a suggested change to alignment.
+              "avoidWidowAndOrphanSuggested": True or False, # Indicates if there was a suggested change to avoid_widow_and_orphan.
+              "borderBetweenSuggested": True or False, # Indicates if there was a suggested change to border_between.
+              "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom.
+              "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left.
+              "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right.
+              "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top.
+              "directionSuggested": True or False, # Indicates if there was a suggested change to direction.
+              "headingIdSuggested": True or False, # Indicates if there was a suggested change to heading_id.
+              "indentEndSuggested": True or False, # Indicates if there was a suggested change to indent_end.
+              "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line.
+              "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start.
+              "keepLinesTogetherSuggested": True or False, # Indicates if there was a suggested change to keep_lines_together.
+              "keepWithNextSuggested": True or False, # Indicates if there was a suggested change to keep_with_next.
+              "lineSpacingSuggested": True or False, # Indicates if there was a suggested change to line_spacing.
+              "namedStyleTypeSuggested": True or False, # Indicates if there was a suggested change to named_style_type.
+              "pageBreakBeforeSuggested": True or False, # Indicates if there was a suggested change to page_break_before.
+              "shadingSuggestionState": { # A mask that indicates which of the fields on the base Shading have been changed in this suggested change. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in shading have been changed in this suggestion.
+                "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to the Shading.
+              },
+              "spaceAboveSuggested": True or False, # Indicates if there was a suggested change to space_above.
+              "spaceBelowSuggested": True or False, # Indicates if there was a suggested change to space_below.
+              "spacingModeSuggested": True or False, # Indicates if there was a suggested change to spacing_mode.
+            },
+            "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion.
+              "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+              "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+              "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+              "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+              "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+              "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+              "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+              "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+              "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+              "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+              "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+            },
+          },
+        ],
+      },
+    },
+  },
+  "suggestionsViewMode": "A String", # Output only. The suggestions view mode applied to the document. Note: When editing a document, changes must be based on a document with SUGGESTIONS_INLINE.
+  "tabs": [ # Tabs that are part of a document. Tabs can contain child tabs, a tab nested within another tab. Child tabs are represented by the Tab.child_tabs field.
+    { # A tab in a document.
+      "childTabs": [ # The child tabs nested within this tab.
+        # Object with schema name: Tab
+      ],
+      "documentTab": { # A tab with document contents. # A tab with document contents, like text and images.
+        "body": { # The document body. The body typically contains the full document contents except for headers, footers, and footnotes. # The main body of the document tab.
+          "content": [ # The contents of the body. The indexes for the body's content begin at zero.
+            { # A StructuralElement describes content that provides structure to the document.
+              "endIndex": 42, # The zero-based end index of this structural element, exclusive, in UTF-16 code units.
+              "paragraph": { # A StructuralElement representing a paragraph. A paragraph is a range of content that's terminated with a newline character. # A paragraph type of structural element.
+                "bullet": { # Describes the bullet of a paragraph. # The bullet for this paragraph. If not present, the paragraph does not belong to a list.
+                  "listId": "A String", # The ID of the list this paragraph belongs to.
+                  "nestingLevel": 42, # The nesting level of this paragraph in the list.
+                  "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet.
+                    "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                    "bold": True or False, # Whether or not the text is rendered as bold.
+                    "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "italic": True or False, # Whether or not the text is italicized.
+                    "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                      "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a bookmark in this document.
+                        "tabId": "A String", # The ID of the tab containing this bookmark.
+                      },
+                      "bookmarkId": "A String", # The ID of a bookmark in this document.
+                      "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of the tab containing this heading.
+                      },
+                      "headingId": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of a tab in this document.
+                      "url": "A String", # An external URL.
+                    },
+                    "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                    "strikethrough": True or False, # Whether or not the text is struck through.
+                    "underline": True or False, # Whether or not the text is underlined.
+                    "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                      "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                      "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                    },
+                  },
+                },
+                "elements": [ # The content of the paragraph, broken down into its component parts.
+                  { # A ParagraphElement describes content within a Paragraph.
+                    "autoText": { # A ParagraphElement representing a spot in the text that's dynamically replaced with content that can change over time, like a page number. # An auto text paragraph element.
+                      "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                        "A String",
+                      ],
+                      "suggestedInsertionIds": [ # The suggested insertion IDs. An AutoText may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                        "A String",
+                      ],
+                      "suggestedTextStyleChanges": { # The suggested text style changes to this AutoText, keyed by suggestion ID.
+                        "a_key": { # A suggested change to a TextStyle.
+                          "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                            "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                            "bold": True or False, # Whether or not the text is rendered as bold.
+                            "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                            "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "italic": True or False, # Whether or not the text is italicized.
+                            "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                              "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                "id": "A String", # The ID of a bookmark in this document.
+                                "tabId": "A String", # The ID of the tab containing this bookmark.
+                              },
+                              "bookmarkId": "A String", # The ID of a bookmark in this document.
+                              "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                "id": "A String", # The ID of a heading in this document.
+                                "tabId": "A String", # The ID of the tab containing this heading.
+                              },
+                              "headingId": "A String", # The ID of a heading in this document.
+                              "tabId": "A String", # The ID of a tab in this document.
+                              "url": "A String", # An external URL.
+                            },
+                            "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                            "strikethrough": True or False, # Whether or not the text is struck through.
+                            "underline": True or False, # Whether or not the text is underlined.
+                            "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                              "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                              "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                            },
+                          },
+                          "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                            "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                            "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                            "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                            "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                            "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                            "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                            "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                            "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                            "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                            "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                            "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                          },
+                        },
+                      },
+                      "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this AutoText.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                        "bold": True or False, # Whether or not the text is rendered as bold.
+                        "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "italic": True or False, # Whether or not the text is italicized.
+                        "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                          "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a bookmark in this document.
+                            "tabId": "A String", # The ID of the tab containing this bookmark.
+                          },
+                          "bookmarkId": "A String", # The ID of a bookmark in this document.
+                          "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of the tab containing this heading.
+                          },
+                          "headingId": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of a tab in this document.
+                          "url": "A String", # An external URL.
+                        },
+                        "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                        "strikethrough": True or False, # Whether or not the text is struck through.
+                        "underline": True or False, # Whether or not the text is underlined.
+                        "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                          "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                          "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                        },
+                      },
+                      "type": "A String", # The type of this auto text.
+                    },
+                    "columnBreak": { # A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column. # A column break paragraph element.
+                      "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                        "A String",
+                      ],
+                      "suggestedInsertionIds": [ # The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                        "A String",
+                      ],
+                      "suggestedTextStyleChanges": { # The suggested text style changes to this ColumnBreak, keyed by suggestion ID.
+                        "a_key": { # A suggested change to a TextStyle.
+                          "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                            "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                            "bold": True or False, # Whether or not the text is rendered as bold.
+                            "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                            "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "italic": True or False, # Whether or not the text is italicized.
+                            "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                              "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                "id": "A String", # The ID of a bookmark in this document.
+                                "tabId": "A String", # The ID of the tab containing this bookmark.
+                              },
+                              "bookmarkId": "A String", # The ID of a bookmark in this document.
+                              "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                "id": "A String", # The ID of a heading in this document.
+                                "tabId": "A String", # The ID of the tab containing this heading.
+                              },
+                              "headingId": "A String", # The ID of a heading in this document.
+                              "tabId": "A String", # The ID of a tab in this document.
+                              "url": "A String", # An external URL.
+                            },
+                            "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                            "strikethrough": True or False, # Whether or not the text is struck through.
+                            "underline": True or False, # Whether or not the text is underlined.
+                            "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                              "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                              "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                            },
+                          },
+                          "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                            "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                            "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                            "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                            "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                            "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                            "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                            "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                            "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                            "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                            "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                            "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                          },
+                        },
+                      },
+                      "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                        "bold": True or False, # Whether or not the text is rendered as bold.
+                        "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "italic": True or False, # Whether or not the text is italicized.
+                        "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                          "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a bookmark in this document.
+                            "tabId": "A String", # The ID of the tab containing this bookmark.
+                          },
+                          "bookmarkId": "A String", # The ID of a bookmark in this document.
+                          "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of the tab containing this heading.
+                          },
+                          "headingId": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of a tab in this document.
+                          "url": "A String", # An external URL.
+                        },
+                        "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                        "strikethrough": True or False, # Whether or not the text is struck through.
+                        "underline": True or False, # Whether or not the text is underlined.
+                        "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                          "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                          "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                        },
+                      },
+                    },
+                    "endIndex": 42, # The zero-base end index of this paragraph element, exclusive, in UTF-16 code units.
+                    "equation": { # A ParagraphElement representing an equation. # An equation paragraph element.
+                      "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                        "A String",
+                      ],
+                      "suggestedInsertionIds": [ # The suggested insertion IDs. An Equation may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                        "A String",
+                      ],
+                    },
+                    "footnoteReference": { # A ParagraphElement representing a footnote reference. A footnote reference is the inline content rendered with a number and is used to identify the footnote. # A footnote reference paragraph element.
+                      "footnoteId": "A String", # The ID of the footnote that contains the content of this footnote reference.
+                      "footnoteNumber": "A String", # The rendered number of this footnote.
+                      "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                        "A String",
+                      ],
+                      "suggestedInsertionIds": [ # The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                        "A String",
+                      ],
+                      "suggestedTextStyleChanges": { # The suggested text style changes to this FootnoteReference, keyed by suggestion ID.
+                        "a_key": { # A suggested change to a TextStyle.
+                          "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                            "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                            "bold": True or False, # Whether or not the text is rendered as bold.
+                            "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                            "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "italic": True or False, # Whether or not the text is italicized.
+                            "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                              "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                "id": "A String", # The ID of a bookmark in this document.
+                                "tabId": "A String", # The ID of the tab containing this bookmark.
+                              },
+                              "bookmarkId": "A String", # The ID of a bookmark in this document.
+                              "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                "id": "A String", # The ID of a heading in this document.
+                                "tabId": "A String", # The ID of the tab containing this heading.
+                              },
+                              "headingId": "A String", # The ID of a heading in this document.
+                              "tabId": "A String", # The ID of a tab in this document.
+                              "url": "A String", # An external URL.
+                            },
+                            "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                            "strikethrough": True or False, # Whether or not the text is struck through.
+                            "underline": True or False, # Whether or not the text is underlined.
+                            "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                              "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                              "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                            },
+                          },
+                          "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                            "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                            "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                            "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                            "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                            "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                            "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                            "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                            "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                            "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                            "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                            "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                          },
+                        },
+                      },
+                      "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this FootnoteReference.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                        "bold": True or False, # Whether or not the text is rendered as bold.
+                        "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "italic": True or False, # Whether or not the text is italicized.
+                        "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                          "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a bookmark in this document.
+                            "tabId": "A String", # The ID of the tab containing this bookmark.
+                          },
+                          "bookmarkId": "A String", # The ID of a bookmark in this document.
+                          "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of the tab containing this heading.
+                          },
+                          "headingId": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of a tab in this document.
+                          "url": "A String", # An external URL.
+                        },
+                        "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                        "strikethrough": True or False, # Whether or not the text is struck through.
+                        "underline": True or False, # Whether or not the text is underlined.
+                        "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                          "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                          "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                        },
+                      },
+                    },
+                    "horizontalRule": { # A ParagraphElement representing a horizontal line. # A horizontal rule paragraph element.
+                      "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                        "A String",
+                      ],
+                      "suggestedInsertionIds": [ # The suggested insertion IDs. A HorizontalRule may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion.
+                        "A String",
+                      ],
+                      "suggestedTextStyleChanges": { # The suggested text style changes to this HorizontalRule, keyed by suggestion ID.
+                        "a_key": { # A suggested change to a TextStyle.
+                          "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                            "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                            "bold": True or False, # Whether or not the text is rendered as bold.
+                            "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                            "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "italic": True or False, # Whether or not the text is italicized.
+                            "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                              "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                "id": "A String", # The ID of a bookmark in this document.
+                                "tabId": "A String", # The ID of the tab containing this bookmark.
+                              },
+                              "bookmarkId": "A String", # The ID of a bookmark in this document.
+                              "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                "id": "A String", # The ID of a heading in this document.
+                                "tabId": "A String", # The ID of the tab containing this heading.
+                              },
+                              "headingId": "A String", # The ID of a heading in this document.
+                              "tabId": "A String", # The ID of a tab in this document.
+                              "url": "A String", # An external URL.
+                            },
+                            "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                            "strikethrough": True or False, # Whether or not the text is struck through.
+                            "underline": True or False, # Whether or not the text is underlined.
+                            "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                              "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                              "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                            },
+                          },
+                          "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                            "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                            "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                            "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                            "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                            "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                            "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                            "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                            "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                            "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                            "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                            "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                          },
+                        },
+                      },
+                      "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this HorizontalRule. Similar to text content, like text runs and footnote references, the text style of a horizontal rule can affect content layout as well as the styling of text inserted next to it.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                        "bold": True or False, # Whether or not the text is rendered as bold.
+                        "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "italic": True or False, # Whether or not the text is italicized.
+                        "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                          "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a bookmark in this document.
+                            "tabId": "A String", # The ID of the tab containing this bookmark.
+                          },
+                          "bookmarkId": "A String", # The ID of a bookmark in this document.
+                          "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of the tab containing this heading.
+                          },
+                          "headingId": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of a tab in this document.
+                          "url": "A String", # An external URL.
+                        },
+                        "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                        "strikethrough": True or False, # Whether or not the text is struck through.
+                        "underline": True or False, # Whether or not the text is underlined.
+                        "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                          "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                          "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                        },
+                      },
+                    },
+                    "inlineObjectElement": { # A ParagraphElement that contains an InlineObject. # An inline object paragraph element.
+                      "inlineObjectId": "A String", # The ID of the InlineObject this element contains.
+                      "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                        "A String",
+                      ],
+                      "suggestedInsertionIds": [ # The suggested insertion IDs. An InlineObjectElement may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                        "A String",
+                      ],
+                      "suggestedTextStyleChanges": { # The suggested text style changes to this InlineObject, keyed by suggestion ID.
+                        "a_key": { # A suggested change to a TextStyle.
+                          "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                            "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                            "bold": True or False, # Whether or not the text is rendered as bold.
+                            "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                            "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "italic": True or False, # Whether or not the text is italicized.
+                            "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                              "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                "id": "A String", # The ID of a bookmark in this document.
+                                "tabId": "A String", # The ID of the tab containing this bookmark.
+                              },
+                              "bookmarkId": "A String", # The ID of a bookmark in this document.
+                              "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                "id": "A String", # The ID of a heading in this document.
+                                "tabId": "A String", # The ID of the tab containing this heading.
+                              },
+                              "headingId": "A String", # The ID of a heading in this document.
+                              "tabId": "A String", # The ID of a tab in this document.
+                              "url": "A String", # An external URL.
+                            },
+                            "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                            "strikethrough": True or False, # Whether or not the text is struck through.
+                            "underline": True or False, # Whether or not the text is underlined.
+                            "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                              "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                              "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                            },
+                          },
+                          "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                            "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                            "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                            "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                            "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                            "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                            "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                            "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                            "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                            "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                            "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                            "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                          },
+                        },
+                      },
+                      "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this InlineObjectElement. Similar to text content, like text runs and footnote references, the text style of an inline object element can affect content layout as well as the styling of text inserted next to it.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                        "bold": True or False, # Whether or not the text is rendered as bold.
+                        "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "italic": True or False, # Whether or not the text is italicized.
+                        "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                          "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a bookmark in this document.
+                            "tabId": "A String", # The ID of the tab containing this bookmark.
+                          },
+                          "bookmarkId": "A String", # The ID of a bookmark in this document.
+                          "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of the tab containing this heading.
+                          },
+                          "headingId": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of a tab in this document.
+                          "url": "A String", # An external URL.
+                        },
+                        "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                        "strikethrough": True or False, # Whether or not the text is struck through.
+                        "underline": True or False, # Whether or not the text is underlined.
+                        "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                          "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                          "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                        },
+                      },
+                    },
+                    "pageBreak": { # A ParagraphElement representing a page break. A page break makes the subsequent text start at the top of the next page. # A page break paragraph element.
+                      "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                        "A String",
+                      ],
+                      "suggestedInsertionIds": [ # The suggested insertion IDs. A PageBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                        "A String",
+                      ],
+                      "suggestedTextStyleChanges": { # The suggested text style changes to this PageBreak, keyed by suggestion ID.
+                        "a_key": { # A suggested change to a TextStyle.
+                          "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                            "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                            "bold": True or False, # Whether or not the text is rendered as bold.
+                            "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                            "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "italic": True or False, # Whether or not the text is italicized.
+                            "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                              "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                "id": "A String", # The ID of a bookmark in this document.
+                                "tabId": "A String", # The ID of the tab containing this bookmark.
+                              },
+                              "bookmarkId": "A String", # The ID of a bookmark in this document.
+                              "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                "id": "A String", # The ID of a heading in this document.
+                                "tabId": "A String", # The ID of the tab containing this heading.
+                              },
+                              "headingId": "A String", # The ID of a heading in this document.
+                              "tabId": "A String", # The ID of a tab in this document.
+                              "url": "A String", # An external URL.
+                            },
+                            "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                            "strikethrough": True or False, # Whether or not the text is struck through.
+                            "underline": True or False, # Whether or not the text is underlined.
+                            "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                              "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                              "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                            },
+                          },
+                          "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                            "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                            "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                            "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                            "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                            "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                            "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                            "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                            "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                            "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                            "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                            "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                          },
+                        },
+                      },
+                      "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this PageBreak. Similar to text content, like text runs and footnote references, the text style of a page break can affect content layout as well as the styling of text inserted next to it.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                        "bold": True or False, # Whether or not the text is rendered as bold.
+                        "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "italic": True or False, # Whether or not the text is italicized.
+                        "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                          "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a bookmark in this document.
+                            "tabId": "A String", # The ID of the tab containing this bookmark.
+                          },
+                          "bookmarkId": "A String", # The ID of a bookmark in this document.
+                          "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of the tab containing this heading.
+                          },
+                          "headingId": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of a tab in this document.
+                          "url": "A String", # An external URL.
+                        },
+                        "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                        "strikethrough": True or False, # Whether or not the text is struck through.
+                        "underline": True or False, # Whether or not the text is underlined.
+                        "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                          "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                          "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                        },
+                      },
+                    },
+                    "person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address.
+                      "personId": "A String", # Output only. The unique ID of this link.
+                      "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present.
+                        "email": "A String", # Output only. The email address linked to this Person. This field is always present.
+                        "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address.
+                      },
+                      "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion.
+                        "A String",
+                      ],
+                      "suggestedInsertionIds": [ # IDs for suggestions that insert this person link into the document. A Person might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion.
+                        "A String",
+                      ],
+                      "suggestedTextStyleChanges": { # The suggested text style changes to this Person, keyed by suggestion ID.
+                        "a_key": { # A suggested change to a TextStyle.
+                          "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                            "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                            "bold": True or False, # Whether or not the text is rendered as bold.
+                            "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                            "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "italic": True or False, # Whether or not the text is italicized.
+                            "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                              "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                "id": "A String", # The ID of a bookmark in this document.
+                                "tabId": "A String", # The ID of the tab containing this bookmark.
+                              },
+                              "bookmarkId": "A String", # The ID of a bookmark in this document.
+                              "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                "id": "A String", # The ID of a heading in this document.
+                                "tabId": "A String", # The ID of the tab containing this heading.
+                              },
+                              "headingId": "A String", # The ID of a heading in this document.
+                              "tabId": "A String", # The ID of a tab in this document.
+                              "url": "A String", # An external URL.
+                            },
+                            "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                            "strikethrough": True or False, # Whether or not the text is struck through.
+                            "underline": True or False, # Whether or not the text is underlined.
+                            "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                              "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                              "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                            },
+                          },
+                          "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                            "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                            "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                            "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                            "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                            "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                            "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                            "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                            "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                            "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                            "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                            "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                          },
+                        },
+                      },
+                      "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this Person.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                        "bold": True or False, # Whether or not the text is rendered as bold.
+                        "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "italic": True or False, # Whether or not the text is italicized.
+                        "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                          "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a bookmark in this document.
+                            "tabId": "A String", # The ID of the tab containing this bookmark.
+                          },
+                          "bookmarkId": "A String", # The ID of a bookmark in this document.
+                          "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of the tab containing this heading.
+                          },
+                          "headingId": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of a tab in this document.
+                          "url": "A String", # An external URL.
+                        },
+                        "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                        "strikethrough": True or False, # Whether or not the text is struck through.
+                        "underline": True or False, # Whether or not the text is underlined.
+                        "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                          "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                          "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                        },
+                      },
+                    },
+                    "richLink": { # A link to a Google resource (such as a file in Drive, a YouTube video, or a Calendar event). # A paragraph element that links to a Google resource (such as a file in Google Drive, a YouTube video, or a Calendar event.)
+                      "richLinkId": "A String", # Output only. The ID of this link.
+                      "richLinkProperties": { # Properties specific to a RichLink. # Output only. The properties of this RichLink. This field is always present.
+                        "mimeType": "A String", # Output only. The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the RichLink, if there's one (for example, when it's a file in Drive).
+                        "title": "A String", # Output only. The title of the RichLink as displayed in the link. This title matches the title of the linked resource at the time of the insertion or last update of the link. This field is always present.
+                        "uri": "A String", # Output only. The URI to the RichLink. This is always present.
+                      },
+                      "suggestedDeletionIds": [ # IDs for suggestions that remove this link from the document. A RichLink might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion.
+                        "A String",
+                      ],
+                      "suggestedInsertionIds": [ # IDs for suggestions that insert this link into the document. A RichLink might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion.
+                        "A String",
+                      ],
+                      "suggestedTextStyleChanges": { # The suggested text style changes to this RichLink, keyed by suggestion ID.
+                        "a_key": { # A suggested change to a TextStyle.
+                          "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                            "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                            "bold": True or False, # Whether or not the text is rendered as bold.
+                            "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                            "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "italic": True or False, # Whether or not the text is italicized.
+                            "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                              "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                "id": "A String", # The ID of a bookmark in this document.
+                                "tabId": "A String", # The ID of the tab containing this bookmark.
+                              },
+                              "bookmarkId": "A String", # The ID of a bookmark in this document.
+                              "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                "id": "A String", # The ID of a heading in this document.
+                                "tabId": "A String", # The ID of the tab containing this heading.
+                              },
+                              "headingId": "A String", # The ID of a heading in this document.
+                              "tabId": "A String", # The ID of a tab in this document.
+                              "url": "A String", # An external URL.
+                            },
+                            "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                            "strikethrough": True or False, # Whether or not the text is struck through.
+                            "underline": True or False, # Whether or not the text is underlined.
+                            "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                              "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                              "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                            },
+                          },
+                          "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                            "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                            "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                            "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                            "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                            "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                            "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                            "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                            "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                            "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                            "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                            "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                          },
+                        },
+                      },
+                      "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this RichLink.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                        "bold": True or False, # Whether or not the text is rendered as bold.
+                        "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "italic": True or False, # Whether or not the text is italicized.
+                        "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                          "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a bookmark in this document.
+                            "tabId": "A String", # The ID of the tab containing this bookmark.
+                          },
+                          "bookmarkId": "A String", # The ID of a bookmark in this document.
+                          "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of the tab containing this heading.
+                          },
+                          "headingId": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of a tab in this document.
+                          "url": "A String", # An external URL.
+                        },
+                        "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                        "strikethrough": True or False, # Whether or not the text is struck through.
+                        "underline": True or False, # Whether or not the text is underlined.
+                        "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                          "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                          "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                        },
+                      },
+                    },
+                    "startIndex": 42, # The zero-based start index of this paragraph element, in UTF-16 code units.
+                    "textRun": { # A ParagraphElement that represents a run of text that all has the same styling. # A text run paragraph element.
+                      "content": "A String", # The text of this run. Any non-text elements in the run are replaced with the Unicode character U+E907.
+                      "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                        "A String",
+                      ],
+                      "suggestedInsertionIds": [ # The suggested insertion IDs. A TextRun may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                        "A String",
+                      ],
+                      "suggestedTextStyleChanges": { # The suggested text style changes to this run, keyed by suggestion ID.
+                        "a_key": { # A suggested change to a TextStyle.
+                          "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                            "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                            "bold": True or False, # Whether or not the text is rendered as bold.
+                            "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                            "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "italic": True or False, # Whether or not the text is italicized.
+                            "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                              "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                "id": "A String", # The ID of a bookmark in this document.
+                                "tabId": "A String", # The ID of the tab containing this bookmark.
+                              },
+                              "bookmarkId": "A String", # The ID of a bookmark in this document.
+                              "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                "id": "A String", # The ID of a heading in this document.
+                                "tabId": "A String", # The ID of the tab containing this heading.
+                              },
+                              "headingId": "A String", # The ID of a heading in this document.
+                              "tabId": "A String", # The ID of a tab in this document.
+                              "url": "A String", # An external URL.
+                            },
+                            "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                            "strikethrough": True or False, # Whether or not the text is struck through.
+                            "underline": True or False, # Whether or not the text is underlined.
+                            "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                              "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                              "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                            },
+                          },
+                          "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                            "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                            "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                            "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                            "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                            "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                            "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                            "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                            "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                            "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                            "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                            "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                          },
+                        },
+                      },
+                      "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this run.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                        "bold": True or False, # Whether or not the text is rendered as bold.
+                        "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "italic": True or False, # Whether or not the text is italicized.
+                        "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                          "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a bookmark in this document.
+                            "tabId": "A String", # The ID of the tab containing this bookmark.
+                          },
+                          "bookmarkId": "A String", # The ID of a bookmark in this document.
+                          "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of the tab containing this heading.
+                          },
+                          "headingId": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of a tab in this document.
+                          "url": "A String", # An external URL.
+                        },
+                        "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                        "strikethrough": True or False, # Whether or not the text is struck through.
+                        "underline": True or False, # Whether or not the text is underlined.
+                        "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                          "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                          "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                        },
+                      },
+                    },
+                  },
+                ],
+                "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The style of this paragraph.
+                  "alignment": "A String", # The text alignment for this paragraph.
+                  "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent.
+                  "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                    "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "dashStyle": "A String", # The dash style of the border.
+                    "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                  },
+                  "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                    "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "dashStyle": "A String", # The dash style of the border.
+                    "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                  },
+                  "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                    "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "dashStyle": "A String", # The dash style of the border.
+                    "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                  },
+                  "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                    "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "dashStyle": "A String", # The dash style of the border.
+                    "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                  },
+                  "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                    "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "dashStyle": "A String", # The dash style of the border.
+                    "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                  },
+                  "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited.
+                  "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only.
+                  "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent.
+                  "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent.
+                  "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent.
+                  "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated.
+                  "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error.
+                  "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent.
+                    "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                  },
+                  "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "spacingMode": "A String", # The spacing mode for the paragraph.
+                  "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only.
+                    { # A tab stop within a paragraph.
+                      "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START.
+                      "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                    },
+                  ],
+                },
+                "positionedObjectIds": [ # The IDs of the positioned objects tethered to this paragraph.
+                  "A String",
+                ],
+                "suggestedBulletChanges": { # The suggested changes to this paragraph's bullet.
+                  "a_key": { # A suggested change to a Bullet.
+                    "bullet": { # Describes the bullet of a paragraph. # A Bullet that only includes the changes made in this suggestion. This can be used along with the bullet_suggestion_state to see which fields have changed and their new values.
+                      "listId": "A String", # The ID of the list this paragraph belongs to.
+                      "nestingLevel": 42, # The nesting level of this paragraph in the list.
+                      "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                        "bold": True or False, # Whether or not the text is rendered as bold.
+                        "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "italic": True or False, # Whether or not the text is italicized.
+                        "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                          "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a bookmark in this document.
+                            "tabId": "A String", # The ID of the tab containing this bookmark.
+                          },
+                          "bookmarkId": "A String", # The ID of a bookmark in this document.
+                          "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of the tab containing this heading.
+                          },
+                          "headingId": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of a tab in this document.
+                          "url": "A String", # An external URL.
+                        },
+                        "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                        "strikethrough": True or False, # Whether or not the text is struck through.
+                        "underline": True or False, # Whether or not the text is underlined.
+                        "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                          "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                          "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                        },
+                      },
+                    },
+                    "bulletSuggestionState": { # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion.
+                      "listIdSuggested": True or False, # Indicates if there was a suggested change to the list_id.
+                      "nestingLevelSuggested": True or False, # Indicates if there was a suggested change to the nesting_level.
+                      "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion.
+                        "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                        "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                        "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                        "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                        "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                        "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                        "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                        "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                        "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                        "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                        "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                      },
+                    },
+                  },
+                },
+                "suggestedParagraphStyleChanges": { # The suggested paragraph style changes to this paragraph, keyed by suggestion ID.
+                  "a_key": { # A suggested change to a ParagraphStyle.
+                    "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A ParagraphStyle that only includes the changes made in this suggestion. This can be used along with the paragraph_style_suggestion_state to see which fields have changed and their new values.
+                      "alignment": "A String", # The text alignment for this paragraph.
+                      "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent.
+                      "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                        "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "dashStyle": "A String", # The dash style of the border.
+                        "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                      },
+                      "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                        "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "dashStyle": "A String", # The dash style of the border.
+                        "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                      },
+                      "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                        "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "dashStyle": "A String", # The dash style of the border.
+                        "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                      },
+                      "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                        "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "dashStyle": "A String", # The dash style of the border.
+                        "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                      },
+                      "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                        "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "dashStyle": "A String", # The dash style of the border.
+                        "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                      },
+                      "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited.
+                      "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only.
+                      "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent.
+                      "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent.
+                      "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent.
+                      "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated.
+                      "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error.
+                      "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                      },
+                      "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "spacingMode": "A String", # The spacing mode for the paragraph.
+                      "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only.
+                        { # A tab stop within a paragraph.
+                          "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START.
+                          "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                        },
+                      ],
+                    },
+                    "paragraphStyleSuggestionState": { # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion.
+                      "alignmentSuggested": True or False, # Indicates if there was a suggested change to alignment.
+                      "avoidWidowAndOrphanSuggested": True or False, # Indicates if there was a suggested change to avoid_widow_and_orphan.
+                      "borderBetweenSuggested": True or False, # Indicates if there was a suggested change to border_between.
+                      "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom.
+                      "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left.
+                      "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right.
+                      "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top.
+                      "directionSuggested": True or False, # Indicates if there was a suggested change to direction.
+                      "headingIdSuggested": True or False, # Indicates if there was a suggested change to heading_id.
+                      "indentEndSuggested": True or False, # Indicates if there was a suggested change to indent_end.
+                      "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line.
+                      "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start.
+                      "keepLinesTogetherSuggested": True or False, # Indicates if there was a suggested change to keep_lines_together.
+                      "keepWithNextSuggested": True or False, # Indicates if there was a suggested change to keep_with_next.
+                      "lineSpacingSuggested": True or False, # Indicates if there was a suggested change to line_spacing.
+                      "namedStyleTypeSuggested": True or False, # Indicates if there was a suggested change to named_style_type.
+                      "pageBreakBeforeSuggested": True or False, # Indicates if there was a suggested change to page_break_before.
+                      "shadingSuggestionState": { # A mask that indicates which of the fields on the base Shading have been changed in this suggested change. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in shading have been changed in this suggestion.
+                        "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to the Shading.
+                      },
+                      "spaceAboveSuggested": True or False, # Indicates if there was a suggested change to space_above.
+                      "spaceBelowSuggested": True or False, # Indicates if there was a suggested change to space_below.
+                      "spacingModeSuggested": True or False, # Indicates if there was a suggested change to spacing_mode.
+                    },
+                  },
+                },
+                "suggestedPositionedObjectIds": { # The IDs of the positioned objects suggested to be attached to this paragraph, keyed by suggestion ID.
+                  "a_key": { # A collection of object IDs.
+                    "objectIds": [ # The object IDs.
+                      "A String",
+                    ],
+                  },
+                },
+              },
+              "sectionBreak": { # A StructuralElement representing a section break. A section is a range of content that has the same SectionStyle. A section break represents the start of a new section, and the section style applies to the section after the section break. The document body always begins with a section break. # A section break type of structural element.
+                "sectionStyle": { # The styling that applies to a section. # The style of the section after this section break.
+                  "columnProperties": [ # The section's columns properties. If empty, the section contains one column with the default properties in the Docs editor. A section can be updated to have no more than 3 columns. When updating this property, setting a concrete value is required. Unsetting this property will result in a 400 bad request error.
+                    { # Properties that apply to a section's column.
+                      "paddingEnd": { # A magnitude in a single direction in the specified units. # The padding at the end of the column.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "width": { # A magnitude in a single direction in the specified units. # Output only. The width of the column.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                    },
+                  ],
+                  "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                  "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                  "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only.
+                  "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only.
+                  "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only.
+                  "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only.
+                  "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only.
+                  "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only.
+                  "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                  "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                  "sectionType": "A String", # Output only. The type of section.
+                  "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                },
+                "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                  "A String",
+                ],
+                "suggestedInsertionIds": [ # The suggested insertion IDs. A SectionBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                  "A String",
+                ],
+              },
+              "startIndex": 42, # The zero-based start index of this structural element, in UTF-16 code units.
+              "table": { # A StructuralElement representing a table. # A table type of structural element.
+                "columns": 42, # Number of columns in the table. It's possible for a table to be non-rectangular, so some rows may have a different number of cells.
+                "rows": 42, # Number of rows in the table.
+                "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                  "A String",
+                ],
+                "suggestedInsertionIds": [ # The suggested insertion IDs. A Table may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                  "A String",
+                ],
+                "tableRows": [ # The contents and style of each row.
+                  { # The contents and style of a row in a Table.
+                    "endIndex": 42, # The zero-based end index of this row, exclusive, in UTF-16 code units.
+                    "startIndex": 42, # The zero-based start index of this row, in UTF-16 code units.
+                    "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                      "A String",
+                    ],
+                    "suggestedInsertionIds": [ # The suggested insertion IDs. A TableRow may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                      "A String",
+                    ],
+                    "suggestedTableRowStyleChanges": { # The suggested style changes to this row, keyed by suggestion ID.
+                      "a_key": { # A suggested change to a TableRowStyle.
+                        "tableRowStyle": { # Styles that apply to a table row. # A TableRowStyle that only includes the changes made in this suggestion. This can be used along with the table_row_style_suggestion_state to see which fields have changed and their new values.
+                          "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries.
+                          "tableHeader": True or False, # Whether the row is a table header.
+                        },
+                        "tableRowStyleSuggestionState": { # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion.
+                          "minRowHeightSuggested": True or False, # Indicates if there was a suggested change to min_row_height.
+                        },
+                      },
+                    },
+                    "tableCells": [ # The contents and style of each cell in this row. It's possible for a table to be non-rectangular, so some rows may have a different number of cells than other rows in the same table.
+                      { # The contents and style of a cell in a Table.
+                        "content": [ # The content of the cell.
+                          # Object with schema name: StructuralElement
+                        ],
+                        "endIndex": 42, # The zero-based end index of this cell, exclusive, in UTF-16 code units.
+                        "startIndex": 42, # The zero-based start index of this cell, in UTF-16 code units.
+                        "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                          "A String",
+                        ],
+                        "suggestedInsertionIds": [ # The suggested insertion IDs. A TableCell may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                          "A String",
+                        ],
+                        "suggestedTableCellStyleChanges": { # The suggested changes to the table cell style, keyed by suggestion ID.
+                          "a_key": { # A suggested change to a TableCellStyle.
+                            "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # A TableCellStyle that only includes the changes made in this suggestion. This can be used along with the table_cell_style_suggestion_state to see which fields have changed and their new values.
+                              "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell.
+                                "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                                  "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                    "rgbColor": { # An RGB color. # The RGB color value.
+                                      "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                      "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                      "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                    },
+                                  },
+                                },
+                                "dashStyle": "A String", # The dash style of the border.
+                                "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                                  "magnitude": 3.14, # The magnitude.
+                                  "unit": "A String", # The units for magnitude.
+                                },
+                              },
+                              "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell.
+                                "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                                  "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                    "rgbColor": { # An RGB color. # The RGB color value.
+                                      "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                      "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                      "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                    },
+                                  },
+                                },
+                                "dashStyle": "A String", # The dash style of the border.
+                                "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                                  "magnitude": 3.14, # The magnitude.
+                                  "unit": "A String", # The units for magnitude.
+                                },
+                              },
+                              "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell.
+                                "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                                  "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                    "rgbColor": { # An RGB color. # The RGB color value.
+                                      "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                      "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                      "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                    },
+                                  },
+                                },
+                                "dashStyle": "A String", # The dash style of the border.
+                                "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                                  "magnitude": 3.14, # The magnitude.
+                                  "unit": "A String", # The units for magnitude.
+                                },
+                              },
+                              "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell.
+                                "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                                  "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                    "rgbColor": { # An RGB color. # The RGB color value.
+                                      "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                      "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                      "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                    },
+                                  },
+                                },
+                                "dashStyle": "A String", # The dash style of the border.
+                                "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                                  "magnitude": 3.14, # The magnitude.
+                                  "unit": "A String", # The units for magnitude.
+                                },
+                              },
+                              "columnSpan": 42, # The column span of the cell. This property is read-only.
+                              "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor.
+                              "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                              "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                              "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                              "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                              "rowSpan": 42, # The row span of the cell. This property is read-only.
+                            },
+                            "tableCellStyleSuggestionState": { # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion.
+                              "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                              "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom.
+                              "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left.
+                              "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right.
+                              "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top.
+                              "columnSpanSuggested": True or False, # Indicates if there was a suggested change to column_span.
+                              "contentAlignmentSuggested": True or False, # Indicates if there was a suggested change to content_alignment.
+                              "paddingBottomSuggested": True or False, # Indicates if there was a suggested change to padding_bottom.
+                              "paddingLeftSuggested": True or False, # Indicates if there was a suggested change to padding_left.
+                              "paddingRightSuggested": True or False, # Indicates if there was a suggested change to padding_right.
+                              "paddingTopSuggested": True or False, # Indicates if there was a suggested change to padding_top.
+                              "rowSpanSuggested": True or False, # Indicates if there was a suggested change to row_span.
+                            },
+                          },
+                        },
+                        "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # The style of the cell.
+                          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell.
+                            "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "dashStyle": "A String", # The dash style of the border.
+                            "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                          },
+                          "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell.
+                            "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "dashStyle": "A String", # The dash style of the border.
+                            "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                          },
+                          "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell.
+                            "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "dashStyle": "A String", # The dash style of the border.
+                            "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                          },
+                          "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell.
+                            "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "dashStyle": "A String", # The dash style of the border.
+                            "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                          },
+                          "columnSpan": 42, # The column span of the cell. This property is read-only.
+                          "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor.
+                          "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "rowSpan": 42, # The row span of the cell. This property is read-only.
+                        },
+                      },
+                    ],
+                    "tableRowStyle": { # Styles that apply to a table row. # The style of the table row.
+                      "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries.
+                      "tableHeader": True or False, # Whether the row is a table header.
+                    },
+                  },
+                ],
+                "tableStyle": { # Styles that apply to a table. # The style of the table.
+                  "tableColumnProperties": [ # The properties of each column. Note that in Docs, tables contain rows and rows contain cells, similar to HTML. So the properties for a row can be found on the row's table_row_style.
+                    { # The properties of a column in a table.
+                      "width": { # A magnitude in a single direction in the specified units. # The width of the column. Set when the column's `width_type` is FIXED_WIDTH.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "widthType": "A String", # The width type of the column.
+                    },
+                  ],
+                },
+              },
+              "tableOfContents": { # A StructuralElement representing a table of contents. # A table of contents type of structural element.
+                "content": [ # The content of the table of contents.
+                  # Object with schema name: StructuralElement
+                ],
+                "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                  "A String",
+                ],
+                "suggestedInsertionIds": [ # The suggested insertion IDs. A TableOfContents may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion.
+                  "A String",
+                ],
               },
-              "size": { # A width and height. # The visible size of the image after cropping.
-                "height": { # A magnitude in a single direction in the specified units. # The height of the object.
-                  "magnitude": 3.14, # The magnitude.
-                  "unit": "A String", # The units for magnitude.
+            },
+          ],
+        },
+        "documentStyle": { # The style of the document. # The style of the document tab.
+          "background": { # Represents the background of a document. # The background of the document. Documents cannot have a transparent background color.
+            "color": { # A color that can either be fully opaque or fully transparent. # The background color.
+              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                "rgbColor": { # An RGB color. # The RGB color value.
+                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
                 },
-                "width": { # A magnitude in a single direction in the specified units. # The width of the object.
-                  "magnitude": 3.14, # The magnitude.
-                  "unit": "A String", # The units for magnitude.
+              },
+            },
+          },
+          "defaultFooterId": "A String", # The ID of the default footer. If not set, there's no default footer. This property is read-only.
+          "defaultHeaderId": "A String", # The ID of the default header. If not set, there's no default header. This property is read-only.
+          "evenPageFooterId": "A String", # The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. This property is read-only.
+          "evenPageHeaderId": "A String", # The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. This property is read-only.
+          "firstPageFooterId": "A String", # The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. This property is read-only.
+          "firstPageHeaderId": "A String", # The ID of the header used only for the first page. If not set then a unique header for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_header_id or this value for the header on the first page. If not set, there's no first page header. This property is read-only.
+          "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of the page_size, which allows changing the page orientation between portrait and landscape.
+          "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin. Updating the bottom page margin on the document style clears the bottom page margin on all section styles.
+            "magnitude": 3.14, # The magnitude.
+            "unit": "A String", # The units for magnitude.
+          },
+          "marginFooter": { # A magnitude in a single direction in the specified units. # The amount of space between the bottom of the page and the contents of the footer.
+            "magnitude": 3.14, # The magnitude.
+            "unit": "A String", # The units for magnitude.
+          },
+          "marginHeader": { # A magnitude in a single direction in the specified units. # The amount of space between the top of the page and the contents of the header.
+            "magnitude": 3.14, # The magnitude.
+            "unit": "A String", # The units for magnitude.
+          },
+          "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin. Updating the left page margin on the document style clears the left page margin on all section styles. It may also cause columns to resize in all sections.
+            "magnitude": 3.14, # The magnitude.
+            "unit": "A String", # The units for magnitude.
+          },
+          "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin. Updating the right page margin on the document style clears the right page margin on all section styles. It may also cause columns to resize in all sections.
+            "magnitude": 3.14, # The magnitude.
+            "unit": "A String", # The units for magnitude.
+          },
+          "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin. Updating the top page margin on the document style clears the top page margin on all section styles.
+            "magnitude": 3.14, # The magnitude.
+            "unit": "A String", # The units for magnitude.
+          },
+          "pageNumberStart": 42, # The page number from which to start counting the number of pages.
+          "pageSize": { # A width and height. # The size of a page in the document.
+            "height": { # A magnitude in a single direction in the specified units. # The height of the object.
+              "magnitude": 3.14, # The magnitude.
+              "unit": "A String", # The units for magnitude.
+            },
+            "width": { # A magnitude in a single direction in the specified units. # The width of the object.
+              "magnitude": 3.14, # The magnitude.
+              "unit": "A String", # The units for magnitude.
+            },
+          },
+          "useCustomHeaderFooterMargins": True or False, # Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected. When false, the default values in the Docs editor for header and footer margin are used. This property is read-only.
+          "useEvenPageHeaderFooter": True or False, # Indicates whether to use the even page header / footer IDs for the even pages.
+          "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page.
+        },
+        "footers": { # The footers in the document tab, keyed by footer ID.
+          "a_key": { # A document footer.
+            "content": [ # The contents of the footer. The indexes for a footer's content begin at zero.
+              { # A StructuralElement describes content that provides structure to the document.
+                "endIndex": 42, # The zero-based end index of this structural element, exclusive, in UTF-16 code units.
+                "paragraph": { # A StructuralElement representing a paragraph. A paragraph is a range of content that's terminated with a newline character. # A paragraph type of structural element.
+                  "bullet": { # Describes the bullet of a paragraph. # The bullet for this paragraph. If not present, the paragraph does not belong to a list.
+                    "listId": "A String", # The ID of the list this paragraph belongs to.
+                    "nestingLevel": 42, # The nesting level of this paragraph in the list.
+                    "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet.
+                      "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                      "bold": True or False, # Whether or not the text is rendered as bold.
+                      "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "italic": True or False, # Whether or not the text is italicized.
+                      "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                        "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                          "id": "A String", # The ID of a bookmark in this document.
+                          "tabId": "A String", # The ID of the tab containing this bookmark.
+                        },
+                        "bookmarkId": "A String", # The ID of a bookmark in this document.
+                        "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                          "id": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of the tab containing this heading.
+                        },
+                        "headingId": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of a tab in this document.
+                        "url": "A String", # An external URL.
+                      },
+                      "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                      "strikethrough": True or False, # Whether or not the text is struck through.
+                      "underline": True or False, # Whether or not the text is underlined.
+                      "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                        "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                        "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                      },
+                    },
+                  },
+                  "elements": [ # The content of the paragraph, broken down into its component parts.
+                    { # A ParagraphElement describes content within a Paragraph.
+                      "autoText": { # A ParagraphElement representing a spot in the text that's dynamically replaced with content that can change over time, like a page number. # An auto text paragraph element.
+                        "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                          "A String",
+                        ],
+                        "suggestedInsertionIds": [ # The suggested insertion IDs. An AutoText may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                          "A String",
+                        ],
+                        "suggestedTextStyleChanges": { # The suggested text style changes to this AutoText, keyed by suggestion ID.
+                          "a_key": { # A suggested change to a TextStyle.
+                            "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                              "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                              "bold": True or False, # Whether or not the text is rendered as bold.
+                              "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                              "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "italic": True or False, # Whether or not the text is italicized.
+                              "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                                "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a bookmark in this document.
+                                  "tabId": "A String", # The ID of the tab containing this bookmark.
+                                },
+                                "bookmarkId": "A String", # The ID of a bookmark in this document.
+                                "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a heading in this document.
+                                  "tabId": "A String", # The ID of the tab containing this heading.
+                                },
+                                "headingId": "A String", # The ID of a heading in this document.
+                                "tabId": "A String", # The ID of a tab in this document.
+                                "url": "A String", # An external URL.
+                              },
+                              "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                              "strikethrough": True or False, # Whether or not the text is struck through.
+                              "underline": True or False, # Whether or not the text is underlined.
+                              "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                                "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                                "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                              },
+                            },
+                            "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                              "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                              "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                              "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                              "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                              "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                              "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                              "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                              "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                              "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                              "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                              "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                            },
+                          },
+                        },
+                        "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this AutoText.
+                          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                          "bold": True or False, # Whether or not the text is rendered as bold.
+                          "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "italic": True or False, # Whether or not the text is italicized.
+                          "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                            "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a bookmark in this document.
+                              "tabId": "A String", # The ID of the tab containing this bookmark.
+                            },
+                            "bookmarkId": "A String", # The ID of a bookmark in this document.
+                            "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a heading in this document.
+                              "tabId": "A String", # The ID of the tab containing this heading.
+                            },
+                            "headingId": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of a tab in this document.
+                            "url": "A String", # An external URL.
+                          },
+                          "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                          "strikethrough": True or False, # Whether or not the text is struck through.
+                          "underline": True or False, # Whether or not the text is underlined.
+                          "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                            "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                            "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                          },
+                        },
+                        "type": "A String", # The type of this auto text.
+                      },
+                      "columnBreak": { # A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column. # A column break paragraph element.
+                        "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                          "A String",
+                        ],
+                        "suggestedInsertionIds": [ # The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                          "A String",
+                        ],
+                        "suggestedTextStyleChanges": { # The suggested text style changes to this ColumnBreak, keyed by suggestion ID.
+                          "a_key": { # A suggested change to a TextStyle.
+                            "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                              "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                              "bold": True or False, # Whether or not the text is rendered as bold.
+                              "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                              "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "italic": True or False, # Whether or not the text is italicized.
+                              "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                                "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a bookmark in this document.
+                                  "tabId": "A String", # The ID of the tab containing this bookmark.
+                                },
+                                "bookmarkId": "A String", # The ID of a bookmark in this document.
+                                "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a heading in this document.
+                                  "tabId": "A String", # The ID of the tab containing this heading.
+                                },
+                                "headingId": "A String", # The ID of a heading in this document.
+                                "tabId": "A String", # The ID of a tab in this document.
+                                "url": "A String", # An external URL.
+                              },
+                              "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                              "strikethrough": True or False, # Whether or not the text is struck through.
+                              "underline": True or False, # Whether or not the text is underlined.
+                              "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                                "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                                "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                              },
+                            },
+                            "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                              "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                              "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                              "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                              "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                              "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                              "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                              "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                              "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                              "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                              "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                              "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                            },
+                          },
+                        },
+                        "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it.
+                          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                          "bold": True or False, # Whether or not the text is rendered as bold.
+                          "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "italic": True or False, # Whether or not the text is italicized.
+                          "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                            "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a bookmark in this document.
+                              "tabId": "A String", # The ID of the tab containing this bookmark.
+                            },
+                            "bookmarkId": "A String", # The ID of a bookmark in this document.
+                            "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a heading in this document.
+                              "tabId": "A String", # The ID of the tab containing this heading.
+                            },
+                            "headingId": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of a tab in this document.
+                            "url": "A String", # An external URL.
+                          },
+                          "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                          "strikethrough": True or False, # Whether or not the text is struck through.
+                          "underline": True or False, # Whether or not the text is underlined.
+                          "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                            "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                            "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                          },
+                        },
+                      },
+                      "endIndex": 42, # The zero-base end index of this paragraph element, exclusive, in UTF-16 code units.
+                      "equation": { # A ParagraphElement representing an equation. # An equation paragraph element.
+                        "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                          "A String",
+                        ],
+                        "suggestedInsertionIds": [ # The suggested insertion IDs. An Equation may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                          "A String",
+                        ],
+                      },
+                      "footnoteReference": { # A ParagraphElement representing a footnote reference. A footnote reference is the inline content rendered with a number and is used to identify the footnote. # A footnote reference paragraph element.
+                        "footnoteId": "A String", # The ID of the footnote that contains the content of this footnote reference.
+                        "footnoteNumber": "A String", # The rendered number of this footnote.
+                        "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                          "A String",
+                        ],
+                        "suggestedInsertionIds": [ # The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                          "A String",
+                        ],
+                        "suggestedTextStyleChanges": { # The suggested text style changes to this FootnoteReference, keyed by suggestion ID.
+                          "a_key": { # A suggested change to a TextStyle.
+                            "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                              "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                              "bold": True or False, # Whether or not the text is rendered as bold.
+                              "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                              "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "italic": True or False, # Whether or not the text is italicized.
+                              "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                                "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a bookmark in this document.
+                                  "tabId": "A String", # The ID of the tab containing this bookmark.
+                                },
+                                "bookmarkId": "A String", # The ID of a bookmark in this document.
+                                "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a heading in this document.
+                                  "tabId": "A String", # The ID of the tab containing this heading.
+                                },
+                                "headingId": "A String", # The ID of a heading in this document.
+                                "tabId": "A String", # The ID of a tab in this document.
+                                "url": "A String", # An external URL.
+                              },
+                              "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                              "strikethrough": True or False, # Whether or not the text is struck through.
+                              "underline": True or False, # Whether or not the text is underlined.
+                              "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                                "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                                "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                              },
+                            },
+                            "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                              "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                              "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                              "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                              "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                              "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                              "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                              "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                              "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                              "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                              "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                              "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                            },
+                          },
+                        },
+                        "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this FootnoteReference.
+                          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                          "bold": True or False, # Whether or not the text is rendered as bold.
+                          "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "italic": True or False, # Whether or not the text is italicized.
+                          "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                            "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a bookmark in this document.
+                              "tabId": "A String", # The ID of the tab containing this bookmark.
+                            },
+                            "bookmarkId": "A String", # The ID of a bookmark in this document.
+                            "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a heading in this document.
+                              "tabId": "A String", # The ID of the tab containing this heading.
+                            },
+                            "headingId": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of a tab in this document.
+                            "url": "A String", # An external URL.
+                          },
+                          "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                          "strikethrough": True or False, # Whether or not the text is struck through.
+                          "underline": True or False, # Whether or not the text is underlined.
+                          "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                            "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                            "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                          },
+                        },
+                      },
+                      "horizontalRule": { # A ParagraphElement representing a horizontal line. # A horizontal rule paragraph element.
+                        "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                          "A String",
+                        ],
+                        "suggestedInsertionIds": [ # The suggested insertion IDs. A HorizontalRule may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion.
+                          "A String",
+                        ],
+                        "suggestedTextStyleChanges": { # The suggested text style changes to this HorizontalRule, keyed by suggestion ID.
+                          "a_key": { # A suggested change to a TextStyle.
+                            "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                              "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                              "bold": True or False, # Whether or not the text is rendered as bold.
+                              "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                              "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "italic": True or False, # Whether or not the text is italicized.
+                              "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                                "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a bookmark in this document.
+                                  "tabId": "A String", # The ID of the tab containing this bookmark.
+                                },
+                                "bookmarkId": "A String", # The ID of a bookmark in this document.
+                                "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a heading in this document.
+                                  "tabId": "A String", # The ID of the tab containing this heading.
+                                },
+                                "headingId": "A String", # The ID of a heading in this document.
+                                "tabId": "A String", # The ID of a tab in this document.
+                                "url": "A String", # An external URL.
+                              },
+                              "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                              "strikethrough": True or False, # Whether or not the text is struck through.
+                              "underline": True or False, # Whether or not the text is underlined.
+                              "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                                "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                                "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                              },
+                            },
+                            "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                              "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                              "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                              "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                              "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                              "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                              "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                              "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                              "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                              "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                              "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                              "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                            },
+                          },
+                        },
+                        "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this HorizontalRule. Similar to text content, like text runs and footnote references, the text style of a horizontal rule can affect content layout as well as the styling of text inserted next to it.
+                          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                          "bold": True or False, # Whether or not the text is rendered as bold.
+                          "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "italic": True or False, # Whether or not the text is italicized.
+                          "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                            "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a bookmark in this document.
+                              "tabId": "A String", # The ID of the tab containing this bookmark.
+                            },
+                            "bookmarkId": "A String", # The ID of a bookmark in this document.
+                            "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a heading in this document.
+                              "tabId": "A String", # The ID of the tab containing this heading.
+                            },
+                            "headingId": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of a tab in this document.
+                            "url": "A String", # An external URL.
+                          },
+                          "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                          "strikethrough": True or False, # Whether or not the text is struck through.
+                          "underline": True or False, # Whether or not the text is underlined.
+                          "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                            "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                            "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                          },
+                        },
+                      },
+                      "inlineObjectElement": { # A ParagraphElement that contains an InlineObject. # An inline object paragraph element.
+                        "inlineObjectId": "A String", # The ID of the InlineObject this element contains.
+                        "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                          "A String",
+                        ],
+                        "suggestedInsertionIds": [ # The suggested insertion IDs. An InlineObjectElement may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                          "A String",
+                        ],
+                        "suggestedTextStyleChanges": { # The suggested text style changes to this InlineObject, keyed by suggestion ID.
+                          "a_key": { # A suggested change to a TextStyle.
+                            "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                              "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                              "bold": True or False, # Whether or not the text is rendered as bold.
+                              "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                              "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "italic": True or False, # Whether or not the text is italicized.
+                              "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                                "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a bookmark in this document.
+                                  "tabId": "A String", # The ID of the tab containing this bookmark.
+                                },
+                                "bookmarkId": "A String", # The ID of a bookmark in this document.
+                                "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a heading in this document.
+                                  "tabId": "A String", # The ID of the tab containing this heading.
+                                },
+                                "headingId": "A String", # The ID of a heading in this document.
+                                "tabId": "A String", # The ID of a tab in this document.
+                                "url": "A String", # An external URL.
+                              },
+                              "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                              "strikethrough": True or False, # Whether or not the text is struck through.
+                              "underline": True or False, # Whether or not the text is underlined.
+                              "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                                "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                                "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                              },
+                            },
+                            "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                              "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                              "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                              "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                              "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                              "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                              "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                              "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                              "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                              "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                              "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                              "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                            },
+                          },
+                        },
+                        "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this InlineObjectElement. Similar to text content, like text runs and footnote references, the text style of an inline object element can affect content layout as well as the styling of text inserted next to it.
+                          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                          "bold": True or False, # Whether or not the text is rendered as bold.
+                          "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "italic": True or False, # Whether or not the text is italicized.
+                          "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                            "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a bookmark in this document.
+                              "tabId": "A String", # The ID of the tab containing this bookmark.
+                            },
+                            "bookmarkId": "A String", # The ID of a bookmark in this document.
+                            "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a heading in this document.
+                              "tabId": "A String", # The ID of the tab containing this heading.
+                            },
+                            "headingId": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of a tab in this document.
+                            "url": "A String", # An external URL.
+                          },
+                          "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                          "strikethrough": True or False, # Whether or not the text is struck through.
+                          "underline": True or False, # Whether or not the text is underlined.
+                          "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                            "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                            "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                          },
+                        },
+                      },
+                      "pageBreak": { # A ParagraphElement representing a page break. A page break makes the subsequent text start at the top of the next page. # A page break paragraph element.
+                        "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                          "A String",
+                        ],
+                        "suggestedInsertionIds": [ # The suggested insertion IDs. A PageBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                          "A String",
+                        ],
+                        "suggestedTextStyleChanges": { # The suggested text style changes to this PageBreak, keyed by suggestion ID.
+                          "a_key": { # A suggested change to a TextStyle.
+                            "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                              "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                              "bold": True or False, # Whether or not the text is rendered as bold.
+                              "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                              "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "italic": True or False, # Whether or not the text is italicized.
+                              "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                                "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a bookmark in this document.
+                                  "tabId": "A String", # The ID of the tab containing this bookmark.
+                                },
+                                "bookmarkId": "A String", # The ID of a bookmark in this document.
+                                "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a heading in this document.
+                                  "tabId": "A String", # The ID of the tab containing this heading.
+                                },
+                                "headingId": "A String", # The ID of a heading in this document.
+                                "tabId": "A String", # The ID of a tab in this document.
+                                "url": "A String", # An external URL.
+                              },
+                              "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                              "strikethrough": True or False, # Whether or not the text is struck through.
+                              "underline": True or False, # Whether or not the text is underlined.
+                              "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                                "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                                "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                              },
+                            },
+                            "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                              "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                              "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                              "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                              "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                              "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                              "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                              "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                              "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                              "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                              "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                              "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                            },
+                          },
+                        },
+                        "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this PageBreak. Similar to text content, like text runs and footnote references, the text style of a page break can affect content layout as well as the styling of text inserted next to it.
+                          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                          "bold": True or False, # Whether or not the text is rendered as bold.
+                          "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "italic": True or False, # Whether or not the text is italicized.
+                          "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                            "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a bookmark in this document.
+                              "tabId": "A String", # The ID of the tab containing this bookmark.
+                            },
+                            "bookmarkId": "A String", # The ID of a bookmark in this document.
+                            "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a heading in this document.
+                              "tabId": "A String", # The ID of the tab containing this heading.
+                            },
+                            "headingId": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of a tab in this document.
+                            "url": "A String", # An external URL.
+                          },
+                          "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                          "strikethrough": True or False, # Whether or not the text is struck through.
+                          "underline": True or False, # Whether or not the text is underlined.
+                          "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                            "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                            "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                          },
+                        },
+                      },
+                      "person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address.
+                        "personId": "A String", # Output only. The unique ID of this link.
+                        "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present.
+                          "email": "A String", # Output only. The email address linked to this Person. This field is always present.
+                          "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address.
+                        },
+                        "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion.
+                          "A String",
+                        ],
+                        "suggestedInsertionIds": [ # IDs for suggestions that insert this person link into the document. A Person might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion.
+                          "A String",
+                        ],
+                        "suggestedTextStyleChanges": { # The suggested text style changes to this Person, keyed by suggestion ID.
+                          "a_key": { # A suggested change to a TextStyle.
+                            "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                              "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                              "bold": True or False, # Whether or not the text is rendered as bold.
+                              "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                              "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "italic": True or False, # Whether or not the text is italicized.
+                              "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                                "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a bookmark in this document.
+                                  "tabId": "A String", # The ID of the tab containing this bookmark.
+                                },
+                                "bookmarkId": "A String", # The ID of a bookmark in this document.
+                                "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a heading in this document.
+                                  "tabId": "A String", # The ID of the tab containing this heading.
+                                },
+                                "headingId": "A String", # The ID of a heading in this document.
+                                "tabId": "A String", # The ID of a tab in this document.
+                                "url": "A String", # An external URL.
+                              },
+                              "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                              "strikethrough": True or False, # Whether or not the text is struck through.
+                              "underline": True or False, # Whether or not the text is underlined.
+                              "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                                "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                                "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                              },
+                            },
+                            "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                              "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                              "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                              "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                              "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                              "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                              "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                              "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                              "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                              "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                              "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                              "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                            },
+                          },
+                        },
+                        "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this Person.
+                          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                          "bold": True or False, # Whether or not the text is rendered as bold.
+                          "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "italic": True or False, # Whether or not the text is italicized.
+                          "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                            "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a bookmark in this document.
+                              "tabId": "A String", # The ID of the tab containing this bookmark.
+                            },
+                            "bookmarkId": "A String", # The ID of a bookmark in this document.
+                            "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a heading in this document.
+                              "tabId": "A String", # The ID of the tab containing this heading.
+                            },
+                            "headingId": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of a tab in this document.
+                            "url": "A String", # An external URL.
+                          },
+                          "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                          "strikethrough": True or False, # Whether or not the text is struck through.
+                          "underline": True or False, # Whether or not the text is underlined.
+                          "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                            "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                            "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                          },
+                        },
+                      },
+                      "richLink": { # A link to a Google resource (such as a file in Drive, a YouTube video, or a Calendar event). # A paragraph element that links to a Google resource (such as a file in Google Drive, a YouTube video, or a Calendar event.)
+                        "richLinkId": "A String", # Output only. The ID of this link.
+                        "richLinkProperties": { # Properties specific to a RichLink. # Output only. The properties of this RichLink. This field is always present.
+                          "mimeType": "A String", # Output only. The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the RichLink, if there's one (for example, when it's a file in Drive).
+                          "title": "A String", # Output only. The title of the RichLink as displayed in the link. This title matches the title of the linked resource at the time of the insertion or last update of the link. This field is always present.
+                          "uri": "A String", # Output only. The URI to the RichLink. This is always present.
+                        },
+                        "suggestedDeletionIds": [ # IDs for suggestions that remove this link from the document. A RichLink might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion.
+                          "A String",
+                        ],
+                        "suggestedInsertionIds": [ # IDs for suggestions that insert this link into the document. A RichLink might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion.
+                          "A String",
+                        ],
+                        "suggestedTextStyleChanges": { # The suggested text style changes to this RichLink, keyed by suggestion ID.
+                          "a_key": { # A suggested change to a TextStyle.
+                            "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                              "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                              "bold": True or False, # Whether or not the text is rendered as bold.
+                              "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                              "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "italic": True or False, # Whether or not the text is italicized.
+                              "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                                "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a bookmark in this document.
+                                  "tabId": "A String", # The ID of the tab containing this bookmark.
+                                },
+                                "bookmarkId": "A String", # The ID of a bookmark in this document.
+                                "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a heading in this document.
+                                  "tabId": "A String", # The ID of the tab containing this heading.
+                                },
+                                "headingId": "A String", # The ID of a heading in this document.
+                                "tabId": "A String", # The ID of a tab in this document.
+                                "url": "A String", # An external URL.
+                              },
+                              "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                              "strikethrough": True or False, # Whether or not the text is struck through.
+                              "underline": True or False, # Whether or not the text is underlined.
+                              "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                                "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                                "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                              },
+                            },
+                            "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                              "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                              "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                              "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                              "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                              "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                              "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                              "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                              "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                              "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                              "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                              "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                            },
+                          },
+                        },
+                        "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this RichLink.
+                          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                          "bold": True or False, # Whether or not the text is rendered as bold.
+                          "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "italic": True or False, # Whether or not the text is italicized.
+                          "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                            "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a bookmark in this document.
+                              "tabId": "A String", # The ID of the tab containing this bookmark.
+                            },
+                            "bookmarkId": "A String", # The ID of a bookmark in this document.
+                            "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a heading in this document.
+                              "tabId": "A String", # The ID of the tab containing this heading.
+                            },
+                            "headingId": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of a tab in this document.
+                            "url": "A String", # An external URL.
+                          },
+                          "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                          "strikethrough": True or False, # Whether or not the text is struck through.
+                          "underline": True or False, # Whether or not the text is underlined.
+                          "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                            "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                            "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                          },
+                        },
+                      },
+                      "startIndex": 42, # The zero-based start index of this paragraph element, in UTF-16 code units.
+                      "textRun": { # A ParagraphElement that represents a run of text that all has the same styling. # A text run paragraph element.
+                        "content": "A String", # The text of this run. Any non-text elements in the run are replaced with the Unicode character U+E907.
+                        "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                          "A String",
+                        ],
+                        "suggestedInsertionIds": [ # The suggested insertion IDs. A TextRun may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                          "A String",
+                        ],
+                        "suggestedTextStyleChanges": { # The suggested text style changes to this run, keyed by suggestion ID.
+                          "a_key": { # A suggested change to a TextStyle.
+                            "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                              "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                              "bold": True or False, # Whether or not the text is rendered as bold.
+                              "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                              "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "italic": True or False, # Whether or not the text is italicized.
+                              "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                                "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a bookmark in this document.
+                                  "tabId": "A String", # The ID of the tab containing this bookmark.
+                                },
+                                "bookmarkId": "A String", # The ID of a bookmark in this document.
+                                "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a heading in this document.
+                                  "tabId": "A String", # The ID of the tab containing this heading.
+                                },
+                                "headingId": "A String", # The ID of a heading in this document.
+                                "tabId": "A String", # The ID of a tab in this document.
+                                "url": "A String", # An external URL.
+                              },
+                              "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                              "strikethrough": True or False, # Whether or not the text is struck through.
+                              "underline": True or False, # Whether or not the text is underlined.
+                              "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                                "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                                "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                              },
+                            },
+                            "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                              "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                              "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                              "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                              "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                              "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                              "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                              "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                              "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                              "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                              "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                              "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                            },
+                          },
+                        },
+                        "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this run.
+                          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                          "bold": True or False, # Whether or not the text is rendered as bold.
+                          "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "italic": True or False, # Whether or not the text is italicized.
+                          "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                            "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a bookmark in this document.
+                              "tabId": "A String", # The ID of the tab containing this bookmark.
+                            },
+                            "bookmarkId": "A String", # The ID of a bookmark in this document.
+                            "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a heading in this document.
+                              "tabId": "A String", # The ID of the tab containing this heading.
+                            },
+                            "headingId": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of a tab in this document.
+                            "url": "A String", # An external URL.
+                          },
+                          "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                          "strikethrough": True or False, # Whether or not the text is struck through.
+                          "underline": True or False, # Whether or not the text is underlined.
+                          "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                            "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                            "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                          },
+                        },
+                      },
+                    },
+                  ],
+                  "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The style of this paragraph.
+                    "alignment": "A String", # The text alignment for this paragraph.
+                    "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent.
+                    "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                      "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "dashStyle": "A String", # The dash style of the border.
+                      "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                    },
+                    "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                      "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "dashStyle": "A String", # The dash style of the border.
+                      "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                    },
+                    "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                      "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "dashStyle": "A String", # The dash style of the border.
+                      "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                    },
+                    "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                      "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "dashStyle": "A String", # The dash style of the border.
+                      "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                    },
+                    "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                      "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "dashStyle": "A String", # The dash style of the border.
+                      "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                    },
+                    "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited.
+                    "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only.
+                    "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent.
+                    "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent.
+                    "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent.
+                    "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated.
+                    "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error.
+                    "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent.
+                      "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                    },
+                    "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "spacingMode": "A String", # The spacing mode for the paragraph.
+                    "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only.
+                      { # A tab stop within a paragraph.
+                        "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START.
+                        "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                      },
+                    ],
+                  },
+                  "positionedObjectIds": [ # The IDs of the positioned objects tethered to this paragraph.
+                    "A String",
+                  ],
+                  "suggestedBulletChanges": { # The suggested changes to this paragraph's bullet.
+                    "a_key": { # A suggested change to a Bullet.
+                      "bullet": { # Describes the bullet of a paragraph. # A Bullet that only includes the changes made in this suggestion. This can be used along with the bullet_suggestion_state to see which fields have changed and their new values.
+                        "listId": "A String", # The ID of the list this paragraph belongs to.
+                        "nestingLevel": 42, # The nesting level of this paragraph in the list.
+                        "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet.
+                          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                          "bold": True or False, # Whether or not the text is rendered as bold.
+                          "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "italic": True or False, # Whether or not the text is italicized.
+                          "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                            "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a bookmark in this document.
+                              "tabId": "A String", # The ID of the tab containing this bookmark.
+                            },
+                            "bookmarkId": "A String", # The ID of a bookmark in this document.
+                            "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a heading in this document.
+                              "tabId": "A String", # The ID of the tab containing this heading.
+                            },
+                            "headingId": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of a tab in this document.
+                            "url": "A String", # An external URL.
+                          },
+                          "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                          "strikethrough": True or False, # Whether or not the text is struck through.
+                          "underline": True or False, # Whether or not the text is underlined.
+                          "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                            "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                            "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                          },
+                        },
+                      },
+                      "bulletSuggestionState": { # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion.
+                        "listIdSuggested": True or False, # Indicates if there was a suggested change to the list_id.
+                        "nestingLevelSuggested": True or False, # Indicates if there was a suggested change to the nesting_level.
+                        "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion.
+                          "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                          "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                          "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                          "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                          "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                          "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                          "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                          "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                          "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                          "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                          "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                        },
+                      },
+                    },
+                  },
+                  "suggestedParagraphStyleChanges": { # The suggested paragraph style changes to this paragraph, keyed by suggestion ID.
+                    "a_key": { # A suggested change to a ParagraphStyle.
+                      "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A ParagraphStyle that only includes the changes made in this suggestion. This can be used along with the paragraph_style_suggestion_state to see which fields have changed and their new values.
+                        "alignment": "A String", # The text alignment for this paragraph.
+                        "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent.
+                        "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                          "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "dashStyle": "A String", # The dash style of the border.
+                          "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                        },
+                        "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                          "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "dashStyle": "A String", # The dash style of the border.
+                          "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                        },
+                        "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                          "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "dashStyle": "A String", # The dash style of the border.
+                          "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                        },
+                        "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                          "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "dashStyle": "A String", # The dash style of the border.
+                          "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                        },
+                        "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                          "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "dashStyle": "A String", # The dash style of the border.
+                          "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                        },
+                        "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited.
+                        "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only.
+                        "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent.
+                        "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent.
+                        "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent.
+                        "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated.
+                        "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error.
+                        "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent.
+                          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                        },
+                        "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "spacingMode": "A String", # The spacing mode for the paragraph.
+                        "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only.
+                          { # A tab stop within a paragraph.
+                            "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START.
+                            "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                          },
+                        ],
+                      },
+                      "paragraphStyleSuggestionState": { # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion.
+                        "alignmentSuggested": True or False, # Indicates if there was a suggested change to alignment.
+                        "avoidWidowAndOrphanSuggested": True or False, # Indicates if there was a suggested change to avoid_widow_and_orphan.
+                        "borderBetweenSuggested": True or False, # Indicates if there was a suggested change to border_between.
+                        "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom.
+                        "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left.
+                        "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right.
+                        "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top.
+                        "directionSuggested": True or False, # Indicates if there was a suggested change to direction.
+                        "headingIdSuggested": True or False, # Indicates if there was a suggested change to heading_id.
+                        "indentEndSuggested": True or False, # Indicates if there was a suggested change to indent_end.
+                        "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line.
+                        "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start.
+                        "keepLinesTogetherSuggested": True or False, # Indicates if there was a suggested change to keep_lines_together.
+                        "keepWithNextSuggested": True or False, # Indicates if there was a suggested change to keep_with_next.
+                        "lineSpacingSuggested": True or False, # Indicates if there was a suggested change to line_spacing.
+                        "namedStyleTypeSuggested": True or False, # Indicates if there was a suggested change to named_style_type.
+                        "pageBreakBeforeSuggested": True or False, # Indicates if there was a suggested change to page_break_before.
+                        "shadingSuggestionState": { # A mask that indicates which of the fields on the base Shading have been changed in this suggested change. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in shading have been changed in this suggestion.
+                          "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to the Shading.
+                        },
+                        "spaceAboveSuggested": True or False, # Indicates if there was a suggested change to space_above.
+                        "spaceBelowSuggested": True or False, # Indicates if there was a suggested change to space_below.
+                        "spacingModeSuggested": True or False, # Indicates if there was a suggested change to spacing_mode.
+                      },
+                    },
+                  },
+                  "suggestedPositionedObjectIds": { # The IDs of the positioned objects suggested to be attached to this paragraph, keyed by suggestion ID.
+                    "a_key": { # A collection of object IDs.
+                      "objectIds": [ # The object IDs.
+                        "A String",
+                      ],
+                    },
+                  },
+                },
+                "sectionBreak": { # A StructuralElement representing a section break. A section is a range of content that has the same SectionStyle. A section break represents the start of a new section, and the section style applies to the section after the section break. The document body always begins with a section break. # A section break type of structural element.
+                  "sectionStyle": { # The styling that applies to a section. # The style of the section after this section break.
+                    "columnProperties": [ # The section's columns properties. If empty, the section contains one column with the default properties in the Docs editor. A section can be updated to have no more than 3 columns. When updating this property, setting a concrete value is required. Unsetting this property will result in a 400 bad request error.
+                      { # Properties that apply to a section's column.
+                        "paddingEnd": { # A magnitude in a single direction in the specified units. # The padding at the end of the column.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "width": { # A magnitude in a single direction in the specified units. # Output only. The width of the column.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                      },
+                    ],
+                    "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                    "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                    "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only.
+                    "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only.
+                    "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only.
+                    "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only.
+                    "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only.
+                    "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only.
+                    "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                    "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                    "sectionType": "A String", # Output only. The type of section.
+                    "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                  },
+                  "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # The suggested insertion IDs. A SectionBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                    "A String",
+                  ],
                 },
-              },
-              "title": "A String", # The title of the embedded object. The `title` and `description` are both combined to display alt text.
-            },
-          },
-          "inlineObjectPropertiesSuggestionState": { # A mask that indicates which of the fields on the base InlineObjectProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base InlineObjectProperties have been changed in this suggestion.
-            "embeddedObjectSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedObject have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_object have been changed in this suggestion.
-              "descriptionSuggested": True or False, # Indicates if there was a suggested change to description.
-              "embeddedDrawingPropertiesSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedDrawingProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_drawing_properties have been changed in this suggestion.
-              },
-              "embeddedObjectBorderSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedObjectBorder have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_object_border have been changed in this suggestion.
-                "colorSuggested": True or False, # Indicates if there was a suggested change to color.
-                "dashStyleSuggested": True or False, # Indicates if there was a suggested change to dash_style.
-                "propertyStateSuggested": True or False, # Indicates if there was a suggested change to property_state.
-                "widthSuggested": True or False, # Indicates if there was a suggested change to width.
-              },
-              "imagePropertiesSuggestionState": { # A mask that indicates which of the fields on the base ImageProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in image_properties have been changed in this suggestion.
-                "angleSuggested": True or False, # Indicates if there was a suggested change to angle.
-                "brightnessSuggested": True or False, # Indicates if there was a suggested change to brightness.
-                "contentUriSuggested": True or False, # Indicates if there was a suggested change to content_uri.
-                "contrastSuggested": True or False, # Indicates if there was a suggested change to contrast.
-                "cropPropertiesSuggestionState": { # A mask that indicates which of the fields on the base CropProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in crop_properties have been changed in this suggestion.
-                  "angleSuggested": True or False, # Indicates if there was a suggested change to angle.
-                  "offsetBottomSuggested": True or False, # Indicates if there was a suggested change to offset_bottom.
-                  "offsetLeftSuggested": True or False, # Indicates if there was a suggested change to offset_left.
-                  "offsetRightSuggested": True or False, # Indicates if there was a suggested change to offset_right.
-                  "offsetTopSuggested": True or False, # Indicates if there was a suggested change to offset_top.
+                "startIndex": 42, # The zero-based start index of this structural element, in UTF-16 code units.
+                "table": { # A StructuralElement representing a table. # A table type of structural element.
+                  "columns": 42, # Number of columns in the table. It's possible for a table to be non-rectangular, so some rows may have a different number of cells.
+                  "rows": 42, # Number of rows in the table.
+                  "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # The suggested insertion IDs. A Table may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                    "A String",
+                  ],
+                  "tableRows": [ # The contents and style of each row.
+                    { # The contents and style of a row in a Table.
+                      "endIndex": 42, # The zero-based end index of this row, exclusive, in UTF-16 code units.
+                      "startIndex": 42, # The zero-based start index of this row, in UTF-16 code units.
+                      "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                        "A String",
+                      ],
+                      "suggestedInsertionIds": [ # The suggested insertion IDs. A TableRow may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                        "A String",
+                      ],
+                      "suggestedTableRowStyleChanges": { # The suggested style changes to this row, keyed by suggestion ID.
+                        "a_key": { # A suggested change to a TableRowStyle.
+                          "tableRowStyle": { # Styles that apply to a table row. # A TableRowStyle that only includes the changes made in this suggestion. This can be used along with the table_row_style_suggestion_state to see which fields have changed and their new values.
+                            "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                            "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries.
+                            "tableHeader": True or False, # Whether the row is a table header.
+                          },
+                          "tableRowStyleSuggestionState": { # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion.
+                            "minRowHeightSuggested": True or False, # Indicates if there was a suggested change to min_row_height.
+                          },
+                        },
+                      },
+                      "tableCells": [ # The contents and style of each cell in this row. It's possible for a table to be non-rectangular, so some rows may have a different number of cells than other rows in the same table.
+                        { # The contents and style of a cell in a Table.
+                          "content": [ # The content of the cell.
+                            # Object with schema name: StructuralElement
+                          ],
+                          "endIndex": 42, # The zero-based end index of this cell, exclusive, in UTF-16 code units.
+                          "startIndex": 42, # The zero-based start index of this cell, in UTF-16 code units.
+                          "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                            "A String",
+                          ],
+                          "suggestedInsertionIds": [ # The suggested insertion IDs. A TableCell may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                            "A String",
+                          ],
+                          "suggestedTableCellStyleChanges": { # The suggested changes to the table cell style, keyed by suggestion ID.
+                            "a_key": { # A suggested change to a TableCellStyle.
+                              "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # A TableCellStyle that only includes the changes made in this suggestion. This can be used along with the table_cell_style_suggestion_state to see which fields have changed and their new values.
+                                "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell.
+                                  "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                    "rgbColor": { # An RGB color. # The RGB color value.
+                                      "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                      "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                      "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                    },
+                                  },
+                                },
+                                "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell.
+                                  "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                      "rgbColor": { # An RGB color. # The RGB color value.
+                                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                      },
+                                    },
+                                  },
+                                  "dashStyle": "A String", # The dash style of the border.
+                                  "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                                    "magnitude": 3.14, # The magnitude.
+                                    "unit": "A String", # The units for magnitude.
+                                  },
+                                },
+                                "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell.
+                                  "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                      "rgbColor": { # An RGB color. # The RGB color value.
+                                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                      },
+                                    },
+                                  },
+                                  "dashStyle": "A String", # The dash style of the border.
+                                  "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                                    "magnitude": 3.14, # The magnitude.
+                                    "unit": "A String", # The units for magnitude.
+                                  },
+                                },
+                                "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell.
+                                  "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                      "rgbColor": { # An RGB color. # The RGB color value.
+                                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                      },
+                                    },
+                                  },
+                                  "dashStyle": "A String", # The dash style of the border.
+                                  "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                                    "magnitude": 3.14, # The magnitude.
+                                    "unit": "A String", # The units for magnitude.
+                                  },
+                                },
+                                "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell.
+                                  "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                      "rgbColor": { # An RGB color. # The RGB color value.
+                                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                      },
+                                    },
+                                  },
+                                  "dashStyle": "A String", # The dash style of the border.
+                                  "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                                    "magnitude": 3.14, # The magnitude.
+                                    "unit": "A String", # The units for magnitude.
+                                  },
+                                },
+                                "columnSpan": 42, # The column span of the cell. This property is read-only.
+                                "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor.
+                                "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell.
+                                  "magnitude": 3.14, # The magnitude.
+                                  "unit": "A String", # The units for magnitude.
+                                },
+                                "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell.
+                                  "magnitude": 3.14, # The magnitude.
+                                  "unit": "A String", # The units for magnitude.
+                                },
+                                "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell.
+                                  "magnitude": 3.14, # The magnitude.
+                                  "unit": "A String", # The units for magnitude.
+                                },
+                                "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell.
+                                  "magnitude": 3.14, # The magnitude.
+                                  "unit": "A String", # The units for magnitude.
+                                },
+                                "rowSpan": 42, # The row span of the cell. This property is read-only.
+                              },
+                              "tableCellStyleSuggestionState": { # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion.
+                                "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                                "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom.
+                                "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left.
+                                "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right.
+                                "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top.
+                                "columnSpanSuggested": True or False, # Indicates if there was a suggested change to column_span.
+                                "contentAlignmentSuggested": True or False, # Indicates if there was a suggested change to content_alignment.
+                                "paddingBottomSuggested": True or False, # Indicates if there was a suggested change to padding_bottom.
+                                "paddingLeftSuggested": True or False, # Indicates if there was a suggested change to padding_left.
+                                "paddingRightSuggested": True or False, # Indicates if there was a suggested change to padding_right.
+                                "paddingTopSuggested": True or False, # Indicates if there was a suggested change to padding_top.
+                                "rowSpanSuggested": True or False, # Indicates if there was a suggested change to row_span.
+                              },
+                            },
+                          },
+                          "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # The style of the cell.
+                            "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell.
+                              "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "dashStyle": "A String", # The dash style of the border.
+                              "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                            },
+                            "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell.
+                              "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "dashStyle": "A String", # The dash style of the border.
+                              "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                            },
+                            "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell.
+                              "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "dashStyle": "A String", # The dash style of the border.
+                              "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                            },
+                            "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell.
+                              "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "dashStyle": "A String", # The dash style of the border.
+                              "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                            },
+                            "columnSpan": 42, # The column span of the cell. This property is read-only.
+                            "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor.
+                            "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                            "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                            "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                            "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                            "rowSpan": 42, # The row span of the cell. This property is read-only.
+                          },
+                        },
+                      ],
+                      "tableRowStyle": { # Styles that apply to a table row. # The style of the table row.
+                        "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries.
+                        "tableHeader": True or False, # Whether the row is a table header.
+                      },
+                    },
+                  ],
+                  "tableStyle": { # Styles that apply to a table. # The style of the table.
+                    "tableColumnProperties": [ # The properties of each column. Note that in Docs, tables contain rows and rows contain cells, similar to HTML. So the properties for a row can be found on the row's table_row_style.
+                      { # The properties of a column in a table.
+                        "width": { # A magnitude in a single direction in the specified units. # The width of the column. Set when the column's `width_type` is FIXED_WIDTH.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "widthType": "A String", # The width type of the column.
+                      },
+                    ],
+                  },
                 },
-                "sourceUriSuggested": True or False, # Indicates if there was a suggested change to source_uri.
-                "transparencySuggested": True or False, # Indicates if there was a suggested change to transparency.
-              },
-              "linkedContentReferenceSuggestionState": { # A mask that indicates which of the fields on the base LinkedContentReference have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in linked_content_reference have been changed in this suggestion.
-                "sheetsChartReferenceSuggestionState": { # A mask that indicates which of the fields on the base SheetsChartReference have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in sheets_chart_reference have been changed in this suggestion.
-                  "chartIdSuggested": True or False, # Indicates if there was a suggested change to chart_id.
-                  "spreadsheetIdSuggested": True or False, # Indicates if there was a suggested change to spreadsheet_id.
+                "tableOfContents": { # A StructuralElement representing a table of contents. # A table of contents type of structural element.
+                  "content": [ # The content of the table of contents.
+                    # Object with schema name: StructuralElement
+                  ],
+                  "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # The suggested insertion IDs. A TableOfContents may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion.
+                    "A String",
+                  ],
                 },
               },
-              "marginBottomSuggested": True or False, # Indicates if there was a suggested change to margin_bottom.
-              "marginLeftSuggested": True or False, # Indicates if there was a suggested change to margin_left.
-              "marginRightSuggested": True or False, # Indicates if there was a suggested change to margin_right.
-              "marginTopSuggested": True or False, # Indicates if there was a suggested change to margin_top.
-              "sizeSuggestionState": { # A mask that indicates which of the fields on the base Size have been changed in this suggestion. For any field set to true, the Size has a new suggested value. # A mask that indicates which of the fields in size have been changed in this suggestion.
-                "heightSuggested": True or False, # Indicates if there was a suggested change to height.
-                "widthSuggested": True or False, # Indicates if there was a suggested change to width.
-              },
-              "titleSuggested": True or False, # Indicates if there was a suggested change to title.
-            },
+            ],
+            "footerId": "A String", # The ID of the footer.
           },
         },
-      },
-      "suggestedInsertionId": "A String", # The suggested insertion ID. If empty, then this is not a suggested insertion.
-    },
-  },
-  "lists": { # Output only. The lists in the document, keyed by list ID.
-    "a_key": { # A List represents the list attributes for a group of paragraphs that all belong to the same list. A paragraph that's part of a list has a reference to the list's ID in its bullet.
-      "listProperties": { # The properties of a list that describe the look and feel of bullets belonging to paragraphs associated with a list. # The properties of the list.
-        "nestingLevels": [ # Describes the properties of the bullets at the associated level. A list has at most 9 levels of nesting with nesting level 0 corresponding to the top-most level and nesting level 8 corresponding to the most nested level. The nesting levels are returned in ascending order with the least nested returned first.
-          { # Contains properties describing the look and feel of a list bullet at a given level of nesting.
-            "bulletAlignment": "A String", # The alignment of the bullet within the space allotted for rendering the bullet.
-            "glyphFormat": "A String", # The format string used by bullets at this level of nesting. The glyph format contains one or more placeholders, and these placeholders are replaced with the appropriate values depending on the glyph_type or glyph_symbol. The placeholders follow the pattern `%[nesting_level]`. Furthermore, placeholders can have prefixes and suffixes. Thus, the glyph format follows the pattern `%[nesting_level]`. Note that the prefix and suffix are optional and can be arbitrary strings. For example, the glyph format `%0.` indicates that the rendered glyph will replace the placeholder with the corresponding glyph for nesting level 0 followed by a period as the suffix. So a list with a glyph type of UPPER_ALPHA and glyph format `%0.` at nesting level 0 will result in a list with rendered glyphs `A.` `B.` `C.` The glyph format can contain placeholders for the current nesting level as well as placeholders for parent nesting levels. For example, a list can have a glyph format of `%0.` at nesting level 0 and a glyph format of `%0.%1.` at nesting level 1. Assuming both nesting levels have DECIMAL glyph types, this would result in a list with rendered glyphs `1.` `2.` ` 2.1.` ` 2.2.` `3.` For nesting levels that are ordered, the string that replaces a placeholder in the glyph format for a particular paragraph depends on the paragraph's order within the list.
-            "glyphSymbol": "A String", # A custom glyph symbol used by bullets when paragraphs at this level of nesting are unordered. The glyph symbol replaces placeholders within the glyph_format. For example, if the glyph_symbol is the solid circle corresponding to Unicode U+25cf code point and the glyph_format is `%0`, the rendered glyph would be the solid circle.
-            "glyphType": "A String", # The type of glyph used by bullets when paragraphs at this level of nesting are ordered. The glyph type determines the type of glyph used to replace placeholders within the glyph_format when paragraphs at this level of nesting are ordered. For example, if the nesting level is 0, the glyph_format is `%0.` and the glyph type is DECIMAL, then the rendered glyph would replace the placeholder `%0` in the glyph format with a number corresponding to list item's order within the list.
-            "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of paragraphs at this level of nesting.
-              "magnitude": 3.14, # The magnitude.
-              "unit": "A String", # The units for magnitude.
-            },
-            "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for paragraphs at this level of nesting. Applied to the side that corresponds to the start of the text, based on the paragraph's content direction.
-              "magnitude": 3.14, # The magnitude.
-              "unit": "A String", # The units for magnitude.
-            },
-            "startNumber": 42, # The number of the first list item at this nesting level. A value of 0 is treated as a value of 1 for lettered lists and Roman numeral lists. For values of both 0 and 1, lettered and Roman numeral lists will begin at `a` and `i` respectively. This value is ignored for nesting levels with unordered glyphs.
-            "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of bullets at this level of nesting.
-              "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
-                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
-                  "rgbColor": { # An RGB color. # The RGB color value.
-                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
-                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
-                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+        "footnotes": { # The footnotes in the document tab, keyed by footnote ID.
+          "a_key": { # A document footnote.
+            "content": [ # The contents of the footnote. The indexes for a footnote's content begin at zero.
+              { # A StructuralElement describes content that provides structure to the document.
+                "endIndex": 42, # The zero-based end index of this structural element, exclusive, in UTF-16 code units.
+                "paragraph": { # A StructuralElement representing a paragraph. A paragraph is a range of content that's terminated with a newline character. # A paragraph type of structural element.
+                  "bullet": { # Describes the bullet of a paragraph. # The bullet for this paragraph. If not present, the paragraph does not belong to a list.
+                    "listId": "A String", # The ID of the list this paragraph belongs to.
+                    "nestingLevel": 42, # The nesting level of this paragraph in the list.
+                    "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet.
+                      "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                      "bold": True or False, # Whether or not the text is rendered as bold.
+                      "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "italic": True or False, # Whether or not the text is italicized.
+                      "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                        "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                          "id": "A String", # The ID of a bookmark in this document.
+                          "tabId": "A String", # The ID of the tab containing this bookmark.
+                        },
+                        "bookmarkId": "A String", # The ID of a bookmark in this document.
+                        "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                          "id": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of the tab containing this heading.
+                        },
+                        "headingId": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of a tab in this document.
+                        "url": "A String", # An external URL.
+                      },
+                      "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                      "strikethrough": True or False, # Whether or not the text is struck through.
+                      "underline": True or False, # Whether or not the text is underlined.
+                      "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                        "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                        "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                      },
+                    },
+                  },
+                  "elements": [ # The content of the paragraph, broken down into its component parts.
+                    { # A ParagraphElement describes content within a Paragraph.
+                      "autoText": { # A ParagraphElement representing a spot in the text that's dynamically replaced with content that can change over time, like a page number. # An auto text paragraph element.
+                        "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                          "A String",
+                        ],
+                        "suggestedInsertionIds": [ # The suggested insertion IDs. An AutoText may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                          "A String",
+                        ],
+                        "suggestedTextStyleChanges": { # The suggested text style changes to this AutoText, keyed by suggestion ID.
+                          "a_key": { # A suggested change to a TextStyle.
+                            "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                              "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                              "bold": True or False, # Whether or not the text is rendered as bold.
+                              "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                              "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "italic": True or False, # Whether or not the text is italicized.
+                              "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                                "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a bookmark in this document.
+                                  "tabId": "A String", # The ID of the tab containing this bookmark.
+                                },
+                                "bookmarkId": "A String", # The ID of a bookmark in this document.
+                                "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a heading in this document.
+                                  "tabId": "A String", # The ID of the tab containing this heading.
+                                },
+                                "headingId": "A String", # The ID of a heading in this document.
+                                "tabId": "A String", # The ID of a tab in this document.
+                                "url": "A String", # An external URL.
+                              },
+                              "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                              "strikethrough": True or False, # Whether or not the text is struck through.
+                              "underline": True or False, # Whether or not the text is underlined.
+                              "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                                "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                                "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                              },
+                            },
+                            "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                              "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                              "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                              "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                              "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                              "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                              "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                              "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                              "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                              "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                              "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                              "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                            },
+                          },
+                        },
+                        "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this AutoText.
+                          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                          "bold": True or False, # Whether or not the text is rendered as bold.
+                          "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "italic": True or False, # Whether or not the text is italicized.
+                          "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                            "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a bookmark in this document.
+                              "tabId": "A String", # The ID of the tab containing this bookmark.
+                            },
+                            "bookmarkId": "A String", # The ID of a bookmark in this document.
+                            "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a heading in this document.
+                              "tabId": "A String", # The ID of the tab containing this heading.
+                            },
+                            "headingId": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of a tab in this document.
+                            "url": "A String", # An external URL.
+                          },
+                          "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                          "strikethrough": True or False, # Whether or not the text is struck through.
+                          "underline": True or False, # Whether or not the text is underlined.
+                          "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                            "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                            "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                          },
+                        },
+                        "type": "A String", # The type of this auto text.
+                      },
+                      "columnBreak": { # A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column. # A column break paragraph element.
+                        "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                          "A String",
+                        ],
+                        "suggestedInsertionIds": [ # The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                          "A String",
+                        ],
+                        "suggestedTextStyleChanges": { # The suggested text style changes to this ColumnBreak, keyed by suggestion ID.
+                          "a_key": { # A suggested change to a TextStyle.
+                            "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                              "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                              "bold": True or False, # Whether or not the text is rendered as bold.
+                              "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                              "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "italic": True or False, # Whether or not the text is italicized.
+                              "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                                "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a bookmark in this document.
+                                  "tabId": "A String", # The ID of the tab containing this bookmark.
+                                },
+                                "bookmarkId": "A String", # The ID of a bookmark in this document.
+                                "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a heading in this document.
+                                  "tabId": "A String", # The ID of the tab containing this heading.
+                                },
+                                "headingId": "A String", # The ID of a heading in this document.
+                                "tabId": "A String", # The ID of a tab in this document.
+                                "url": "A String", # An external URL.
+                              },
+                              "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                              "strikethrough": True or False, # Whether or not the text is struck through.
+                              "underline": True or False, # Whether or not the text is underlined.
+                              "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                                "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                                "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                              },
+                            },
+                            "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                              "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                              "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                              "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                              "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                              "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                              "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                              "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                              "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                              "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                              "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                              "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                            },
+                          },
+                        },
+                        "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it.
+                          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                          "bold": True or False, # Whether or not the text is rendered as bold.
+                          "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "italic": True or False, # Whether or not the text is italicized.
+                          "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                            "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a bookmark in this document.
+                              "tabId": "A String", # The ID of the tab containing this bookmark.
+                            },
+                            "bookmarkId": "A String", # The ID of a bookmark in this document.
+                            "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a heading in this document.
+                              "tabId": "A String", # The ID of the tab containing this heading.
+                            },
+                            "headingId": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of a tab in this document.
+                            "url": "A String", # An external URL.
+                          },
+                          "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                          "strikethrough": True or False, # Whether or not the text is struck through.
+                          "underline": True or False, # Whether or not the text is underlined.
+                          "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                            "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                            "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                          },
+                        },
+                      },
+                      "endIndex": 42, # The zero-base end index of this paragraph element, exclusive, in UTF-16 code units.
+                      "equation": { # A ParagraphElement representing an equation. # An equation paragraph element.
+                        "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                          "A String",
+                        ],
+                        "suggestedInsertionIds": [ # The suggested insertion IDs. An Equation may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                          "A String",
+                        ],
+                      },
+                      "footnoteReference": { # A ParagraphElement representing a footnote reference. A footnote reference is the inline content rendered with a number and is used to identify the footnote. # A footnote reference paragraph element.
+                        "footnoteId": "A String", # The ID of the footnote that contains the content of this footnote reference.
+                        "footnoteNumber": "A String", # The rendered number of this footnote.
+                        "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                          "A String",
+                        ],
+                        "suggestedInsertionIds": [ # The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                          "A String",
+                        ],
+                        "suggestedTextStyleChanges": { # The suggested text style changes to this FootnoteReference, keyed by suggestion ID.
+                          "a_key": { # A suggested change to a TextStyle.
+                            "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                              "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                              "bold": True or False, # Whether or not the text is rendered as bold.
+                              "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                              "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "italic": True or False, # Whether or not the text is italicized.
+                              "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                                "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a bookmark in this document.
+                                  "tabId": "A String", # The ID of the tab containing this bookmark.
+                                },
+                                "bookmarkId": "A String", # The ID of a bookmark in this document.
+                                "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a heading in this document.
+                                  "tabId": "A String", # The ID of the tab containing this heading.
+                                },
+                                "headingId": "A String", # The ID of a heading in this document.
+                                "tabId": "A String", # The ID of a tab in this document.
+                                "url": "A String", # An external URL.
+                              },
+                              "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                              "strikethrough": True or False, # Whether or not the text is struck through.
+                              "underline": True or False, # Whether or not the text is underlined.
+                              "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                                "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                                "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                              },
+                            },
+                            "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                              "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                              "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                              "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                              "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                              "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                              "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                              "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                              "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                              "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                              "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                              "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                            },
+                          },
+                        },
+                        "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this FootnoteReference.
+                          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                          "bold": True or False, # Whether or not the text is rendered as bold.
+                          "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "italic": True or False, # Whether or not the text is italicized.
+                          "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                            "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a bookmark in this document.
+                              "tabId": "A String", # The ID of the tab containing this bookmark.
+                            },
+                            "bookmarkId": "A String", # The ID of a bookmark in this document.
+                            "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a heading in this document.
+                              "tabId": "A String", # The ID of the tab containing this heading.
+                            },
+                            "headingId": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of a tab in this document.
+                            "url": "A String", # An external URL.
+                          },
+                          "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                          "strikethrough": True or False, # Whether or not the text is struck through.
+                          "underline": True or False, # Whether or not the text is underlined.
+                          "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                            "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                            "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                          },
+                        },
+                      },
+                      "horizontalRule": { # A ParagraphElement representing a horizontal line. # A horizontal rule paragraph element.
+                        "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                          "A String",
+                        ],
+                        "suggestedInsertionIds": [ # The suggested insertion IDs. A HorizontalRule may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion.
+                          "A String",
+                        ],
+                        "suggestedTextStyleChanges": { # The suggested text style changes to this HorizontalRule, keyed by suggestion ID.
+                          "a_key": { # A suggested change to a TextStyle.
+                            "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                              "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                              "bold": True or False, # Whether or not the text is rendered as bold.
+                              "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                              "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "italic": True or False, # Whether or not the text is italicized.
+                              "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                                "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a bookmark in this document.
+                                  "tabId": "A String", # The ID of the tab containing this bookmark.
+                                },
+                                "bookmarkId": "A String", # The ID of a bookmark in this document.
+                                "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a heading in this document.
+                                  "tabId": "A String", # The ID of the tab containing this heading.
+                                },
+                                "headingId": "A String", # The ID of a heading in this document.
+                                "tabId": "A String", # The ID of a tab in this document.
+                                "url": "A String", # An external URL.
+                              },
+                              "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                              "strikethrough": True or False, # Whether or not the text is struck through.
+                              "underline": True or False, # Whether or not the text is underlined.
+                              "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                                "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                                "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                              },
+                            },
+                            "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                              "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                              "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                              "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                              "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                              "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                              "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                              "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                              "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                              "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                              "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                              "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                            },
+                          },
+                        },
+                        "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this HorizontalRule. Similar to text content, like text runs and footnote references, the text style of a horizontal rule can affect content layout as well as the styling of text inserted next to it.
+                          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                          "bold": True or False, # Whether or not the text is rendered as bold.
+                          "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "italic": True or False, # Whether or not the text is italicized.
+                          "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                            "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a bookmark in this document.
+                              "tabId": "A String", # The ID of the tab containing this bookmark.
+                            },
+                            "bookmarkId": "A String", # The ID of a bookmark in this document.
+                            "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a heading in this document.
+                              "tabId": "A String", # The ID of the tab containing this heading.
+                            },
+                            "headingId": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of a tab in this document.
+                            "url": "A String", # An external URL.
+                          },
+                          "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                          "strikethrough": True or False, # Whether or not the text is struck through.
+                          "underline": True or False, # Whether or not the text is underlined.
+                          "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                            "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                            "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                          },
+                        },
+                      },
+                      "inlineObjectElement": { # A ParagraphElement that contains an InlineObject. # An inline object paragraph element.
+                        "inlineObjectId": "A String", # The ID of the InlineObject this element contains.
+                        "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                          "A String",
+                        ],
+                        "suggestedInsertionIds": [ # The suggested insertion IDs. An InlineObjectElement may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                          "A String",
+                        ],
+                        "suggestedTextStyleChanges": { # The suggested text style changes to this InlineObject, keyed by suggestion ID.
+                          "a_key": { # A suggested change to a TextStyle.
+                            "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                              "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                              "bold": True or False, # Whether or not the text is rendered as bold.
+                              "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                              "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "italic": True or False, # Whether or not the text is italicized.
+                              "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                                "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a bookmark in this document.
+                                  "tabId": "A String", # The ID of the tab containing this bookmark.
+                                },
+                                "bookmarkId": "A String", # The ID of a bookmark in this document.
+                                "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a heading in this document.
+                                  "tabId": "A String", # The ID of the tab containing this heading.
+                                },
+                                "headingId": "A String", # The ID of a heading in this document.
+                                "tabId": "A String", # The ID of a tab in this document.
+                                "url": "A String", # An external URL.
+                              },
+                              "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                              "strikethrough": True or False, # Whether or not the text is struck through.
+                              "underline": True or False, # Whether or not the text is underlined.
+                              "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                                "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                                "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                              },
+                            },
+                            "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                              "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                              "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                              "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                              "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                              "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                              "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                              "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                              "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                              "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                              "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                              "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                            },
+                          },
+                        },
+                        "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this InlineObjectElement. Similar to text content, like text runs and footnote references, the text style of an inline object element can affect content layout as well as the styling of text inserted next to it.
+                          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                          "bold": True or False, # Whether or not the text is rendered as bold.
+                          "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "italic": True or False, # Whether or not the text is italicized.
+                          "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                            "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a bookmark in this document.
+                              "tabId": "A String", # The ID of the tab containing this bookmark.
+                            },
+                            "bookmarkId": "A String", # The ID of a bookmark in this document.
+                            "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a heading in this document.
+                              "tabId": "A String", # The ID of the tab containing this heading.
+                            },
+                            "headingId": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of a tab in this document.
+                            "url": "A String", # An external URL.
+                          },
+                          "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                          "strikethrough": True or False, # Whether or not the text is struck through.
+                          "underline": True or False, # Whether or not the text is underlined.
+                          "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                            "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                            "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                          },
+                        },
+                      },
+                      "pageBreak": { # A ParagraphElement representing a page break. A page break makes the subsequent text start at the top of the next page. # A page break paragraph element.
+                        "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                          "A String",
+                        ],
+                        "suggestedInsertionIds": [ # The suggested insertion IDs. A PageBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                          "A String",
+                        ],
+                        "suggestedTextStyleChanges": { # The suggested text style changes to this PageBreak, keyed by suggestion ID.
+                          "a_key": { # A suggested change to a TextStyle.
+                            "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                              "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                              "bold": True or False, # Whether or not the text is rendered as bold.
+                              "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                              "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "italic": True or False, # Whether or not the text is italicized.
+                              "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                                "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a bookmark in this document.
+                                  "tabId": "A String", # The ID of the tab containing this bookmark.
+                                },
+                                "bookmarkId": "A String", # The ID of a bookmark in this document.
+                                "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a heading in this document.
+                                  "tabId": "A String", # The ID of the tab containing this heading.
+                                },
+                                "headingId": "A String", # The ID of a heading in this document.
+                                "tabId": "A String", # The ID of a tab in this document.
+                                "url": "A String", # An external URL.
+                              },
+                              "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                              "strikethrough": True or False, # Whether or not the text is struck through.
+                              "underline": True or False, # Whether or not the text is underlined.
+                              "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                                "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                                "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                              },
+                            },
+                            "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                              "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                              "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                              "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                              "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                              "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                              "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                              "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                              "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                              "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                              "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                              "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                            },
+                          },
+                        },
+                        "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this PageBreak. Similar to text content, like text runs and footnote references, the text style of a page break can affect content layout as well as the styling of text inserted next to it.
+                          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                          "bold": True or False, # Whether or not the text is rendered as bold.
+                          "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "italic": True or False, # Whether or not the text is italicized.
+                          "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                            "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a bookmark in this document.
+                              "tabId": "A String", # The ID of the tab containing this bookmark.
+                            },
+                            "bookmarkId": "A String", # The ID of a bookmark in this document.
+                            "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a heading in this document.
+                              "tabId": "A String", # The ID of the tab containing this heading.
+                            },
+                            "headingId": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of a tab in this document.
+                            "url": "A String", # An external URL.
+                          },
+                          "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                          "strikethrough": True or False, # Whether or not the text is struck through.
+                          "underline": True or False, # Whether or not the text is underlined.
+                          "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                            "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                            "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                          },
+                        },
+                      },
+                      "person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address.
+                        "personId": "A String", # Output only. The unique ID of this link.
+                        "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present.
+                          "email": "A String", # Output only. The email address linked to this Person. This field is always present.
+                          "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address.
+                        },
+                        "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion.
+                          "A String",
+                        ],
+                        "suggestedInsertionIds": [ # IDs for suggestions that insert this person link into the document. A Person might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion.
+                          "A String",
+                        ],
+                        "suggestedTextStyleChanges": { # The suggested text style changes to this Person, keyed by suggestion ID.
+                          "a_key": { # A suggested change to a TextStyle.
+                            "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                              "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                              "bold": True or False, # Whether or not the text is rendered as bold.
+                              "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                              "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "italic": True or False, # Whether or not the text is italicized.
+                              "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                                "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a bookmark in this document.
+                                  "tabId": "A String", # The ID of the tab containing this bookmark.
+                                },
+                                "bookmarkId": "A String", # The ID of a bookmark in this document.
+                                "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a heading in this document.
+                                  "tabId": "A String", # The ID of the tab containing this heading.
+                                },
+                                "headingId": "A String", # The ID of a heading in this document.
+                                "tabId": "A String", # The ID of a tab in this document.
+                                "url": "A String", # An external URL.
+                              },
+                              "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                              "strikethrough": True or False, # Whether or not the text is struck through.
+                              "underline": True or False, # Whether or not the text is underlined.
+                              "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                                "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                                "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                              },
+                            },
+                            "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                              "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                              "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                              "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                              "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                              "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                              "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                              "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                              "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                              "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                              "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                              "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                            },
+                          },
+                        },
+                        "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this Person.
+                          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                          "bold": True or False, # Whether or not the text is rendered as bold.
+                          "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "italic": True or False, # Whether or not the text is italicized.
+                          "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                            "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a bookmark in this document.
+                              "tabId": "A String", # The ID of the tab containing this bookmark.
+                            },
+                            "bookmarkId": "A String", # The ID of a bookmark in this document.
+                            "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a heading in this document.
+                              "tabId": "A String", # The ID of the tab containing this heading.
+                            },
+                            "headingId": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of a tab in this document.
+                            "url": "A String", # An external URL.
+                          },
+                          "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                          "strikethrough": True or False, # Whether or not the text is struck through.
+                          "underline": True or False, # Whether or not the text is underlined.
+                          "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                            "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                            "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                          },
+                        },
+                      },
+                      "richLink": { # A link to a Google resource (such as a file in Drive, a YouTube video, or a Calendar event). # A paragraph element that links to a Google resource (such as a file in Google Drive, a YouTube video, or a Calendar event.)
+                        "richLinkId": "A String", # Output only. The ID of this link.
+                        "richLinkProperties": { # Properties specific to a RichLink. # Output only. The properties of this RichLink. This field is always present.
+                          "mimeType": "A String", # Output only. The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the RichLink, if there's one (for example, when it's a file in Drive).
+                          "title": "A String", # Output only. The title of the RichLink as displayed in the link. This title matches the title of the linked resource at the time of the insertion or last update of the link. This field is always present.
+                          "uri": "A String", # Output only. The URI to the RichLink. This is always present.
+                        },
+                        "suggestedDeletionIds": [ # IDs for suggestions that remove this link from the document. A RichLink might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion.
+                          "A String",
+                        ],
+                        "suggestedInsertionIds": [ # IDs for suggestions that insert this link into the document. A RichLink might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion.
+                          "A String",
+                        ],
+                        "suggestedTextStyleChanges": { # The suggested text style changes to this RichLink, keyed by suggestion ID.
+                          "a_key": { # A suggested change to a TextStyle.
+                            "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                              "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                              "bold": True or False, # Whether or not the text is rendered as bold.
+                              "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                              "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "italic": True or False, # Whether or not the text is italicized.
+                              "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                                "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a bookmark in this document.
+                                  "tabId": "A String", # The ID of the tab containing this bookmark.
+                                },
+                                "bookmarkId": "A String", # The ID of a bookmark in this document.
+                                "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a heading in this document.
+                                  "tabId": "A String", # The ID of the tab containing this heading.
+                                },
+                                "headingId": "A String", # The ID of a heading in this document.
+                                "tabId": "A String", # The ID of a tab in this document.
+                                "url": "A String", # An external URL.
+                              },
+                              "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                              "strikethrough": True or False, # Whether or not the text is struck through.
+                              "underline": True or False, # Whether or not the text is underlined.
+                              "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                                "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                                "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                              },
+                            },
+                            "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                              "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                              "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                              "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                              "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                              "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                              "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                              "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                              "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                              "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                              "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                              "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                            },
+                          },
+                        },
+                        "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this RichLink.
+                          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                          "bold": True or False, # Whether or not the text is rendered as bold.
+                          "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "italic": True or False, # Whether or not the text is italicized.
+                          "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                            "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a bookmark in this document.
+                              "tabId": "A String", # The ID of the tab containing this bookmark.
+                            },
+                            "bookmarkId": "A String", # The ID of a bookmark in this document.
+                            "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a heading in this document.
+                              "tabId": "A String", # The ID of the tab containing this heading.
+                            },
+                            "headingId": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of a tab in this document.
+                            "url": "A String", # An external URL.
+                          },
+                          "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                          "strikethrough": True or False, # Whether or not the text is struck through.
+                          "underline": True or False, # Whether or not the text is underlined.
+                          "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                            "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                            "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                          },
+                        },
+                      },
+                      "startIndex": 42, # The zero-based start index of this paragraph element, in UTF-16 code units.
+                      "textRun": { # A ParagraphElement that represents a run of text that all has the same styling. # A text run paragraph element.
+                        "content": "A String", # The text of this run. Any non-text elements in the run are replaced with the Unicode character U+E907.
+                        "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                          "A String",
+                        ],
+                        "suggestedInsertionIds": [ # The suggested insertion IDs. A TextRun may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                          "A String",
+                        ],
+                        "suggestedTextStyleChanges": { # The suggested text style changes to this run, keyed by suggestion ID.
+                          "a_key": { # A suggested change to a TextStyle.
+                            "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                              "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                              "bold": True or False, # Whether or not the text is rendered as bold.
+                              "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                              "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "italic": True or False, # Whether or not the text is italicized.
+                              "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                                "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a bookmark in this document.
+                                  "tabId": "A String", # The ID of the tab containing this bookmark.
+                                },
+                                "bookmarkId": "A String", # The ID of a bookmark in this document.
+                                "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a heading in this document.
+                                  "tabId": "A String", # The ID of the tab containing this heading.
+                                },
+                                "headingId": "A String", # The ID of a heading in this document.
+                                "tabId": "A String", # The ID of a tab in this document.
+                                "url": "A String", # An external URL.
+                              },
+                              "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                              "strikethrough": True or False, # Whether or not the text is struck through.
+                              "underline": True or False, # Whether or not the text is underlined.
+                              "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                                "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                                "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                              },
+                            },
+                            "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                              "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                              "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                              "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                              "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                              "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                              "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                              "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                              "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                              "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                              "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                              "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                            },
+                          },
+                        },
+                        "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this run.
+                          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                          "bold": True or False, # Whether or not the text is rendered as bold.
+                          "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "italic": True or False, # Whether or not the text is italicized.
+                          "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                            "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a bookmark in this document.
+                              "tabId": "A String", # The ID of the tab containing this bookmark.
+                            },
+                            "bookmarkId": "A String", # The ID of a bookmark in this document.
+                            "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a heading in this document.
+                              "tabId": "A String", # The ID of the tab containing this heading.
+                            },
+                            "headingId": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of a tab in this document.
+                            "url": "A String", # An external URL.
+                          },
+                          "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                          "strikethrough": True or False, # Whether or not the text is struck through.
+                          "underline": True or False, # Whether or not the text is underlined.
+                          "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                            "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                            "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                          },
+                        },
+                      },
+                    },
+                  ],
+                  "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The style of this paragraph.
+                    "alignment": "A String", # The text alignment for this paragraph.
+                    "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent.
+                    "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                      "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "dashStyle": "A String", # The dash style of the border.
+                      "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                    },
+                    "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                      "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "dashStyle": "A String", # The dash style of the border.
+                      "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                    },
+                    "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                      "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "dashStyle": "A String", # The dash style of the border.
+                      "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                    },
+                    "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                      "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "dashStyle": "A String", # The dash style of the border.
+                      "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                    },
+                    "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                      "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "dashStyle": "A String", # The dash style of the border.
+                      "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                    },
+                    "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited.
+                    "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only.
+                    "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent.
+                    "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent.
+                    "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent.
+                    "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated.
+                    "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error.
+                    "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent.
+                      "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                    },
+                    "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "spacingMode": "A String", # The spacing mode for the paragraph.
+                    "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only.
+                      { # A tab stop within a paragraph.
+                        "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START.
+                        "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                      },
+                    ],
+                  },
+                  "positionedObjectIds": [ # The IDs of the positioned objects tethered to this paragraph.
+                    "A String",
+                  ],
+                  "suggestedBulletChanges": { # The suggested changes to this paragraph's bullet.
+                    "a_key": { # A suggested change to a Bullet.
+                      "bullet": { # Describes the bullet of a paragraph. # A Bullet that only includes the changes made in this suggestion. This can be used along with the bullet_suggestion_state to see which fields have changed and their new values.
+                        "listId": "A String", # The ID of the list this paragraph belongs to.
+                        "nestingLevel": 42, # The nesting level of this paragraph in the list.
+                        "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet.
+                          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                          "bold": True or False, # Whether or not the text is rendered as bold.
+                          "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "italic": True or False, # Whether or not the text is italicized.
+                          "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                            "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a bookmark in this document.
+                              "tabId": "A String", # The ID of the tab containing this bookmark.
+                            },
+                            "bookmarkId": "A String", # The ID of a bookmark in this document.
+                            "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a heading in this document.
+                              "tabId": "A String", # The ID of the tab containing this heading.
+                            },
+                            "headingId": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of a tab in this document.
+                            "url": "A String", # An external URL.
+                          },
+                          "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                          "strikethrough": True or False, # Whether or not the text is struck through.
+                          "underline": True or False, # Whether or not the text is underlined.
+                          "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                            "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                            "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                          },
+                        },
+                      },
+                      "bulletSuggestionState": { # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion.
+                        "listIdSuggested": True or False, # Indicates if there was a suggested change to the list_id.
+                        "nestingLevelSuggested": True or False, # Indicates if there was a suggested change to the nesting_level.
+                        "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion.
+                          "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                          "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                          "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                          "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                          "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                          "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                          "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                          "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                          "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                          "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                          "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                        },
+                      },
+                    },
+                  },
+                  "suggestedParagraphStyleChanges": { # The suggested paragraph style changes to this paragraph, keyed by suggestion ID.
+                    "a_key": { # A suggested change to a ParagraphStyle.
+                      "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A ParagraphStyle that only includes the changes made in this suggestion. This can be used along with the paragraph_style_suggestion_state to see which fields have changed and their new values.
+                        "alignment": "A String", # The text alignment for this paragraph.
+                        "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent.
+                        "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                          "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "dashStyle": "A String", # The dash style of the border.
+                          "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                        },
+                        "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                          "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "dashStyle": "A String", # The dash style of the border.
+                          "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                        },
+                        "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                          "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "dashStyle": "A String", # The dash style of the border.
+                          "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                        },
+                        "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                          "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "dashStyle": "A String", # The dash style of the border.
+                          "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                        },
+                        "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                          "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "dashStyle": "A String", # The dash style of the border.
+                          "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                        },
+                        "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited.
+                        "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only.
+                        "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent.
+                        "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent.
+                        "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent.
+                        "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated.
+                        "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error.
+                        "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent.
+                          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                        },
+                        "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "spacingMode": "A String", # The spacing mode for the paragraph.
+                        "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only.
+                          { # A tab stop within a paragraph.
+                            "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START.
+                            "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                          },
+                        ],
+                      },
+                      "paragraphStyleSuggestionState": { # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion.
+                        "alignmentSuggested": True or False, # Indicates if there was a suggested change to alignment.
+                        "avoidWidowAndOrphanSuggested": True or False, # Indicates if there was a suggested change to avoid_widow_and_orphan.
+                        "borderBetweenSuggested": True or False, # Indicates if there was a suggested change to border_between.
+                        "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom.
+                        "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left.
+                        "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right.
+                        "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top.
+                        "directionSuggested": True or False, # Indicates if there was a suggested change to direction.
+                        "headingIdSuggested": True or False, # Indicates if there was a suggested change to heading_id.
+                        "indentEndSuggested": True or False, # Indicates if there was a suggested change to indent_end.
+                        "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line.
+                        "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start.
+                        "keepLinesTogetherSuggested": True or False, # Indicates if there was a suggested change to keep_lines_together.
+                        "keepWithNextSuggested": True or False, # Indicates if there was a suggested change to keep_with_next.
+                        "lineSpacingSuggested": True or False, # Indicates if there was a suggested change to line_spacing.
+                        "namedStyleTypeSuggested": True or False, # Indicates if there was a suggested change to named_style_type.
+                        "pageBreakBeforeSuggested": True or False, # Indicates if there was a suggested change to page_break_before.
+                        "shadingSuggestionState": { # A mask that indicates which of the fields on the base Shading have been changed in this suggested change. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in shading have been changed in this suggestion.
+                          "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to the Shading.
+                        },
+                        "spaceAboveSuggested": True or False, # Indicates if there was a suggested change to space_above.
+                        "spaceBelowSuggested": True or False, # Indicates if there was a suggested change to space_below.
+                        "spacingModeSuggested": True or False, # Indicates if there was a suggested change to spacing_mode.
+                      },
+                    },
+                  },
+                  "suggestedPositionedObjectIds": { # The IDs of the positioned objects suggested to be attached to this paragraph, keyed by suggestion ID.
+                    "a_key": { # A collection of object IDs.
+                      "objectIds": [ # The object IDs.
+                        "A String",
+                      ],
+                    },
+                  },
+                },
+                "sectionBreak": { # A StructuralElement representing a section break. A section is a range of content that has the same SectionStyle. A section break represents the start of a new section, and the section style applies to the section after the section break. The document body always begins with a section break. # A section break type of structural element.
+                  "sectionStyle": { # The styling that applies to a section. # The style of the section after this section break.
+                    "columnProperties": [ # The section's columns properties. If empty, the section contains one column with the default properties in the Docs editor. A section can be updated to have no more than 3 columns. When updating this property, setting a concrete value is required. Unsetting this property will result in a 400 bad request error.
+                      { # Properties that apply to a section's column.
+                        "paddingEnd": { # A magnitude in a single direction in the specified units. # The padding at the end of the column.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "width": { # A magnitude in a single direction in the specified units. # Output only. The width of the column.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                      },
+                    ],
+                    "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                    "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                    "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only.
+                    "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only.
+                    "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only.
+                    "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only.
+                    "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only.
+                    "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only.
+                    "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                    "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                    "sectionType": "A String", # Output only. The type of section.
+                    "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
                   },
+                  "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # The suggested insertion IDs. A SectionBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                    "A String",
+                  ],
                 },
-              },
-              "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
-              "bold": True or False, # Whether or not the text is rendered as bold.
-              "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
-                "magnitude": 3.14, # The magnitude.
-                "unit": "A String", # The units for magnitude.
-              },
-              "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
-                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
-                  "rgbColor": { # An RGB color. # The RGB color value.
-                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
-                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
-                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                "startIndex": 42, # The zero-based start index of this structural element, in UTF-16 code units.
+                "table": { # A StructuralElement representing a table. # A table type of structural element.
+                  "columns": 42, # Number of columns in the table. It's possible for a table to be non-rectangular, so some rows may have a different number of cells.
+                  "rows": 42, # Number of rows in the table.
+                  "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # The suggested insertion IDs. A Table may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                    "A String",
+                  ],
+                  "tableRows": [ # The contents and style of each row.
+                    { # The contents and style of a row in a Table.
+                      "endIndex": 42, # The zero-based end index of this row, exclusive, in UTF-16 code units.
+                      "startIndex": 42, # The zero-based start index of this row, in UTF-16 code units.
+                      "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                        "A String",
+                      ],
+                      "suggestedInsertionIds": [ # The suggested insertion IDs. A TableRow may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                        "A String",
+                      ],
+                      "suggestedTableRowStyleChanges": { # The suggested style changes to this row, keyed by suggestion ID.
+                        "a_key": { # A suggested change to a TableRowStyle.
+                          "tableRowStyle": { # Styles that apply to a table row. # A TableRowStyle that only includes the changes made in this suggestion. This can be used along with the table_row_style_suggestion_state to see which fields have changed and their new values.
+                            "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                            "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries.
+                            "tableHeader": True or False, # Whether the row is a table header.
+                          },
+                          "tableRowStyleSuggestionState": { # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion.
+                            "minRowHeightSuggested": True or False, # Indicates if there was a suggested change to min_row_height.
+                          },
+                        },
+                      },
+                      "tableCells": [ # The contents and style of each cell in this row. It's possible for a table to be non-rectangular, so some rows may have a different number of cells than other rows in the same table.
+                        { # The contents and style of a cell in a Table.
+                          "content": [ # The content of the cell.
+                            # Object with schema name: StructuralElement
+                          ],
+                          "endIndex": 42, # The zero-based end index of this cell, exclusive, in UTF-16 code units.
+                          "startIndex": 42, # The zero-based start index of this cell, in UTF-16 code units.
+                          "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                            "A String",
+                          ],
+                          "suggestedInsertionIds": [ # The suggested insertion IDs. A TableCell may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                            "A String",
+                          ],
+                          "suggestedTableCellStyleChanges": { # The suggested changes to the table cell style, keyed by suggestion ID.
+                            "a_key": { # A suggested change to a TableCellStyle.
+                              "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # A TableCellStyle that only includes the changes made in this suggestion. This can be used along with the table_cell_style_suggestion_state to see which fields have changed and their new values.
+                                "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell.
+                                  "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                    "rgbColor": { # An RGB color. # The RGB color value.
+                                      "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                      "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                      "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                    },
+                                  },
+                                },
+                                "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell.
+                                  "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                      "rgbColor": { # An RGB color. # The RGB color value.
+                                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                      },
+                                    },
+                                  },
+                                  "dashStyle": "A String", # The dash style of the border.
+                                  "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                                    "magnitude": 3.14, # The magnitude.
+                                    "unit": "A String", # The units for magnitude.
+                                  },
+                                },
+                                "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell.
+                                  "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                      "rgbColor": { # An RGB color. # The RGB color value.
+                                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                      },
+                                    },
+                                  },
+                                  "dashStyle": "A String", # The dash style of the border.
+                                  "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                                    "magnitude": 3.14, # The magnitude.
+                                    "unit": "A String", # The units for magnitude.
+                                  },
+                                },
+                                "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell.
+                                  "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                      "rgbColor": { # An RGB color. # The RGB color value.
+                                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                      },
+                                    },
+                                  },
+                                  "dashStyle": "A String", # The dash style of the border.
+                                  "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                                    "magnitude": 3.14, # The magnitude.
+                                    "unit": "A String", # The units for magnitude.
+                                  },
+                                },
+                                "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell.
+                                  "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                      "rgbColor": { # An RGB color. # The RGB color value.
+                                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                      },
+                                    },
+                                  },
+                                  "dashStyle": "A String", # The dash style of the border.
+                                  "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                                    "magnitude": 3.14, # The magnitude.
+                                    "unit": "A String", # The units for magnitude.
+                                  },
+                                },
+                                "columnSpan": 42, # The column span of the cell. This property is read-only.
+                                "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor.
+                                "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell.
+                                  "magnitude": 3.14, # The magnitude.
+                                  "unit": "A String", # The units for magnitude.
+                                },
+                                "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell.
+                                  "magnitude": 3.14, # The magnitude.
+                                  "unit": "A String", # The units for magnitude.
+                                },
+                                "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell.
+                                  "magnitude": 3.14, # The magnitude.
+                                  "unit": "A String", # The units for magnitude.
+                                },
+                                "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell.
+                                  "magnitude": 3.14, # The magnitude.
+                                  "unit": "A String", # The units for magnitude.
+                                },
+                                "rowSpan": 42, # The row span of the cell. This property is read-only.
+                              },
+                              "tableCellStyleSuggestionState": { # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion.
+                                "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                                "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom.
+                                "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left.
+                                "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right.
+                                "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top.
+                                "columnSpanSuggested": True or False, # Indicates if there was a suggested change to column_span.
+                                "contentAlignmentSuggested": True or False, # Indicates if there was a suggested change to content_alignment.
+                                "paddingBottomSuggested": True or False, # Indicates if there was a suggested change to padding_bottom.
+                                "paddingLeftSuggested": True or False, # Indicates if there was a suggested change to padding_left.
+                                "paddingRightSuggested": True or False, # Indicates if there was a suggested change to padding_right.
+                                "paddingTopSuggested": True or False, # Indicates if there was a suggested change to padding_top.
+                                "rowSpanSuggested": True or False, # Indicates if there was a suggested change to row_span.
+                              },
+                            },
+                          },
+                          "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # The style of the cell.
+                            "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell.
+                              "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "dashStyle": "A String", # The dash style of the border.
+                              "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                            },
+                            "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell.
+                              "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "dashStyle": "A String", # The dash style of the border.
+                              "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                            },
+                            "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell.
+                              "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "dashStyle": "A String", # The dash style of the border.
+                              "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                            },
+                            "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell.
+                              "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "dashStyle": "A String", # The dash style of the border.
+                              "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                            },
+                            "columnSpan": 42, # The column span of the cell. This property is read-only.
+                            "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor.
+                            "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                            "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                            "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                            "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                            "rowSpan": 42, # The row span of the cell. This property is read-only.
+                          },
+                        },
+                      ],
+                      "tableRowStyle": { # Styles that apply to a table row. # The style of the table row.
+                        "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries.
+                        "tableHeader": True or False, # Whether the row is a table header.
+                      },
+                    },
+                  ],
+                  "tableStyle": { # Styles that apply to a table. # The style of the table.
+                    "tableColumnProperties": [ # The properties of each column. Note that in Docs, tables contain rows and rows contain cells, similar to HTML. So the properties for a row can be found on the row's table_row_style.
+                      { # The properties of a column in a table.
+                        "width": { # A magnitude in a single direction in the specified units. # The width of the column. Set when the column's `width_type` is FIXED_WIDTH.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "widthType": "A String", # The width type of the column.
+                      },
+                    ],
                   },
                 },
+                "tableOfContents": { # A StructuralElement representing a table of contents. # A table of contents type of structural element.
+                  "content": [ # The content of the table of contents.
+                    # Object with schema name: StructuralElement
+                  ],
+                  "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # The suggested insertion IDs. A TableOfContents may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion.
+                    "A String",
+                  ],
+                },
               },
-              "italic": True or False, # Whether or not the text is italicized.
-              "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
-                "bookmarkId": "A String", # The ID of a bookmark in this document.
-                "headingId": "A String", # The ID of a heading in this document.
-                "url": "A String", # An external URL.
-              },
-              "smallCaps": True or False, # Whether or not the text is in small capital letters.
-              "strikethrough": True or False, # Whether or not the text is struck through.
-              "underline": True or False, # Whether or not the text is underlined.
-              "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
-                "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
-                "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
-              },
-            },
+            ],
+            "footnoteId": "A String", # The ID of the footnote.
           },
-        ],
-      },
-      "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this list.
-        "A String",
-      ],
-      "suggestedInsertionId": "A String", # The suggested insertion ID. If empty, then this is not a suggested insertion.
-      "suggestedListPropertiesChanges": { # The suggested changes to the list properties, keyed by suggestion ID.
-        "a_key": { # A suggested change to ListProperties.
-          "listProperties": { # The properties of a list that describe the look and feel of bullets belonging to paragraphs associated with a list. # A ListProperties that only includes the changes made in this suggestion. This can be used along with the list_properties_suggestion_state to see which fields have changed and their new values.
-            "nestingLevels": [ # Describes the properties of the bullets at the associated level. A list has at most 9 levels of nesting with nesting level 0 corresponding to the top-most level and nesting level 8 corresponding to the most nested level. The nesting levels are returned in ascending order with the least nested returned first.
-              { # Contains properties describing the look and feel of a list bullet at a given level of nesting.
-                "bulletAlignment": "A String", # The alignment of the bullet within the space allotted for rendering the bullet.
-                "glyphFormat": "A String", # The format string used by bullets at this level of nesting. The glyph format contains one or more placeholders, and these placeholders are replaced with the appropriate values depending on the glyph_type or glyph_symbol. The placeholders follow the pattern `%[nesting_level]`. Furthermore, placeholders can have prefixes and suffixes. Thus, the glyph format follows the pattern `%[nesting_level]`. Note that the prefix and suffix are optional and can be arbitrary strings. For example, the glyph format `%0.` indicates that the rendered glyph will replace the placeholder with the corresponding glyph for nesting level 0 followed by a period as the suffix. So a list with a glyph type of UPPER_ALPHA and glyph format `%0.` at nesting level 0 will result in a list with rendered glyphs `A.` `B.` `C.` The glyph format can contain placeholders for the current nesting level as well as placeholders for parent nesting levels. For example, a list can have a glyph format of `%0.` at nesting level 0 and a glyph format of `%0.%1.` at nesting level 1. Assuming both nesting levels have DECIMAL glyph types, this would result in a list with rendered glyphs `1.` `2.` ` 2.1.` ` 2.2.` `3.` For nesting levels that are ordered, the string that replaces a placeholder in the glyph format for a particular paragraph depends on the paragraph's order within the list.
-                "glyphSymbol": "A String", # A custom glyph symbol used by bullets when paragraphs at this level of nesting are unordered. The glyph symbol replaces placeholders within the glyph_format. For example, if the glyph_symbol is the solid circle corresponding to Unicode U+25cf code point and the glyph_format is `%0`, the rendered glyph would be the solid circle.
-                "glyphType": "A String", # The type of glyph used by bullets when paragraphs at this level of nesting are ordered. The glyph type determines the type of glyph used to replace placeholders within the glyph_format when paragraphs at this level of nesting are ordered. For example, if the nesting level is 0, the glyph_format is `%0.` and the glyph type is DECIMAL, then the rendered glyph would replace the placeholder `%0` in the glyph format with a number corresponding to list item's order within the list.
-                "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of paragraphs at this level of nesting.
-                  "magnitude": 3.14, # The magnitude.
-                  "unit": "A String", # The units for magnitude.
-                },
-                "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for paragraphs at this level of nesting. Applied to the side that corresponds to the start of the text, based on the paragraph's content direction.
-                  "magnitude": 3.14, # The magnitude.
-                  "unit": "A String", # The units for magnitude.
-                },
-                "startNumber": 42, # The number of the first list item at this nesting level. A value of 0 is treated as a value of 1 for lettered lists and Roman numeral lists. For values of both 0 and 1, lettered and Roman numeral lists will begin at `a` and `i` respectively. This value is ignored for nesting levels with unordered glyphs.
-                "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of bullets at this level of nesting.
-                  "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
-                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
-                      "rgbColor": { # An RGB color. # The RGB color value.
-                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
-                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
-                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+        },
+        "headers": { # The headers in the document tab, keyed by header ID.
+          "a_key": { # A document header.
+            "content": [ # The contents of the header. The indexes for a header's content begin at zero.
+              { # A StructuralElement describes content that provides structure to the document.
+                "endIndex": 42, # The zero-based end index of this structural element, exclusive, in UTF-16 code units.
+                "paragraph": { # A StructuralElement representing a paragraph. A paragraph is a range of content that's terminated with a newline character. # A paragraph type of structural element.
+                  "bullet": { # Describes the bullet of a paragraph. # The bullet for this paragraph. If not present, the paragraph does not belong to a list.
+                    "listId": "A String", # The ID of the list this paragraph belongs to.
+                    "nestingLevel": 42, # The nesting level of this paragraph in the list.
+                    "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet.
+                      "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                      "bold": True or False, # Whether or not the text is rendered as bold.
+                      "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "italic": True or False, # Whether or not the text is italicized.
+                      "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                        "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                          "id": "A String", # The ID of a bookmark in this document.
+                          "tabId": "A String", # The ID of the tab containing this bookmark.
+                        },
+                        "bookmarkId": "A String", # The ID of a bookmark in this document.
+                        "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                          "id": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of the tab containing this heading.
+                        },
+                        "headingId": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of a tab in this document.
+                        "url": "A String", # An external URL.
+                      },
+                      "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                      "strikethrough": True or False, # Whether or not the text is struck through.
+                      "underline": True or False, # Whether or not the text is underlined.
+                      "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                        "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                        "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                      },
+                    },
+                  },
+                  "elements": [ # The content of the paragraph, broken down into its component parts.
+                    { # A ParagraphElement describes content within a Paragraph.
+                      "autoText": { # A ParagraphElement representing a spot in the text that's dynamically replaced with content that can change over time, like a page number. # An auto text paragraph element.
+                        "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                          "A String",
+                        ],
+                        "suggestedInsertionIds": [ # The suggested insertion IDs. An AutoText may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                          "A String",
+                        ],
+                        "suggestedTextStyleChanges": { # The suggested text style changes to this AutoText, keyed by suggestion ID.
+                          "a_key": { # A suggested change to a TextStyle.
+                            "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                              "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                              "bold": True or False, # Whether or not the text is rendered as bold.
+                              "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                              "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "italic": True or False, # Whether or not the text is italicized.
+                              "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                                "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a bookmark in this document.
+                                  "tabId": "A String", # The ID of the tab containing this bookmark.
+                                },
+                                "bookmarkId": "A String", # The ID of a bookmark in this document.
+                                "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a heading in this document.
+                                  "tabId": "A String", # The ID of the tab containing this heading.
+                                },
+                                "headingId": "A String", # The ID of a heading in this document.
+                                "tabId": "A String", # The ID of a tab in this document.
+                                "url": "A String", # An external URL.
+                              },
+                              "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                              "strikethrough": True or False, # Whether or not the text is struck through.
+                              "underline": True or False, # Whether or not the text is underlined.
+                              "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                                "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                                "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                              },
+                            },
+                            "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                              "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                              "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                              "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                              "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                              "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                              "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                              "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                              "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                              "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                              "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                              "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                            },
+                          },
+                        },
+                        "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this AutoText.
+                          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                          "bold": True or False, # Whether or not the text is rendered as bold.
+                          "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "italic": True or False, # Whether or not the text is italicized.
+                          "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                            "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a bookmark in this document.
+                              "tabId": "A String", # The ID of the tab containing this bookmark.
+                            },
+                            "bookmarkId": "A String", # The ID of a bookmark in this document.
+                            "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a heading in this document.
+                              "tabId": "A String", # The ID of the tab containing this heading.
+                            },
+                            "headingId": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of a tab in this document.
+                            "url": "A String", # An external URL.
+                          },
+                          "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                          "strikethrough": True or False, # Whether or not the text is struck through.
+                          "underline": True or False, # Whether or not the text is underlined.
+                          "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                            "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                            "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                          },
+                        },
+                        "type": "A String", # The type of this auto text.
+                      },
+                      "columnBreak": { # A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column. # A column break paragraph element.
+                        "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                          "A String",
+                        ],
+                        "suggestedInsertionIds": [ # The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                          "A String",
+                        ],
+                        "suggestedTextStyleChanges": { # The suggested text style changes to this ColumnBreak, keyed by suggestion ID.
+                          "a_key": { # A suggested change to a TextStyle.
+                            "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                              "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                              "bold": True or False, # Whether or not the text is rendered as bold.
+                              "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                              "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "italic": True or False, # Whether or not the text is italicized.
+                              "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                                "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a bookmark in this document.
+                                  "tabId": "A String", # The ID of the tab containing this bookmark.
+                                },
+                                "bookmarkId": "A String", # The ID of a bookmark in this document.
+                                "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a heading in this document.
+                                  "tabId": "A String", # The ID of the tab containing this heading.
+                                },
+                                "headingId": "A String", # The ID of a heading in this document.
+                                "tabId": "A String", # The ID of a tab in this document.
+                                "url": "A String", # An external URL.
+                              },
+                              "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                              "strikethrough": True or False, # Whether or not the text is struck through.
+                              "underline": True or False, # Whether or not the text is underlined.
+                              "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                                "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                                "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                              },
+                            },
+                            "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                              "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                              "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                              "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                              "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                              "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                              "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                              "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                              "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                              "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                              "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                              "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                            },
+                          },
+                        },
+                        "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it.
+                          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                          "bold": True or False, # Whether or not the text is rendered as bold.
+                          "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "italic": True or False, # Whether or not the text is italicized.
+                          "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                            "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a bookmark in this document.
+                              "tabId": "A String", # The ID of the tab containing this bookmark.
+                            },
+                            "bookmarkId": "A String", # The ID of a bookmark in this document.
+                            "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a heading in this document.
+                              "tabId": "A String", # The ID of the tab containing this heading.
+                            },
+                            "headingId": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of a tab in this document.
+                            "url": "A String", # An external URL.
+                          },
+                          "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                          "strikethrough": True or False, # Whether or not the text is struck through.
+                          "underline": True or False, # Whether or not the text is underlined.
+                          "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                            "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                            "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                          },
+                        },
+                      },
+                      "endIndex": 42, # The zero-base end index of this paragraph element, exclusive, in UTF-16 code units.
+                      "equation": { # A ParagraphElement representing an equation. # An equation paragraph element.
+                        "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                          "A String",
+                        ],
+                        "suggestedInsertionIds": [ # The suggested insertion IDs. An Equation may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                          "A String",
+                        ],
+                      },
+                      "footnoteReference": { # A ParagraphElement representing a footnote reference. A footnote reference is the inline content rendered with a number and is used to identify the footnote. # A footnote reference paragraph element.
+                        "footnoteId": "A String", # The ID of the footnote that contains the content of this footnote reference.
+                        "footnoteNumber": "A String", # The rendered number of this footnote.
+                        "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                          "A String",
+                        ],
+                        "suggestedInsertionIds": [ # The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                          "A String",
+                        ],
+                        "suggestedTextStyleChanges": { # The suggested text style changes to this FootnoteReference, keyed by suggestion ID.
+                          "a_key": { # A suggested change to a TextStyle.
+                            "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                              "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                              "bold": True or False, # Whether or not the text is rendered as bold.
+                              "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                              "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "italic": True or False, # Whether or not the text is italicized.
+                              "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                                "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a bookmark in this document.
+                                  "tabId": "A String", # The ID of the tab containing this bookmark.
+                                },
+                                "bookmarkId": "A String", # The ID of a bookmark in this document.
+                                "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a heading in this document.
+                                  "tabId": "A String", # The ID of the tab containing this heading.
+                                },
+                                "headingId": "A String", # The ID of a heading in this document.
+                                "tabId": "A String", # The ID of a tab in this document.
+                                "url": "A String", # An external URL.
+                              },
+                              "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                              "strikethrough": True or False, # Whether or not the text is struck through.
+                              "underline": True or False, # Whether or not the text is underlined.
+                              "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                                "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                                "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                              },
+                            },
+                            "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                              "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                              "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                              "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                              "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                              "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                              "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                              "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                              "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                              "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                              "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                              "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                            },
+                          },
+                        },
+                        "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this FootnoteReference.
+                          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                          "bold": True or False, # Whether or not the text is rendered as bold.
+                          "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "italic": True or False, # Whether or not the text is italicized.
+                          "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                            "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a bookmark in this document.
+                              "tabId": "A String", # The ID of the tab containing this bookmark.
+                            },
+                            "bookmarkId": "A String", # The ID of a bookmark in this document.
+                            "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a heading in this document.
+                              "tabId": "A String", # The ID of the tab containing this heading.
+                            },
+                            "headingId": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of a tab in this document.
+                            "url": "A String", # An external URL.
+                          },
+                          "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                          "strikethrough": True or False, # Whether or not the text is struck through.
+                          "underline": True or False, # Whether or not the text is underlined.
+                          "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                            "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                            "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                          },
+                        },
+                      },
+                      "horizontalRule": { # A ParagraphElement representing a horizontal line. # A horizontal rule paragraph element.
+                        "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                          "A String",
+                        ],
+                        "suggestedInsertionIds": [ # The suggested insertion IDs. A HorizontalRule may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion.
+                          "A String",
+                        ],
+                        "suggestedTextStyleChanges": { # The suggested text style changes to this HorizontalRule, keyed by suggestion ID.
+                          "a_key": { # A suggested change to a TextStyle.
+                            "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                              "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                              "bold": True or False, # Whether or not the text is rendered as bold.
+                              "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                              "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "italic": True or False, # Whether or not the text is italicized.
+                              "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                                "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a bookmark in this document.
+                                  "tabId": "A String", # The ID of the tab containing this bookmark.
+                                },
+                                "bookmarkId": "A String", # The ID of a bookmark in this document.
+                                "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a heading in this document.
+                                  "tabId": "A String", # The ID of the tab containing this heading.
+                                },
+                                "headingId": "A String", # The ID of a heading in this document.
+                                "tabId": "A String", # The ID of a tab in this document.
+                                "url": "A String", # An external URL.
+                              },
+                              "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                              "strikethrough": True or False, # Whether or not the text is struck through.
+                              "underline": True or False, # Whether or not the text is underlined.
+                              "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                                "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                                "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                              },
+                            },
+                            "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                              "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                              "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                              "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                              "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                              "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                              "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                              "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                              "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                              "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                              "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                              "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                            },
+                          },
+                        },
+                        "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this HorizontalRule. Similar to text content, like text runs and footnote references, the text style of a horizontal rule can affect content layout as well as the styling of text inserted next to it.
+                          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                          "bold": True or False, # Whether or not the text is rendered as bold.
+                          "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "italic": True or False, # Whether or not the text is italicized.
+                          "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                            "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a bookmark in this document.
+                              "tabId": "A String", # The ID of the tab containing this bookmark.
+                            },
+                            "bookmarkId": "A String", # The ID of a bookmark in this document.
+                            "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a heading in this document.
+                              "tabId": "A String", # The ID of the tab containing this heading.
+                            },
+                            "headingId": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of a tab in this document.
+                            "url": "A String", # An external URL.
+                          },
+                          "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                          "strikethrough": True or False, # Whether or not the text is struck through.
+                          "underline": True or False, # Whether or not the text is underlined.
+                          "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                            "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                            "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                          },
+                        },
+                      },
+                      "inlineObjectElement": { # A ParagraphElement that contains an InlineObject. # An inline object paragraph element.
+                        "inlineObjectId": "A String", # The ID of the InlineObject this element contains.
+                        "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                          "A String",
+                        ],
+                        "suggestedInsertionIds": [ # The suggested insertion IDs. An InlineObjectElement may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                          "A String",
+                        ],
+                        "suggestedTextStyleChanges": { # The suggested text style changes to this InlineObject, keyed by suggestion ID.
+                          "a_key": { # A suggested change to a TextStyle.
+                            "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                              "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                              "bold": True or False, # Whether or not the text is rendered as bold.
+                              "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                              "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "italic": True or False, # Whether or not the text is italicized.
+                              "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                                "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a bookmark in this document.
+                                  "tabId": "A String", # The ID of the tab containing this bookmark.
+                                },
+                                "bookmarkId": "A String", # The ID of a bookmark in this document.
+                                "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a heading in this document.
+                                  "tabId": "A String", # The ID of the tab containing this heading.
+                                },
+                                "headingId": "A String", # The ID of a heading in this document.
+                                "tabId": "A String", # The ID of a tab in this document.
+                                "url": "A String", # An external URL.
+                              },
+                              "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                              "strikethrough": True or False, # Whether or not the text is struck through.
+                              "underline": True or False, # Whether or not the text is underlined.
+                              "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                                "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                                "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                              },
+                            },
+                            "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                              "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                              "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                              "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                              "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                              "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                              "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                              "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                              "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                              "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                              "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                              "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                            },
+                          },
+                        },
+                        "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this InlineObjectElement. Similar to text content, like text runs and footnote references, the text style of an inline object element can affect content layout as well as the styling of text inserted next to it.
+                          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                          "bold": True or False, # Whether or not the text is rendered as bold.
+                          "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "italic": True or False, # Whether or not the text is italicized.
+                          "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                            "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a bookmark in this document.
+                              "tabId": "A String", # The ID of the tab containing this bookmark.
+                            },
+                            "bookmarkId": "A String", # The ID of a bookmark in this document.
+                            "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a heading in this document.
+                              "tabId": "A String", # The ID of the tab containing this heading.
+                            },
+                            "headingId": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of a tab in this document.
+                            "url": "A String", # An external URL.
+                          },
+                          "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                          "strikethrough": True or False, # Whether or not the text is struck through.
+                          "underline": True or False, # Whether or not the text is underlined.
+                          "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                            "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                            "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                          },
+                        },
+                      },
+                      "pageBreak": { # A ParagraphElement representing a page break. A page break makes the subsequent text start at the top of the next page. # A page break paragraph element.
+                        "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                          "A String",
+                        ],
+                        "suggestedInsertionIds": [ # The suggested insertion IDs. A PageBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                          "A String",
+                        ],
+                        "suggestedTextStyleChanges": { # The suggested text style changes to this PageBreak, keyed by suggestion ID.
+                          "a_key": { # A suggested change to a TextStyle.
+                            "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                              "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                              "bold": True or False, # Whether or not the text is rendered as bold.
+                              "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                              "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "italic": True or False, # Whether or not the text is italicized.
+                              "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                                "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a bookmark in this document.
+                                  "tabId": "A String", # The ID of the tab containing this bookmark.
+                                },
+                                "bookmarkId": "A String", # The ID of a bookmark in this document.
+                                "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a heading in this document.
+                                  "tabId": "A String", # The ID of the tab containing this heading.
+                                },
+                                "headingId": "A String", # The ID of a heading in this document.
+                                "tabId": "A String", # The ID of a tab in this document.
+                                "url": "A String", # An external URL.
+                              },
+                              "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                              "strikethrough": True or False, # Whether or not the text is struck through.
+                              "underline": True or False, # Whether or not the text is underlined.
+                              "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                                "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                                "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                              },
+                            },
+                            "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                              "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                              "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                              "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                              "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                              "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                              "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                              "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                              "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                              "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                              "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                              "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                            },
+                          },
+                        },
+                        "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this PageBreak. Similar to text content, like text runs and footnote references, the text style of a page break can affect content layout as well as the styling of text inserted next to it.
+                          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                          "bold": True or False, # Whether or not the text is rendered as bold.
+                          "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "italic": True or False, # Whether or not the text is italicized.
+                          "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                            "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a bookmark in this document.
+                              "tabId": "A String", # The ID of the tab containing this bookmark.
+                            },
+                            "bookmarkId": "A String", # The ID of a bookmark in this document.
+                            "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a heading in this document.
+                              "tabId": "A String", # The ID of the tab containing this heading.
+                            },
+                            "headingId": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of a tab in this document.
+                            "url": "A String", # An external URL.
+                          },
+                          "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                          "strikethrough": True or False, # Whether or not the text is struck through.
+                          "underline": True or False, # Whether or not the text is underlined.
+                          "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                            "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                            "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                          },
+                        },
+                      },
+                      "person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address.
+                        "personId": "A String", # Output only. The unique ID of this link.
+                        "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present.
+                          "email": "A String", # Output only. The email address linked to this Person. This field is always present.
+                          "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address.
+                        },
+                        "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion.
+                          "A String",
+                        ],
+                        "suggestedInsertionIds": [ # IDs for suggestions that insert this person link into the document. A Person might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion.
+                          "A String",
+                        ],
+                        "suggestedTextStyleChanges": { # The suggested text style changes to this Person, keyed by suggestion ID.
+                          "a_key": { # A suggested change to a TextStyle.
+                            "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                              "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                              "bold": True or False, # Whether or not the text is rendered as bold.
+                              "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                              "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "italic": True or False, # Whether or not the text is italicized.
+                              "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                                "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a bookmark in this document.
+                                  "tabId": "A String", # The ID of the tab containing this bookmark.
+                                },
+                                "bookmarkId": "A String", # The ID of a bookmark in this document.
+                                "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a heading in this document.
+                                  "tabId": "A String", # The ID of the tab containing this heading.
+                                },
+                                "headingId": "A String", # The ID of a heading in this document.
+                                "tabId": "A String", # The ID of a tab in this document.
+                                "url": "A String", # An external URL.
+                              },
+                              "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                              "strikethrough": True or False, # Whether or not the text is struck through.
+                              "underline": True or False, # Whether or not the text is underlined.
+                              "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                                "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                                "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                              },
+                            },
+                            "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                              "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                              "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                              "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                              "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                              "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                              "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                              "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                              "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                              "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                              "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                              "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                            },
+                          },
+                        },
+                        "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this Person.
+                          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                          "bold": True or False, # Whether or not the text is rendered as bold.
+                          "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "italic": True or False, # Whether or not the text is italicized.
+                          "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                            "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a bookmark in this document.
+                              "tabId": "A String", # The ID of the tab containing this bookmark.
+                            },
+                            "bookmarkId": "A String", # The ID of a bookmark in this document.
+                            "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a heading in this document.
+                              "tabId": "A String", # The ID of the tab containing this heading.
+                            },
+                            "headingId": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of a tab in this document.
+                            "url": "A String", # An external URL.
+                          },
+                          "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                          "strikethrough": True or False, # Whether or not the text is struck through.
+                          "underline": True or False, # Whether or not the text is underlined.
+                          "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                            "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                            "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                          },
+                        },
+                      },
+                      "richLink": { # A link to a Google resource (such as a file in Drive, a YouTube video, or a Calendar event). # A paragraph element that links to a Google resource (such as a file in Google Drive, a YouTube video, or a Calendar event.)
+                        "richLinkId": "A String", # Output only. The ID of this link.
+                        "richLinkProperties": { # Properties specific to a RichLink. # Output only. The properties of this RichLink. This field is always present.
+                          "mimeType": "A String", # Output only. The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the RichLink, if there's one (for example, when it's a file in Drive).
+                          "title": "A String", # Output only. The title of the RichLink as displayed in the link. This title matches the title of the linked resource at the time of the insertion or last update of the link. This field is always present.
+                          "uri": "A String", # Output only. The URI to the RichLink. This is always present.
+                        },
+                        "suggestedDeletionIds": [ # IDs for suggestions that remove this link from the document. A RichLink might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion.
+                          "A String",
+                        ],
+                        "suggestedInsertionIds": [ # IDs for suggestions that insert this link into the document. A RichLink might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion.
+                          "A String",
+                        ],
+                        "suggestedTextStyleChanges": { # The suggested text style changes to this RichLink, keyed by suggestion ID.
+                          "a_key": { # A suggested change to a TextStyle.
+                            "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                              "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                              "bold": True or False, # Whether or not the text is rendered as bold.
+                              "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                              "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "italic": True or False, # Whether or not the text is italicized.
+                              "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                                "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a bookmark in this document.
+                                  "tabId": "A String", # The ID of the tab containing this bookmark.
+                                },
+                                "bookmarkId": "A String", # The ID of a bookmark in this document.
+                                "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a heading in this document.
+                                  "tabId": "A String", # The ID of the tab containing this heading.
+                                },
+                                "headingId": "A String", # The ID of a heading in this document.
+                                "tabId": "A String", # The ID of a tab in this document.
+                                "url": "A String", # An external URL.
+                              },
+                              "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                              "strikethrough": True or False, # Whether or not the text is struck through.
+                              "underline": True or False, # Whether or not the text is underlined.
+                              "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                                "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                                "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                              },
+                            },
+                            "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                              "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                              "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                              "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                              "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                              "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                              "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                              "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                              "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                              "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                              "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                              "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                            },
+                          },
+                        },
+                        "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this RichLink.
+                          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                          "bold": True or False, # Whether or not the text is rendered as bold.
+                          "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "italic": True or False, # Whether or not the text is italicized.
+                          "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                            "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a bookmark in this document.
+                              "tabId": "A String", # The ID of the tab containing this bookmark.
+                            },
+                            "bookmarkId": "A String", # The ID of a bookmark in this document.
+                            "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a heading in this document.
+                              "tabId": "A String", # The ID of the tab containing this heading.
+                            },
+                            "headingId": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of a tab in this document.
+                            "url": "A String", # An external URL.
+                          },
+                          "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                          "strikethrough": True or False, # Whether or not the text is struck through.
+                          "underline": True or False, # Whether or not the text is underlined.
+                          "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                            "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                            "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                          },
+                        },
+                      },
+                      "startIndex": 42, # The zero-based start index of this paragraph element, in UTF-16 code units.
+                      "textRun": { # A ParagraphElement that represents a run of text that all has the same styling. # A text run paragraph element.
+                        "content": "A String", # The text of this run. Any non-text elements in the run are replaced with the Unicode character U+E907.
+                        "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                          "A String",
+                        ],
+                        "suggestedInsertionIds": [ # The suggested insertion IDs. A TextRun may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                          "A String",
+                        ],
+                        "suggestedTextStyleChanges": { # The suggested text style changes to this run, keyed by suggestion ID.
+                          "a_key": { # A suggested change to a TextStyle.
+                            "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                              "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                              "bold": True or False, # Whether or not the text is rendered as bold.
+                              "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                              "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "italic": True or False, # Whether or not the text is italicized.
+                              "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                                "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a bookmark in this document.
+                                  "tabId": "A String", # The ID of the tab containing this bookmark.
+                                },
+                                "bookmarkId": "A String", # The ID of a bookmark in this document.
+                                "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a heading in this document.
+                                  "tabId": "A String", # The ID of the tab containing this heading.
+                                },
+                                "headingId": "A String", # The ID of a heading in this document.
+                                "tabId": "A String", # The ID of a tab in this document.
+                                "url": "A String", # An external URL.
+                              },
+                              "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                              "strikethrough": True or False, # Whether or not the text is struck through.
+                              "underline": True or False, # Whether or not the text is underlined.
+                              "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                                "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                                "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                              },
+                            },
+                            "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                              "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                              "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                              "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                              "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                              "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                              "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                              "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                              "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                              "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                              "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                              "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                            },
+                          },
+                        },
+                        "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this run.
+                          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                          "bold": True or False, # Whether or not the text is rendered as bold.
+                          "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "italic": True or False, # Whether or not the text is italicized.
+                          "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                            "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a bookmark in this document.
+                              "tabId": "A String", # The ID of the tab containing this bookmark.
+                            },
+                            "bookmarkId": "A String", # The ID of a bookmark in this document.
+                            "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a heading in this document.
+                              "tabId": "A String", # The ID of the tab containing this heading.
+                            },
+                            "headingId": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of a tab in this document.
+                            "url": "A String", # An external URL.
+                          },
+                          "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                          "strikethrough": True or False, # Whether or not the text is struck through.
+                          "underline": True or False, # Whether or not the text is underlined.
+                          "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                            "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                            "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                          },
+                        },
+                      },
+                    },
+                  ],
+                  "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The style of this paragraph.
+                    "alignment": "A String", # The text alignment for this paragraph.
+                    "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent.
+                    "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                      "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "dashStyle": "A String", # The dash style of the border.
+                      "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
                       },
                     },
+                    "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                      "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "dashStyle": "A String", # The dash style of the border.
+                      "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                    },
+                    "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                      "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "dashStyle": "A String", # The dash style of the border.
+                      "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                    },
+                    "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                      "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "dashStyle": "A String", # The dash style of the border.
+                      "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                    },
+                    "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                      "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "dashStyle": "A String", # The dash style of the border.
+                      "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                    },
+                    "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited.
+                    "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only.
+                    "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent.
+                    "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent.
+                    "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent.
+                    "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated.
+                    "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error.
+                    "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent.
+                      "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                    },
+                    "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "spacingMode": "A String", # The spacing mode for the paragraph.
+                    "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only.
+                      { # A tab stop within a paragraph.
+                        "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START.
+                        "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                      },
+                    ],
                   },
-                  "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
-                  "bold": True or False, # Whether or not the text is rendered as bold.
-                  "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
-                    "magnitude": 3.14, # The magnitude.
-                    "unit": "A String", # The units for magnitude.
-                  },
-                  "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
-                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
-                      "rgbColor": { # An RGB color. # The RGB color value.
-                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
-                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
-                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                  "positionedObjectIds": [ # The IDs of the positioned objects tethered to this paragraph.
+                    "A String",
+                  ],
+                  "suggestedBulletChanges": { # The suggested changes to this paragraph's bullet.
+                    "a_key": { # A suggested change to a Bullet.
+                      "bullet": { # Describes the bullet of a paragraph. # A Bullet that only includes the changes made in this suggestion. This can be used along with the bullet_suggestion_state to see which fields have changed and their new values.
+                        "listId": "A String", # The ID of the list this paragraph belongs to.
+                        "nestingLevel": 42, # The nesting level of this paragraph in the list.
+                        "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet.
+                          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                          "bold": True or False, # Whether or not the text is rendered as bold.
+                          "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "italic": True or False, # Whether or not the text is italicized.
+                          "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                            "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a bookmark in this document.
+                              "tabId": "A String", # The ID of the tab containing this bookmark.
+                            },
+                            "bookmarkId": "A String", # The ID of a bookmark in this document.
+                            "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a heading in this document.
+                              "tabId": "A String", # The ID of the tab containing this heading.
+                            },
+                            "headingId": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of a tab in this document.
+                            "url": "A String", # An external URL.
+                          },
+                          "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                          "strikethrough": True or False, # Whether or not the text is struck through.
+                          "underline": True or False, # Whether or not the text is underlined.
+                          "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                            "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                            "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                          },
+                        },
+                      },
+                      "bulletSuggestionState": { # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion.
+                        "listIdSuggested": True or False, # Indicates if there was a suggested change to the list_id.
+                        "nestingLevelSuggested": True or False, # Indicates if there was a suggested change to the nesting_level.
+                        "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion.
+                          "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                          "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                          "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                          "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                          "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                          "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                          "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                          "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                          "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                          "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                          "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                        },
+                      },
+                    },
+                  },
+                  "suggestedParagraphStyleChanges": { # The suggested paragraph style changes to this paragraph, keyed by suggestion ID.
+                    "a_key": { # A suggested change to a ParagraphStyle.
+                      "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A ParagraphStyle that only includes the changes made in this suggestion. This can be used along with the paragraph_style_suggestion_state to see which fields have changed and their new values.
+                        "alignment": "A String", # The text alignment for this paragraph.
+                        "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent.
+                        "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                          "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "dashStyle": "A String", # The dash style of the border.
+                          "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                        },
+                        "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                          "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "dashStyle": "A String", # The dash style of the border.
+                          "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                        },
+                        "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                          "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "dashStyle": "A String", # The dash style of the border.
+                          "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                        },
+                        "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                          "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "dashStyle": "A String", # The dash style of the border.
+                          "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                        },
+                        "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                          "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "dashStyle": "A String", # The dash style of the border.
+                          "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                        },
+                        "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited.
+                        "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only.
+                        "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent.
+                        "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent.
+                        "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent.
+                        "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated.
+                        "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error.
+                        "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent.
+                          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                        },
+                        "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "spacingMode": "A String", # The spacing mode for the paragraph.
+                        "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only.
+                          { # A tab stop within a paragraph.
+                            "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START.
+                            "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                          },
+                        ],
+                      },
+                      "paragraphStyleSuggestionState": { # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion.
+                        "alignmentSuggested": True or False, # Indicates if there was a suggested change to alignment.
+                        "avoidWidowAndOrphanSuggested": True or False, # Indicates if there was a suggested change to avoid_widow_and_orphan.
+                        "borderBetweenSuggested": True or False, # Indicates if there was a suggested change to border_between.
+                        "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom.
+                        "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left.
+                        "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right.
+                        "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top.
+                        "directionSuggested": True or False, # Indicates if there was a suggested change to direction.
+                        "headingIdSuggested": True or False, # Indicates if there was a suggested change to heading_id.
+                        "indentEndSuggested": True or False, # Indicates if there was a suggested change to indent_end.
+                        "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line.
+                        "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start.
+                        "keepLinesTogetherSuggested": True or False, # Indicates if there was a suggested change to keep_lines_together.
+                        "keepWithNextSuggested": True or False, # Indicates if there was a suggested change to keep_with_next.
+                        "lineSpacingSuggested": True or False, # Indicates if there was a suggested change to line_spacing.
+                        "namedStyleTypeSuggested": True or False, # Indicates if there was a suggested change to named_style_type.
+                        "pageBreakBeforeSuggested": True or False, # Indicates if there was a suggested change to page_break_before.
+                        "shadingSuggestionState": { # A mask that indicates which of the fields on the base Shading have been changed in this suggested change. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in shading have been changed in this suggestion.
+                          "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to the Shading.
+                        },
+                        "spaceAboveSuggested": True or False, # Indicates if there was a suggested change to space_above.
+                        "spaceBelowSuggested": True or False, # Indicates if there was a suggested change to space_below.
+                        "spacingModeSuggested": True or False, # Indicates if there was a suggested change to spacing_mode.
+                      },
+                    },
+                  },
+                  "suggestedPositionedObjectIds": { # The IDs of the positioned objects suggested to be attached to this paragraph, keyed by suggestion ID.
+                    "a_key": { # A collection of object IDs.
+                      "objectIds": [ # The object IDs.
+                        "A String",
+                      ],
+                    },
+                  },
+                },
+                "sectionBreak": { # A StructuralElement representing a section break. A section is a range of content that has the same SectionStyle. A section break represents the start of a new section, and the section style applies to the section after the section break. The document body always begins with a section break. # A section break type of structural element.
+                  "sectionStyle": { # The styling that applies to a section. # The style of the section after this section break.
+                    "columnProperties": [ # The section's columns properties. If empty, the section contains one column with the default properties in the Docs editor. A section can be updated to have no more than 3 columns. When updating this property, setting a concrete value is required. Unsetting this property will result in a 400 bad request error.
+                      { # Properties that apply to a section's column.
+                        "paddingEnd": { # A magnitude in a single direction in the specified units. # The padding at the end of the column.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "width": { # A magnitude in a single direction in the specified units. # Output only. The width of the column.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
                       },
+                    ],
+                    "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                    "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                    "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only.
+                    "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only.
+                    "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only.
+                    "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only.
+                    "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only.
+                    "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only.
+                    "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                    "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
                     },
+                    "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                    "sectionType": "A String", # Output only. The type of section.
+                    "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
                   },
-                  "italic": True or False, # Whether or not the text is italicized.
-                  "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
-                    "bookmarkId": "A String", # The ID of a bookmark in this document.
-                    "headingId": "A String", # The ID of a heading in this document.
-                    "url": "A String", # An external URL.
-                  },
-                  "smallCaps": True or False, # Whether or not the text is in small capital letters.
-                  "strikethrough": True or False, # Whether or not the text is struck through.
-                  "underline": True or False, # Whether or not the text is underlined.
-                  "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
-                    "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
-                    "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
-                  },
-                },
-              },
-            ],
-          },
-          "listPropertiesSuggestionState": { # A mask that indicates which of the fields on the base ListProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base ListProperties have been changed in this suggestion.
-            "nestingLevelsSuggestionStates": [ # A mask that indicates which of the fields on the corresponding NestingLevel in nesting_levels have been changed in this suggestion. The nesting level suggestion states are returned in ascending order of the nesting level with the least nested returned first.
-              { # A mask that indicates which of the fields on the base NestingLevel have been changed in this suggestion. For any field set to true, there's a new suggested value.
-                "bulletAlignmentSuggested": True or False, # Indicates if there was a suggested change to bullet_alignment.
-                "glyphFormatSuggested": True or False, # Indicates if there was a suggested change to glyph_format.
-                "glyphSymbolSuggested": True or False, # Indicates if there was a suggested change to glyph_symbol.
-                "glyphTypeSuggested": True or False, # Indicates if there was a suggested change to glyph_type.
-                "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line.
-                "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start.
-                "startNumberSuggested": True or False, # Indicates if there was a suggested change to start_number.
-                "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion.
-                  "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
-                  "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
-                  "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
-                  "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
-                  "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
-                  "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
-                  "linkSuggested": True or False, # Indicates if there was a suggested change to link.
-                  "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
-                  "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
-                  "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
-                  "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
-                },
-              },
-            ],
-          },
-        },
-      },
-    },
-  },
-  "namedRanges": { # Output only. The named ranges in the document, keyed by name.
-    "a_key": { # A collection of all the NamedRanges in the document that share a given name.
-      "name": "A String", # The name that all the named ranges share.
-      "namedRanges": [ # The NamedRanges that share the same name.
-        { # A collection of Ranges with the same named range ID. Named ranges allow developers to associate parts of a document with an arbitrary user-defined label so their contents can be programmatically read or edited later. A document can contain multiple named ranges with the same name, but every named range has a unique ID. A named range is created with a single Range, and content inserted inside a named range generally expands that range. However, certain document changes can cause the range to be split into multiple ranges. Named ranges are not private. All applications and collaborators that have access to the document can see its named ranges.
-          "name": "A String", # The name of the named range.
-          "namedRangeId": "A String", # The ID of the named range.
-          "ranges": [ # The ranges that belong to this named range.
-            { # Specifies a contiguous range of text.
-              "endIndex": 42, # The zero-based end index of this range, exclusive, in UTF-16 code units. In all current uses, an end index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges.
-              "segmentId": "A String", # The ID of the header, footer, or footnote that this range is contained in. An empty segment ID signifies the document's body.
-              "startIndex": 42, # The zero-based start index of this range, in UTF-16 code units. In all current uses, a start index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges.
-            },
-          ],
-        },
-      ],
-    },
-  },
-  "namedStyles": { # The named styles. Paragraphs in the document can inherit their TextStyle and ParagraphStyle from these named styles. # Output only. The named styles of the document.
-    "styles": [ # The named styles. There's an entry for each of the possible named style types.
-      { # A named style. Paragraphs in the document can inherit their TextStyle and ParagraphStyle from this named style when they have the same named style type.
-        "namedStyleType": "A String", # The type of this named style.
-        "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph style of this named style.
-          "alignment": "A String", # The text alignment for this paragraph.
-          "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent.
-          "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
-            "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
-              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
-                "rgbColor": { # An RGB color. # The RGB color value.
-                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
-                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
-                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
-                },
-              },
-            },
-            "dashStyle": "A String", # The dash style of the border.
-            "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
-              "magnitude": 3.14, # The magnitude.
-              "unit": "A String", # The units for magnitude.
-            },
-            "width": { # A magnitude in a single direction in the specified units. # The width of the border.
-              "magnitude": 3.14, # The magnitude.
-              "unit": "A String", # The units for magnitude.
-            },
-          },
-          "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
-            "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
-              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
-                "rgbColor": { # An RGB color. # The RGB color value.
-                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
-                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
-                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
-                },
-              },
-            },
-            "dashStyle": "A String", # The dash style of the border.
-            "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
-              "magnitude": 3.14, # The magnitude.
-              "unit": "A String", # The units for magnitude.
-            },
-            "width": { # A magnitude in a single direction in the specified units. # The width of the border.
-              "magnitude": 3.14, # The magnitude.
-              "unit": "A String", # The units for magnitude.
-            },
-          },
-          "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
-            "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
-              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
-                "rgbColor": { # An RGB color. # The RGB color value.
-                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
-                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
-                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
-                },
-              },
-            },
-            "dashStyle": "A String", # The dash style of the border.
-            "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
-              "magnitude": 3.14, # The magnitude.
-              "unit": "A String", # The units for magnitude.
-            },
-            "width": { # A magnitude in a single direction in the specified units. # The width of the border.
-              "magnitude": 3.14, # The magnitude.
-              "unit": "A String", # The units for magnitude.
-            },
-          },
-          "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
-            "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
-              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
-                "rgbColor": { # An RGB color. # The RGB color value.
-                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
-                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
-                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                  "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # The suggested insertion IDs. A SectionBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                    "A String",
+                  ],
                 },
-              },
-            },
-            "dashStyle": "A String", # The dash style of the border.
-            "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
-              "magnitude": 3.14, # The magnitude.
-              "unit": "A String", # The units for magnitude.
-            },
-            "width": { # A magnitude in a single direction in the specified units. # The width of the border.
-              "magnitude": 3.14, # The magnitude.
-              "unit": "A String", # The units for magnitude.
-            },
-          },
-          "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
-            "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
-              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
-                "rgbColor": { # An RGB color. # The RGB color value.
-                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
-                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
-                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                "startIndex": 42, # The zero-based start index of this structural element, in UTF-16 code units.
+                "table": { # A StructuralElement representing a table. # A table type of structural element.
+                  "columns": 42, # Number of columns in the table. It's possible for a table to be non-rectangular, so some rows may have a different number of cells.
+                  "rows": 42, # Number of rows in the table.
+                  "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # The suggested insertion IDs. A Table may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                    "A String",
+                  ],
+                  "tableRows": [ # The contents and style of each row.
+                    { # The contents and style of a row in a Table.
+                      "endIndex": 42, # The zero-based end index of this row, exclusive, in UTF-16 code units.
+                      "startIndex": 42, # The zero-based start index of this row, in UTF-16 code units.
+                      "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                        "A String",
+                      ],
+                      "suggestedInsertionIds": [ # The suggested insertion IDs. A TableRow may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                        "A String",
+                      ],
+                      "suggestedTableRowStyleChanges": { # The suggested style changes to this row, keyed by suggestion ID.
+                        "a_key": { # A suggested change to a TableRowStyle.
+                          "tableRowStyle": { # Styles that apply to a table row. # A TableRowStyle that only includes the changes made in this suggestion. This can be used along with the table_row_style_suggestion_state to see which fields have changed and their new values.
+                            "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                            "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries.
+                            "tableHeader": True or False, # Whether the row is a table header.
+                          },
+                          "tableRowStyleSuggestionState": { # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion.
+                            "minRowHeightSuggested": True or False, # Indicates if there was a suggested change to min_row_height.
+                          },
+                        },
+                      },
+                      "tableCells": [ # The contents and style of each cell in this row. It's possible for a table to be non-rectangular, so some rows may have a different number of cells than other rows in the same table.
+                        { # The contents and style of a cell in a Table.
+                          "content": [ # The content of the cell.
+                            # Object with schema name: StructuralElement
+                          ],
+                          "endIndex": 42, # The zero-based end index of this cell, exclusive, in UTF-16 code units.
+                          "startIndex": 42, # The zero-based start index of this cell, in UTF-16 code units.
+                          "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                            "A String",
+                          ],
+                          "suggestedInsertionIds": [ # The suggested insertion IDs. A TableCell may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                            "A String",
+                          ],
+                          "suggestedTableCellStyleChanges": { # The suggested changes to the table cell style, keyed by suggestion ID.
+                            "a_key": { # A suggested change to a TableCellStyle.
+                              "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # A TableCellStyle that only includes the changes made in this suggestion. This can be used along with the table_cell_style_suggestion_state to see which fields have changed and their new values.
+                                "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell.
+                                  "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                    "rgbColor": { # An RGB color. # The RGB color value.
+                                      "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                      "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                      "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                    },
+                                  },
+                                },
+                                "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell.
+                                  "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                      "rgbColor": { # An RGB color. # The RGB color value.
+                                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                      },
+                                    },
+                                  },
+                                  "dashStyle": "A String", # The dash style of the border.
+                                  "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                                    "magnitude": 3.14, # The magnitude.
+                                    "unit": "A String", # The units for magnitude.
+                                  },
+                                },
+                                "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell.
+                                  "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                      "rgbColor": { # An RGB color. # The RGB color value.
+                                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                      },
+                                    },
+                                  },
+                                  "dashStyle": "A String", # The dash style of the border.
+                                  "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                                    "magnitude": 3.14, # The magnitude.
+                                    "unit": "A String", # The units for magnitude.
+                                  },
+                                },
+                                "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell.
+                                  "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                      "rgbColor": { # An RGB color. # The RGB color value.
+                                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                      },
+                                    },
+                                  },
+                                  "dashStyle": "A String", # The dash style of the border.
+                                  "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                                    "magnitude": 3.14, # The magnitude.
+                                    "unit": "A String", # The units for magnitude.
+                                  },
+                                },
+                                "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell.
+                                  "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                      "rgbColor": { # An RGB color. # The RGB color value.
+                                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                      },
+                                    },
+                                  },
+                                  "dashStyle": "A String", # The dash style of the border.
+                                  "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                                    "magnitude": 3.14, # The magnitude.
+                                    "unit": "A String", # The units for magnitude.
+                                  },
+                                },
+                                "columnSpan": 42, # The column span of the cell. This property is read-only.
+                                "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor.
+                                "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell.
+                                  "magnitude": 3.14, # The magnitude.
+                                  "unit": "A String", # The units for magnitude.
+                                },
+                                "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell.
+                                  "magnitude": 3.14, # The magnitude.
+                                  "unit": "A String", # The units for magnitude.
+                                },
+                                "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell.
+                                  "magnitude": 3.14, # The magnitude.
+                                  "unit": "A String", # The units for magnitude.
+                                },
+                                "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell.
+                                  "magnitude": 3.14, # The magnitude.
+                                  "unit": "A String", # The units for magnitude.
+                                },
+                                "rowSpan": 42, # The row span of the cell. This property is read-only.
+                              },
+                              "tableCellStyleSuggestionState": { # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion.
+                                "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                                "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom.
+                                "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left.
+                                "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right.
+                                "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top.
+                                "columnSpanSuggested": True or False, # Indicates if there was a suggested change to column_span.
+                                "contentAlignmentSuggested": True or False, # Indicates if there was a suggested change to content_alignment.
+                                "paddingBottomSuggested": True or False, # Indicates if there was a suggested change to padding_bottom.
+                                "paddingLeftSuggested": True or False, # Indicates if there was a suggested change to padding_left.
+                                "paddingRightSuggested": True or False, # Indicates if there was a suggested change to padding_right.
+                                "paddingTopSuggested": True or False, # Indicates if there was a suggested change to padding_top.
+                                "rowSpanSuggested": True or False, # Indicates if there was a suggested change to row_span.
+                              },
+                            },
+                          },
+                          "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # The style of the cell.
+                            "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell.
+                              "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "dashStyle": "A String", # The dash style of the border.
+                              "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                            },
+                            "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell.
+                              "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "dashStyle": "A String", # The dash style of the border.
+                              "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                            },
+                            "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell.
+                              "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "dashStyle": "A String", # The dash style of the border.
+                              "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                            },
+                            "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell.
+                              "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "dashStyle": "A String", # The dash style of the border.
+                              "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                            },
+                            "columnSpan": 42, # The column span of the cell. This property is read-only.
+                            "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor.
+                            "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                            "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                            "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                            "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                            "rowSpan": 42, # The row span of the cell. This property is read-only.
+                          },
+                        },
+                      ],
+                      "tableRowStyle": { # Styles that apply to a table row. # The style of the table row.
+                        "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries.
+                        "tableHeader": True or False, # Whether the row is a table header.
+                      },
+                    },
+                  ],
+                  "tableStyle": { # Styles that apply to a table. # The style of the table.
+                    "tableColumnProperties": [ # The properties of each column. Note that in Docs, tables contain rows and rows contain cells, similar to HTML. So the properties for a row can be found on the row's table_row_style.
+                      { # The properties of a column in a table.
+                        "width": { # A magnitude in a single direction in the specified units. # The width of the column. Set when the column's `width_type` is FIXED_WIDTH.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "widthType": "A String", # The width type of the column.
+                      },
+                    ],
+                  },
                 },
-              },
-            },
-            "dashStyle": "A String", # The dash style of the border.
-            "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
-              "magnitude": 3.14, # The magnitude.
-              "unit": "A String", # The units for magnitude.
-            },
-            "width": { # A magnitude in a single direction in the specified units. # The width of the border.
-              "magnitude": 3.14, # The magnitude.
-              "unit": "A String", # The units for magnitude.
-            },
-          },
-          "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited.
-          "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only.
-          "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
-            "magnitude": 3.14, # The magnitude.
-            "unit": "A String", # The units for magnitude.
-          },
-          "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent.
-            "magnitude": 3.14, # The magnitude.
-            "unit": "A String", # The units for magnitude.
-          },
-          "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
-            "magnitude": 3.14, # The magnitude.
-            "unit": "A String", # The units for magnitude.
-          },
-          "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent.
-          "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent.
-          "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent.
-          "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated.
-          "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error.
-          "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent.
-            "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading.
-              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
-                "rgbColor": { # An RGB color. # The RGB color value.
-                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
-                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
-                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                "tableOfContents": { # A StructuralElement representing a table of contents. # A table of contents type of structural element.
+                  "content": [ # The content of the table of contents.
+                    # Object with schema name: StructuralElement
+                  ],
+                  "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # The suggested insertion IDs. A TableOfContents may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion.
+                    "A String",
+                  ],
                 },
               },
-            },
-          },
-          "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent.
-            "magnitude": 3.14, # The magnitude.
-            "unit": "A String", # The units for magnitude.
-          },
-          "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent.
-            "magnitude": 3.14, # The magnitude.
-            "unit": "A String", # The units for magnitude.
+            ],
+            "headerId": "A String", # The ID of the header.
           },
-          "spacingMode": "A String", # The spacing mode for the paragraph.
-          "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only.
-            { # A tab stop within a paragraph.
-              "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START.
-              "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin.
-                "magnitude": 3.14, # The magnitude.
-                "unit": "A String", # The units for magnitude.
-              },
-            },
-          ],
         },
-        "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this named style.
-          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
-            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
-              "rgbColor": { # An RGB color. # The RGB color value.
-                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
-                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
-                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
-              },
-            },
-          },
-          "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
-          "bold": True or False, # Whether or not the text is rendered as bold.
-          "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
-            "magnitude": 3.14, # The magnitude.
-            "unit": "A String", # The units for magnitude.
-          },
-          "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
-            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
-              "rgbColor": { # An RGB color. # The RGB color value.
-                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
-                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
-                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+        "inlineObjects": { # The inline objects in the document tab, keyed by object ID.
+          "a_key": { # An object that appears inline with text. An InlineObject contains an EmbeddedObject such as an image.
+            "inlineObjectProperties": { # Properties of an InlineObject. # The properties of this inline object.
+              "embeddedObject": { # An embedded object in the document. # The embedded object of this inline object.
+                "description": "A String", # The description of the embedded object. The `title` and `description` are both combined to display alt text.
+                "embeddedDrawingProperties": { # The properties of an embedded drawing and used to differentiate the object type. An embedded drawing is one that's created and edited within a document. Note that extensive details are not supported. # The properties of an embedded drawing.
+                },
+                "embeddedObjectBorder": { # A border around an EmbeddedObject. # The border of the embedded object.
+                  "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                      "rgbColor": { # An RGB color. # The RGB color value.
+                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                      },
+                    },
+                  },
+                  "dashStyle": "A String", # The dash style of the border.
+                  "propertyState": "A String", # The property state of the border property.
+                  "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                },
+                "imageProperties": { # The properties of an image. # The properties of an image.
+                  "angle": 3.14, # The clockwise rotation angle of the image, in radians.
+                  "brightness": 3.14, # The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect.
+                  "contentUri": "A String", # A URI to the image with a default lifetime of 30 minutes. This URI is tagged with the account of the requester. Anyone with the URI effectively accesses the image as the original requester. Access to the image may be lost if the document's sharing settings change.
+                  "contrast": 3.14, # The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect.
+                  "cropProperties": { # The crop properties of an image. The crop rectangle is represented using fractional offsets from the original content's 4 edges. - If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the image's original bounding rectangle. - If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the image's original bounding rectangle. - If all offsets and rotation angle are 0, the image is not cropped. # The crop properties of the image.
+                    "angle": 3.14, # The clockwise rotation angle of the crop rectangle around its center, in radians. Rotation is applied after the offsets.
+                    "offsetBottom": 3.14, # The offset specifies how far inwards the bottom edge of the crop rectangle is from the bottom edge of the original content as a fraction of the original content's height.
+                    "offsetLeft": 3.14, # The offset specifies how far inwards the left edge of the crop rectangle is from the left edge of the original content as a fraction of the original content's width.
+                    "offsetRight": 3.14, # The offset specifies how far inwards the right edge of the crop rectangle is from the right edge of the original content as a fraction of the original content's width.
+                    "offsetTop": 3.14, # The offset specifies how far inwards the top edge of the crop rectangle is from the top edge of the original content as a fraction of the original content's height.
+                  },
+                  "sourceUri": "A String", # The source URI is the URI used to insert the image. The source URI can be empty.
+                  "transparency": 3.14, # The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means transparent.
+                },
+                "linkedContentReference": { # A reference to the external linked source content. # A reference to the external linked source content. For example, it contains a reference to the source Google Sheets chart when the embedded object is a linked chart. If unset, then the embedded object is not linked.
+                  "sheetsChartReference": { # A reference to a linked chart embedded from Google Sheets. # A reference to the linked chart.
+                    "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that's embedded.
+                    "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart.
+                  },
+                },
+                "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom margin of the embedded object.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "marginLeft": { # A magnitude in a single direction in the specified units. # The left margin of the embedded object.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "marginRight": { # A magnitude in a single direction in the specified units. # The right margin of the embedded object.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "marginTop": { # A magnitude in a single direction in the specified units. # The top margin of the embedded object.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "size": { # A width and height. # The visible size of the image after cropping.
+                  "height": { # A magnitude in a single direction in the specified units. # The height of the object.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "width": { # A magnitude in a single direction in the specified units. # The width of the object.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                },
+                "title": "A String", # The title of the embedded object. The `title` and `description` are both combined to display alt text.
               },
             },
-          },
-          "italic": True or False, # Whether or not the text is italicized.
-          "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
-            "bookmarkId": "A String", # The ID of a bookmark in this document.
-            "headingId": "A String", # The ID of a heading in this document.
-            "url": "A String", # An external URL.
-          },
-          "smallCaps": True or False, # Whether or not the text is in small capital letters.
-          "strikethrough": True or False, # Whether or not the text is struck through.
-          "underline": True or False, # Whether or not the text is underlined.
-          "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
-            "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
-            "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
-          },
-        },
-      },
-    ],
-  },
-  "positionedObjects": { # Output only. The positioned objects in the document, keyed by object ID.
-    "a_key": { # An object that's tethered to a Paragraph and positioned relative to the beginning of the paragraph. A PositionedObject contains an EmbeddedObject such as an image.
-      "objectId": "A String", # The ID of this positioned object.
-      "positionedObjectProperties": { # Properties of a PositionedObject. # The properties of this positioned object.
-        "embeddedObject": { # An embedded object in the document. # The embedded object of this positioned object.
-          "description": "A String", # The description of the embedded object. The `title` and `description` are both combined to display alt text.
-          "embeddedDrawingProperties": { # The properties of an embedded drawing and used to differentiate the object type. An embedded drawing is one that's created and edited within a document. Note that extensive details are not supported. # The properties of an embedded drawing.
-          },
-          "embeddedObjectBorder": { # A border around an EmbeddedObject. # The border of the embedded object.
-            "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
-              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
-                "rgbColor": { # An RGB color. # The RGB color value.
-                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
-                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
-                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+            "objectId": "A String", # The ID of this inline object. Can be used to update an object’s properties.
+            "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+              "A String",
+            ],
+            "suggestedInlineObjectPropertiesChanges": { # The suggested changes to the inline object properties, keyed by suggestion ID.
+              "a_key": { # A suggested change to InlineObjectProperties.
+                "inlineObjectProperties": { # Properties of an InlineObject. # An InlineObjectProperties that only includes the changes made in this suggestion. This can be used along with the inline_object_properties_suggestion_state to see which fields have changed and their new values.
+                  "embeddedObject": { # An embedded object in the document. # The embedded object of this inline object.
+                    "description": "A String", # The description of the embedded object. The `title` and `description` are both combined to display alt text.
+                    "embeddedDrawingProperties": { # The properties of an embedded drawing and used to differentiate the object type. An embedded drawing is one that's created and edited within a document. Note that extensive details are not supported. # The properties of an embedded drawing.
+                    },
+                    "embeddedObjectBorder": { # A border around an EmbeddedObject. # The border of the embedded object.
+                      "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "dashStyle": "A String", # The dash style of the border.
+                      "propertyState": "A String", # The property state of the border property.
+                      "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                    },
+                    "imageProperties": { # The properties of an image. # The properties of an image.
+                      "angle": 3.14, # The clockwise rotation angle of the image, in radians.
+                      "brightness": 3.14, # The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect.
+                      "contentUri": "A String", # A URI to the image with a default lifetime of 30 minutes. This URI is tagged with the account of the requester. Anyone with the URI effectively accesses the image as the original requester. Access to the image may be lost if the document's sharing settings change.
+                      "contrast": 3.14, # The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect.
+                      "cropProperties": { # The crop properties of an image. The crop rectangle is represented using fractional offsets from the original content's 4 edges. - If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the image's original bounding rectangle. - If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the image's original bounding rectangle. - If all offsets and rotation angle are 0, the image is not cropped. # The crop properties of the image.
+                        "angle": 3.14, # The clockwise rotation angle of the crop rectangle around its center, in radians. Rotation is applied after the offsets.
+                        "offsetBottom": 3.14, # The offset specifies how far inwards the bottom edge of the crop rectangle is from the bottom edge of the original content as a fraction of the original content's height.
+                        "offsetLeft": 3.14, # The offset specifies how far inwards the left edge of the crop rectangle is from the left edge of the original content as a fraction of the original content's width.
+                        "offsetRight": 3.14, # The offset specifies how far inwards the right edge of the crop rectangle is from the right edge of the original content as a fraction of the original content's width.
+                        "offsetTop": 3.14, # The offset specifies how far inwards the top edge of the crop rectangle is from the top edge of the original content as a fraction of the original content's height.
+                      },
+                      "sourceUri": "A String", # The source URI is the URI used to insert the image. The source URI can be empty.
+                      "transparency": 3.14, # The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means transparent.
+                    },
+                    "linkedContentReference": { # A reference to the external linked source content. # A reference to the external linked source content. For example, it contains a reference to the source Google Sheets chart when the embedded object is a linked chart. If unset, then the embedded object is not linked.
+                      "sheetsChartReference": { # A reference to a linked chart embedded from Google Sheets. # A reference to the linked chart.
+                        "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that's embedded.
+                        "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart.
+                      },
+                    },
+                    "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom margin of the embedded object.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "marginLeft": { # A magnitude in a single direction in the specified units. # The left margin of the embedded object.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "marginRight": { # A magnitude in a single direction in the specified units. # The right margin of the embedded object.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "marginTop": { # A magnitude in a single direction in the specified units. # The top margin of the embedded object.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "size": { # A width and height. # The visible size of the image after cropping.
+                      "height": { # A magnitude in a single direction in the specified units. # The height of the object.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "width": { # A magnitude in a single direction in the specified units. # The width of the object.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                    },
+                    "title": "A String", # The title of the embedded object. The `title` and `description` are both combined to display alt text.
+                  },
+                },
+                "inlineObjectPropertiesSuggestionState": { # A mask that indicates which of the fields on the base InlineObjectProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base InlineObjectProperties have been changed in this suggestion.
+                  "embeddedObjectSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedObject have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_object have been changed in this suggestion.
+                    "descriptionSuggested": True or False, # Indicates if there was a suggested change to description.
+                    "embeddedDrawingPropertiesSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedDrawingProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_drawing_properties have been changed in this suggestion.
+                    },
+                    "embeddedObjectBorderSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedObjectBorder have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_object_border have been changed in this suggestion.
+                      "colorSuggested": True or False, # Indicates if there was a suggested change to color.
+                      "dashStyleSuggested": True or False, # Indicates if there was a suggested change to dash_style.
+                      "propertyStateSuggested": True or False, # Indicates if there was a suggested change to property_state.
+                      "widthSuggested": True or False, # Indicates if there was a suggested change to width.
+                    },
+                    "imagePropertiesSuggestionState": { # A mask that indicates which of the fields on the base ImageProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in image_properties have been changed in this suggestion.
+                      "angleSuggested": True or False, # Indicates if there was a suggested change to angle.
+                      "brightnessSuggested": True or False, # Indicates if there was a suggested change to brightness.
+                      "contentUriSuggested": True or False, # Indicates if there was a suggested change to content_uri.
+                      "contrastSuggested": True or False, # Indicates if there was a suggested change to contrast.
+                      "cropPropertiesSuggestionState": { # A mask that indicates which of the fields on the base CropProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in crop_properties have been changed in this suggestion.
+                        "angleSuggested": True or False, # Indicates if there was a suggested change to angle.
+                        "offsetBottomSuggested": True or False, # Indicates if there was a suggested change to offset_bottom.
+                        "offsetLeftSuggested": True or False, # Indicates if there was a suggested change to offset_left.
+                        "offsetRightSuggested": True or False, # Indicates if there was a suggested change to offset_right.
+                        "offsetTopSuggested": True or False, # Indicates if there was a suggested change to offset_top.
+                      },
+                      "sourceUriSuggested": True or False, # Indicates if there was a suggested change to source_uri.
+                      "transparencySuggested": True or False, # Indicates if there was a suggested change to transparency.
+                    },
+                    "linkedContentReferenceSuggestionState": { # A mask that indicates which of the fields on the base LinkedContentReference have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in linked_content_reference have been changed in this suggestion.
+                      "sheetsChartReferenceSuggestionState": { # A mask that indicates which of the fields on the base SheetsChartReference have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in sheets_chart_reference have been changed in this suggestion.
+                        "chartIdSuggested": True or False, # Indicates if there was a suggested change to chart_id.
+                        "spreadsheetIdSuggested": True or False, # Indicates if there was a suggested change to spreadsheet_id.
+                      },
+                    },
+                    "marginBottomSuggested": True or False, # Indicates if there was a suggested change to margin_bottom.
+                    "marginLeftSuggested": True or False, # Indicates if there was a suggested change to margin_left.
+                    "marginRightSuggested": True or False, # Indicates if there was a suggested change to margin_right.
+                    "marginTopSuggested": True or False, # Indicates if there was a suggested change to margin_top.
+                    "sizeSuggestionState": { # A mask that indicates which of the fields on the base Size have been changed in this suggestion. For any field set to true, the Size has a new suggested value. # A mask that indicates which of the fields in size have been changed in this suggestion.
+                      "heightSuggested": True or False, # Indicates if there was a suggested change to height.
+                      "widthSuggested": True or False, # Indicates if there was a suggested change to width.
+                    },
+                    "titleSuggested": True or False, # Indicates if there was a suggested change to title.
+                  },
                 },
               },
-            },
-            "dashStyle": "A String", # The dash style of the border.
-            "propertyState": "A String", # The property state of the border property.
-            "width": { # A magnitude in a single direction in the specified units. # The width of the border.
-              "magnitude": 3.14, # The magnitude.
-              "unit": "A String", # The units for magnitude.
-            },
-          },
-          "imageProperties": { # The properties of an image. # The properties of an image.
-            "angle": 3.14, # The clockwise rotation angle of the image, in radians.
-            "brightness": 3.14, # The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect.
-            "contentUri": "A String", # A URI to the image with a default lifetime of 30 minutes. This URI is tagged with the account of the requester. Anyone with the URI effectively accesses the image as the original requester. Access to the image may be lost if the document's sharing settings change.
-            "contrast": 3.14, # The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect.
-            "cropProperties": { # The crop properties of an image. The crop rectangle is represented using fractional offsets from the original content's 4 edges. - If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the image's original bounding rectangle. - If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the image's original bounding rectangle. - If all offsets and rotation angle are 0, the image is not cropped. # The crop properties of the image.
-              "angle": 3.14, # The clockwise rotation angle of the crop rectangle around its center, in radians. Rotation is applied after the offsets.
-              "offsetBottom": 3.14, # The offset specifies how far inwards the bottom edge of the crop rectangle is from the bottom edge of the original content as a fraction of the original content's height.
-              "offsetLeft": 3.14, # The offset specifies how far inwards the left edge of the crop rectangle is from the left edge of the original content as a fraction of the original content's width.
-              "offsetRight": 3.14, # The offset specifies how far inwards the right edge of the crop rectangle is from the right edge of the original content as a fraction of the original content's width.
-              "offsetTop": 3.14, # The offset specifies how far inwards the top edge of the crop rectangle is from the top edge of the original content as a fraction of the original content's height.
-            },
-            "sourceUri": "A String", # The source URI is the URI used to insert the image. The source URI can be empty.
-            "transparency": 3.14, # The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means transparent.
-          },
-          "linkedContentReference": { # A reference to the external linked source content. # A reference to the external linked source content. For example, it contains a reference to the source Google Sheets chart when the embedded object is a linked chart. If unset, then the embedded object is not linked.
-            "sheetsChartReference": { # A reference to a linked chart embedded from Google Sheets. # A reference to the linked chart.
-              "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that's embedded.
-              "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart.
-            },
-          },
-          "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom margin of the embedded object.
-            "magnitude": 3.14, # The magnitude.
-            "unit": "A String", # The units for magnitude.
-          },
-          "marginLeft": { # A magnitude in a single direction in the specified units. # The left margin of the embedded object.
-            "magnitude": 3.14, # The magnitude.
-            "unit": "A String", # The units for magnitude.
-          },
-          "marginRight": { # A magnitude in a single direction in the specified units. # The right margin of the embedded object.
-            "magnitude": 3.14, # The magnitude.
-            "unit": "A String", # The units for magnitude.
-          },
-          "marginTop": { # A magnitude in a single direction in the specified units. # The top margin of the embedded object.
-            "magnitude": 3.14, # The magnitude.
-            "unit": "A String", # The units for magnitude.
+            },
+            "suggestedInsertionId": "A String", # The suggested insertion ID. If empty, then this is not a suggested insertion.
           },
-          "size": { # A width and height. # The visible size of the image after cropping.
-            "height": { # A magnitude in a single direction in the specified units. # The height of the object.
-              "magnitude": 3.14, # The magnitude.
-              "unit": "A String", # The units for magnitude.
+        },
+        "lists": { # The lists in the document tab, keyed by list ID.
+          "a_key": { # A List represents the list attributes for a group of paragraphs that all belong to the same list. A paragraph that's part of a list has a reference to the list's ID in its bullet.
+            "listProperties": { # The properties of a list that describe the look and feel of bullets belonging to paragraphs associated with a list. # The properties of the list.
+              "nestingLevels": [ # Describes the properties of the bullets at the associated level. A list has at most 9 levels of nesting with nesting level 0 corresponding to the top-most level and nesting level 8 corresponding to the most nested level. The nesting levels are returned in ascending order with the least nested returned first.
+                { # Contains properties describing the look and feel of a list bullet at a given level of nesting.
+                  "bulletAlignment": "A String", # The alignment of the bullet within the space allotted for rendering the bullet.
+                  "glyphFormat": "A String", # The format string used by bullets at this level of nesting. The glyph format contains one or more placeholders, and these placeholders are replaced with the appropriate values depending on the glyph_type or glyph_symbol. The placeholders follow the pattern `%[nesting_level]`. Furthermore, placeholders can have prefixes and suffixes. Thus, the glyph format follows the pattern `%[nesting_level]`. Note that the prefix and suffix are optional and can be arbitrary strings. For example, the glyph format `%0.` indicates that the rendered glyph will replace the placeholder with the corresponding glyph for nesting level 0 followed by a period as the suffix. So a list with a glyph type of UPPER_ALPHA and glyph format `%0.` at nesting level 0 will result in a list with rendered glyphs `A.` `B.` `C.` The glyph format can contain placeholders for the current nesting level as well as placeholders for parent nesting levels. For example, a list can have a glyph format of `%0.` at nesting level 0 and a glyph format of `%0.%1.` at nesting level 1. Assuming both nesting levels have DECIMAL glyph types, this would result in a list with rendered glyphs `1.` `2.` ` 2.1.` ` 2.2.` `3.` For nesting levels that are ordered, the string that replaces a placeholder in the glyph format for a particular paragraph depends on the paragraph's order within the list.
+                  "glyphSymbol": "A String", # A custom glyph symbol used by bullets when paragraphs at this level of nesting are unordered. The glyph symbol replaces placeholders within the glyph_format. For example, if the glyph_symbol is the solid circle corresponding to Unicode U+25cf code point and the glyph_format is `%0`, the rendered glyph would be the solid circle.
+                  "glyphType": "A String", # The type of glyph used by bullets when paragraphs at this level of nesting are ordered. The glyph type determines the type of glyph used to replace placeholders within the glyph_format when paragraphs at this level of nesting are ordered. For example, if the nesting level is 0, the glyph_format is `%0.` and the glyph type is DECIMAL, then the rendered glyph would replace the placeholder `%0` in the glyph format with a number corresponding to list item's order within the list.
+                  "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of paragraphs at this level of nesting.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for paragraphs at this level of nesting. Applied to the side that corresponds to the start of the text, based on the paragraph's content direction.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "startNumber": 42, # The number of the first list item at this nesting level. A value of 0 is treated as a value of 1 for lettered lists and Roman numeral lists. For values of both 0 and 1, lettered and Roman numeral lists will begin at `a` and `i` respectively. This value is ignored for nesting levels with unordered glyphs.
+                  "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of bullets at this level of nesting.
+                    "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                    "bold": True or False, # Whether or not the text is rendered as bold.
+                    "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "italic": True or False, # Whether or not the text is italicized.
+                    "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                      "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a bookmark in this document.
+                        "tabId": "A String", # The ID of the tab containing this bookmark.
+                      },
+                      "bookmarkId": "A String", # The ID of a bookmark in this document.
+                      "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of the tab containing this heading.
+                      },
+                      "headingId": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of a tab in this document.
+                      "url": "A String", # An external URL.
+                    },
+                    "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                    "strikethrough": True or False, # Whether or not the text is struck through.
+                    "underline": True or False, # Whether or not the text is underlined.
+                    "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                      "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                      "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                    },
+                  },
+                },
+              ],
             },
-            "width": { # A magnitude in a single direction in the specified units. # The width of the object.
-              "magnitude": 3.14, # The magnitude.
-              "unit": "A String", # The units for magnitude.
+            "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this list.
+              "A String",
+            ],
+            "suggestedInsertionId": "A String", # The suggested insertion ID. If empty, then this is not a suggested insertion.
+            "suggestedListPropertiesChanges": { # The suggested changes to the list properties, keyed by suggestion ID.
+              "a_key": { # A suggested change to ListProperties.
+                "listProperties": { # The properties of a list that describe the look and feel of bullets belonging to paragraphs associated with a list. # A ListProperties that only includes the changes made in this suggestion. This can be used along with the list_properties_suggestion_state to see which fields have changed and their new values.
+                  "nestingLevels": [ # Describes the properties of the bullets at the associated level. A list has at most 9 levels of nesting with nesting level 0 corresponding to the top-most level and nesting level 8 corresponding to the most nested level. The nesting levels are returned in ascending order with the least nested returned first.
+                    { # Contains properties describing the look and feel of a list bullet at a given level of nesting.
+                      "bulletAlignment": "A String", # The alignment of the bullet within the space allotted for rendering the bullet.
+                      "glyphFormat": "A String", # The format string used by bullets at this level of nesting. The glyph format contains one or more placeholders, and these placeholders are replaced with the appropriate values depending on the glyph_type or glyph_symbol. The placeholders follow the pattern `%[nesting_level]`. Furthermore, placeholders can have prefixes and suffixes. Thus, the glyph format follows the pattern `%[nesting_level]`. Note that the prefix and suffix are optional and can be arbitrary strings. For example, the glyph format `%0.` indicates that the rendered glyph will replace the placeholder with the corresponding glyph for nesting level 0 followed by a period as the suffix. So a list with a glyph type of UPPER_ALPHA and glyph format `%0.` at nesting level 0 will result in a list with rendered glyphs `A.` `B.` `C.` The glyph format can contain placeholders for the current nesting level as well as placeholders for parent nesting levels. For example, a list can have a glyph format of `%0.` at nesting level 0 and a glyph format of `%0.%1.` at nesting level 1. Assuming both nesting levels have DECIMAL glyph types, this would result in a list with rendered glyphs `1.` `2.` ` 2.1.` ` 2.2.` `3.` For nesting levels that are ordered, the string that replaces a placeholder in the glyph format for a particular paragraph depends on the paragraph's order within the list.
+                      "glyphSymbol": "A String", # A custom glyph symbol used by bullets when paragraphs at this level of nesting are unordered. The glyph symbol replaces placeholders within the glyph_format. For example, if the glyph_symbol is the solid circle corresponding to Unicode U+25cf code point and the glyph_format is `%0`, the rendered glyph would be the solid circle.
+                      "glyphType": "A String", # The type of glyph used by bullets when paragraphs at this level of nesting are ordered. The glyph type determines the type of glyph used to replace placeholders within the glyph_format when paragraphs at this level of nesting are ordered. For example, if the nesting level is 0, the glyph_format is `%0.` and the glyph type is DECIMAL, then the rendered glyph would replace the placeholder `%0` in the glyph format with a number corresponding to list item's order within the list.
+                      "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of paragraphs at this level of nesting.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for paragraphs at this level of nesting. Applied to the side that corresponds to the start of the text, based on the paragraph's content direction.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "startNumber": 42, # The number of the first list item at this nesting level. A value of 0 is treated as a value of 1 for lettered lists and Roman numeral lists. For values of both 0 and 1, lettered and Roman numeral lists will begin at `a` and `i` respectively. This value is ignored for nesting levels with unordered glyphs.
+                      "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of bullets at this level of nesting.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                        "bold": True or False, # Whether or not the text is rendered as bold.
+                        "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "italic": True or False, # Whether or not the text is italicized.
+                        "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                          "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a bookmark in this document.
+                            "tabId": "A String", # The ID of the tab containing this bookmark.
+                          },
+                          "bookmarkId": "A String", # The ID of a bookmark in this document.
+                          "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of the tab containing this heading.
+                          },
+                          "headingId": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of a tab in this document.
+                          "url": "A String", # An external URL.
+                        },
+                        "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                        "strikethrough": True or False, # Whether or not the text is struck through.
+                        "underline": True or False, # Whether or not the text is underlined.
+                        "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                          "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                          "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                        },
+                      },
+                    },
+                  ],
+                },
+                "listPropertiesSuggestionState": { # A mask that indicates which of the fields on the base ListProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base ListProperties have been changed in this suggestion.
+                  "nestingLevelsSuggestionStates": [ # A mask that indicates which of the fields on the corresponding NestingLevel in nesting_levels have been changed in this suggestion. The nesting level suggestion states are returned in ascending order of the nesting level with the least nested returned first.
+                    { # A mask that indicates which of the fields on the base NestingLevel have been changed in this suggestion. For any field set to true, there's a new suggested value.
+                      "bulletAlignmentSuggested": True or False, # Indicates if there was a suggested change to bullet_alignment.
+                      "glyphFormatSuggested": True or False, # Indicates if there was a suggested change to glyph_format.
+                      "glyphSymbolSuggested": True or False, # Indicates if there was a suggested change to glyph_symbol.
+                      "glyphTypeSuggested": True or False, # Indicates if there was a suggested change to glyph_type.
+                      "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line.
+                      "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start.
+                      "startNumberSuggested": True or False, # Indicates if there was a suggested change to start_number.
+                      "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion.
+                        "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                        "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                        "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                        "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                        "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                        "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                        "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                        "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                        "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                        "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                        "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                      },
+                    },
+                  ],
+                },
+              },
             },
           },
-          "title": "A String", # The title of the embedded object. The `title` and `description` are both combined to display alt text.
         },
-        "positioning": { # The positioning of a PositionedObject. The positioned object is positioned relative to the beginning of the Paragraph it's tethered to. # The positioning of this positioned object relative to the newline of the Paragraph that references this positioned object.
-          "layout": "A String", # The layout of this positioned object.
-          "leftOffset": { # A magnitude in a single direction in the specified units. # The offset of the left edge of the positioned object relative to the beginning of the Paragraph it's tethered to. The exact positioning of the object can depend on other content in the document and the document's styling.
-            "magnitude": 3.14, # The magnitude.
-            "unit": "A String", # The units for magnitude.
-          },
-          "topOffset": { # A magnitude in a single direction in the specified units. # The offset of the top edge of the positioned object relative to the beginning of the Paragraph it's tethered to. The exact positioning of the object can depend on other content in the document and the document's styling.
-            "magnitude": 3.14, # The magnitude.
-            "unit": "A String", # The units for magnitude.
+        "namedRanges": { # The named ranges in the document tab, keyed by name.
+          "a_key": { # A collection of all the NamedRanges in the document that share a given name.
+            "name": "A String", # The name that all the named ranges share.
+            "namedRanges": [ # The NamedRanges that share the same name.
+              { # A collection of Ranges with the same named range ID. Named ranges allow developers to associate parts of a document with an arbitrary user-defined label so their contents can be programmatically read or edited later. A document can contain multiple named ranges with the same name, but every named range has a unique ID. A named range is created with a single Range, and content inserted inside a named range generally expands that range. However, certain document changes can cause the range to be split into multiple ranges. Named ranges are not private. All applications and collaborators that have access to the document can see its named ranges.
+                "name": "A String", # The name of the named range.
+                "namedRangeId": "A String", # The ID of the named range.
+                "ranges": [ # The ranges that belong to this named range.
+                  { # Specifies a contiguous range of text.
+                    "endIndex": 42, # The zero-based end index of this range, exclusive, in UTF-16 code units. In all current uses, an end index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges.
+                    "segmentId": "A String", # The ID of the header, footer, or footnote that this range is contained in. An empty segment ID signifies the document's body.
+                    "startIndex": 42, # The zero-based start index of this range, in UTF-16 code units. In all current uses, a start index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges.
+                    "tabId": "A String", # The tab that contains this range. When omitted, the request applies to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document.
+                  },
+                ],
+              },
+            ],
           },
         },
-      },
-      "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
-        "A String",
-      ],
-      "suggestedInsertionId": "A String", # The suggested insertion ID. If empty, then this is not a suggested insertion.
-      "suggestedPositionedObjectPropertiesChanges": { # The suggested changes to the positioned object properties, keyed by suggestion ID.
-        "a_key": { # A suggested change to PositionedObjectProperties.
-          "positionedObjectProperties": { # Properties of a PositionedObject. # A PositionedObjectProperties that only includes the changes made in this suggestion. This can be used along with the positioned_object_properties_suggestion_state to see which fields have changed and their new values.
-            "embeddedObject": { # An embedded object in the document. # The embedded object of this positioned object.
-              "description": "A String", # The description of the embedded object. The `title` and `description` are both combined to display alt text.
-              "embeddedDrawingProperties": { # The properties of an embedded drawing and used to differentiate the object type. An embedded drawing is one that's created and edited within a document. Note that extensive details are not supported. # The properties of an embedded drawing.
+        "namedStyles": { # The named styles. Paragraphs in the document can inherit their TextStyle and ParagraphStyle from these named styles. # The named styles of the document tab.
+          "styles": [ # The named styles. There's an entry for each of the possible named style types.
+            { # A named style. Paragraphs in the document can inherit their TextStyle and ParagraphStyle from this named style when they have the same named style type.
+              "namedStyleType": "A String", # The type of this named style.
+              "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph style of this named style.
+                "alignment": "A String", # The text alignment for this paragraph.
+                "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent.
+                "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                  "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                      "rgbColor": { # An RGB color. # The RGB color value.
+                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                      },
+                    },
+                  },
+                  "dashStyle": "A String", # The dash style of the border.
+                  "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                },
+                "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                  "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                      "rgbColor": { # An RGB color. # The RGB color value.
+                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                      },
+                    },
+                  },
+                  "dashStyle": "A String", # The dash style of the border.
+                  "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                },
+                "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                  "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                      "rgbColor": { # An RGB color. # The RGB color value.
+                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                      },
+                    },
+                  },
+                  "dashStyle": "A String", # The dash style of the border.
+                  "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                },
+                "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                  "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                      "rgbColor": { # An RGB color. # The RGB color value.
+                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                      },
+                    },
+                  },
+                  "dashStyle": "A String", # The dash style of the border.
+                  "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                },
+                "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                  "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                      "rgbColor": { # An RGB color. # The RGB color value.
+                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                      },
+                    },
+                  },
+                  "dashStyle": "A String", # The dash style of the border.
+                  "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                },
+                "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited.
+                "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only.
+                "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent.
+                "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent.
+                "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent.
+                "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated.
+                "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error.
+                "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent.
+                  "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading.
+                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                      "rgbColor": { # An RGB color. # The RGB color value.
+                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                      },
+                    },
+                  },
+                },
+                "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "spacingMode": "A String", # The spacing mode for the paragraph.
+                "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only.
+                  { # A tab stop within a paragraph.
+                    "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START.
+                    "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                  },
+                ],
               },
-              "embeddedObjectBorder": { # A border around an EmbeddedObject. # The border of the embedded object.
-                "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+              "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this named style.
+                "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
                   "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
                     "rgbColor": { # An RGB color. # The RGB color value.
                       "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
@@ -25199,226 +54439,279 @@ 

Method Details

}, }, }, - "dashStyle": "A String", # The dash style of the border. - "propertyState": "A String", # The property state of the border property. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - }, - "imageProperties": { # The properties of an image. # The properties of an image. - "angle": 3.14, # The clockwise rotation angle of the image, in radians. - "brightness": 3.14, # The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. - "contentUri": "A String", # A URI to the image with a default lifetime of 30 minutes. This URI is tagged with the account of the requester. Anyone with the URI effectively accesses the image as the original requester. Access to the image may be lost if the document's sharing settings change. - "contrast": 3.14, # The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. - "cropProperties": { # The crop properties of an image. The crop rectangle is represented using fractional offsets from the original content's 4 edges. - If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the image's original bounding rectangle. - If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the image's original bounding rectangle. - If all offsets and rotation angle are 0, the image is not cropped. # The crop properties of the image. - "angle": 3.14, # The clockwise rotation angle of the crop rectangle around its center, in radians. Rotation is applied after the offsets. - "offsetBottom": 3.14, # The offset specifies how far inwards the bottom edge of the crop rectangle is from the bottom edge of the original content as a fraction of the original content's height. - "offsetLeft": 3.14, # The offset specifies how far inwards the left edge of the crop rectangle is from the left edge of the original content as a fraction of the original content's width. - "offsetRight": 3.14, # The offset specifies how far inwards the right edge of the crop rectangle is from the right edge of the original content as a fraction of the original content's width. - "offsetTop": 3.14, # The offset specifies how far inwards the top edge of the crop rectangle is from the top edge of the original content as a fraction of the original content's height. + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, }, - "sourceUri": "A String", # The source URI is the URI used to insert the image. The source URI can be empty. - "transparency": 3.14, # The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means transparent. - }, - "linkedContentReference": { # A reference to the external linked source content. # A reference to the external linked source content. For example, it contains a reference to the source Google Sheets chart when the embedded object is a linked chart. If unset, then the embedded object is not linked. - "sheetsChartReference": { # A reference to a linked chart embedded from Google Sheets. # A reference to the linked chart. - "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that's embedded. - "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart. + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, - "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom margin of the embedded object. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginLeft": { # A magnitude in a single direction in the specified units. # The left margin of the embedded object. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginRight": { # A magnitude in a single direction in the specified units. # The right margin of the embedded object. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginTop": { # A magnitude in a single direction in the specified units. # The top margin of the embedded object. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "size": { # A width and height. # The visible size of the image after cropping. - "height": { # A magnitude in a single direction in the specified units. # The height of the object. + }, + ], + }, + "positionedObjects": { # The positioned objects in the document tab, keyed by object ID. + "a_key": { # An object that's tethered to a Paragraph and positioned relative to the beginning of the paragraph. A PositionedObject contains an EmbeddedObject such as an image. + "objectId": "A String", # The ID of this positioned object. + "positionedObjectProperties": { # Properties of a PositionedObject. # The properties of this positioned object. + "embeddedObject": { # An embedded object in the document. # The embedded object of this positioned object. + "description": "A String", # The description of the embedded object. The `title` and `description` are both combined to display alt text. + "embeddedDrawingProperties": { # The properties of an embedded drawing and used to differentiate the object type. An embedded drawing is one that's created and edited within a document. Note that extensive details are not supported. # The properties of an embedded drawing. + }, + "embeddedObjectBorder": { # A border around an EmbeddedObject. # The border of the embedded object. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "propertyState": "A String", # The property state of the border property. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "imageProperties": { # The properties of an image. # The properties of an image. + "angle": 3.14, # The clockwise rotation angle of the image, in radians. + "brightness": 3.14, # The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. + "contentUri": "A String", # A URI to the image with a default lifetime of 30 minutes. This URI is tagged with the account of the requester. Anyone with the URI effectively accesses the image as the original requester. Access to the image may be lost if the document's sharing settings change. + "contrast": 3.14, # The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. + "cropProperties": { # The crop properties of an image. The crop rectangle is represented using fractional offsets from the original content's 4 edges. - If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the image's original bounding rectangle. - If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the image's original bounding rectangle. - If all offsets and rotation angle are 0, the image is not cropped. # The crop properties of the image. + "angle": 3.14, # The clockwise rotation angle of the crop rectangle around its center, in radians. Rotation is applied after the offsets. + "offsetBottom": 3.14, # The offset specifies how far inwards the bottom edge of the crop rectangle is from the bottom edge of the original content as a fraction of the original content's height. + "offsetLeft": 3.14, # The offset specifies how far inwards the left edge of the crop rectangle is from the left edge of the original content as a fraction of the original content's width. + "offsetRight": 3.14, # The offset specifies how far inwards the right edge of the crop rectangle is from the right edge of the original content as a fraction of the original content's width. + "offsetTop": 3.14, # The offset specifies how far inwards the top edge of the crop rectangle is from the top edge of the original content as a fraction of the original content's height. + }, + "sourceUri": "A String", # The source URI is the URI used to insert the image. The source URI can be empty. + "transparency": 3.14, # The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means transparent. + }, + "linkedContentReference": { # A reference to the external linked source content. # A reference to the external linked source content. For example, it contains a reference to the source Google Sheets chart when the embedded object is a linked chart. If unset, then the embedded object is not linked. + "sheetsChartReference": { # A reference to a linked chart embedded from Google Sheets. # A reference to the linked chart. + "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that's embedded. + "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart. + }, + }, + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom margin of the embedded object. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "width": { # A magnitude in a single direction in the specified units. # The width of the object. + "marginLeft": { # A magnitude in a single direction in the specified units. # The left margin of the embedded object. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - }, - "title": "A String", # The title of the embedded object. The `title` and `description` are both combined to display alt text. - }, - "positioning": { # The positioning of a PositionedObject. The positioned object is positioned relative to the beginning of the Paragraph it's tethered to. # The positioning of this positioned object relative to the newline of the Paragraph that references this positioned object. - "layout": "A String", # The layout of this positioned object. - "leftOffset": { # A magnitude in a single direction in the specified units. # The offset of the left edge of the positioned object relative to the beginning of the Paragraph it's tethered to. The exact positioning of the object can depend on other content in the document and the document's styling. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "topOffset": { # A magnitude in a single direction in the specified units. # The offset of the top edge of the positioned object relative to the beginning of the Paragraph it's tethered to. The exact positioning of the object can depend on other content in the document and the document's styling. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - }, - "positionedObjectPropertiesSuggestionState": { # A mask that indicates which of the fields on the base PositionedObjectProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base PositionedObjectProperties have been changed in this suggestion. - "embeddedObjectSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedObject have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_object have been changed in this suggestion. - "descriptionSuggested": True or False, # Indicates if there was a suggested change to description. - "embeddedDrawingPropertiesSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedDrawingProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_drawing_properties have been changed in this suggestion. - }, - "embeddedObjectBorderSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedObjectBorder have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_object_border have been changed in this suggestion. - "colorSuggested": True or False, # Indicates if there was a suggested change to color. - "dashStyleSuggested": True or False, # Indicates if there was a suggested change to dash_style. - "propertyStateSuggested": True or False, # Indicates if there was a suggested change to property_state. - "widthSuggested": True or False, # Indicates if there was a suggested change to width. - }, - "imagePropertiesSuggestionState": { # A mask that indicates which of the fields on the base ImageProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in image_properties have been changed in this suggestion. - "angleSuggested": True or False, # Indicates if there was a suggested change to angle. - "brightnessSuggested": True or False, # Indicates if there was a suggested change to brightness. - "contentUriSuggested": True or False, # Indicates if there was a suggested change to content_uri. - "contrastSuggested": True or False, # Indicates if there was a suggested change to contrast. - "cropPropertiesSuggestionState": { # A mask that indicates which of the fields on the base CropProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in crop_properties have been changed in this suggestion. - "angleSuggested": True or False, # Indicates if there was a suggested change to angle. - "offsetBottomSuggested": True or False, # Indicates if there was a suggested change to offset_bottom. - "offsetLeftSuggested": True or False, # Indicates if there was a suggested change to offset_left. - "offsetRightSuggested": True or False, # Indicates if there was a suggested change to offset_right. - "offsetTopSuggested": True or False, # Indicates if there was a suggested change to offset_top. + "marginRight": { # A magnitude in a single direction in the specified units. # The right margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - "sourceUriSuggested": True or False, # Indicates if there was a suggested change to source_uri. - "transparencySuggested": True or False, # Indicates if there was a suggested change to transparency. - }, - "linkedContentReferenceSuggestionState": { # A mask that indicates which of the fields on the base LinkedContentReference have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in linked_content_reference have been changed in this suggestion. - "sheetsChartReferenceSuggestionState": { # A mask that indicates which of the fields on the base SheetsChartReference have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in sheets_chart_reference have been changed in this suggestion. - "chartIdSuggested": True or False, # Indicates if there was a suggested change to chart_id. - "spreadsheetIdSuggested": True or False, # Indicates if there was a suggested change to spreadsheet_id. + "marginTop": { # A magnitude in a single direction in the specified units. # The top margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "size": { # A width and height. # The visible size of the image after cropping. + "height": { # A magnitude in a single direction in the specified units. # The height of the object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, + "title": "A String", # The title of the embedded object. The `title` and `description` are both combined to display alt text. }, - "marginBottomSuggested": True or False, # Indicates if there was a suggested change to margin_bottom. - "marginLeftSuggested": True or False, # Indicates if there was a suggested change to margin_left. - "marginRightSuggested": True or False, # Indicates if there was a suggested change to margin_right. - "marginTopSuggested": True or False, # Indicates if there was a suggested change to margin_top. - "sizeSuggestionState": { # A mask that indicates which of the fields on the base Size have been changed in this suggestion. For any field set to true, the Size has a new suggested value. # A mask that indicates which of the fields in size have been changed in this suggestion. - "heightSuggested": True or False, # Indicates if there was a suggested change to height. - "widthSuggested": True or False, # Indicates if there was a suggested change to width. + "positioning": { # The positioning of a PositionedObject. The positioned object is positioned relative to the beginning of the Paragraph it's tethered to. # The positioning of this positioned object relative to the newline of the Paragraph that references this positioned object. + "layout": "A String", # The layout of this positioned object. + "leftOffset": { # A magnitude in a single direction in the specified units. # The offset of the left edge of the positioned object relative to the beginning of the Paragraph it's tethered to. The exact positioning of the object can depend on other content in the document and the document's styling. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "topOffset": { # A magnitude in a single direction in the specified units. # The offset of the top edge of the positioned object relative to the beginning of the Paragraph it's tethered to. The exact positioning of the object can depend on other content in the document and the document's styling. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - "titleSuggested": True or False, # Indicates if there was a suggested change to title. - }, - "positioningSuggestionState": { # A mask that indicates which of the fields on the base PositionedObjectPositioning have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in positioning have been changed in this suggestion. - "layoutSuggested": True or False, # Indicates if there was a suggested change to layout. - "leftOffsetSuggested": True or False, # Indicates if there was a suggested change to left_offset. - "topOffsetSuggested": True or False, # Indicates if there was a suggested change to top_offset. }, - }, - }, - }, - }, - }, - "revisionId": "A String", # Output only. The revision ID of the document. Can be used in update requests to specify which revision of a document to apply updates to and how the request should behave if the document has been edited since that revision. Only populated if the user has edit access to the document. The revision ID is not a sequential number but an opaque string. The format of the revision ID might change over time. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the document has not changed. Conversely, a changed ID (for the same document and user) usually means the document has been updated. However, a changed ID can also be due to internal factors such as ID format changes. - "suggestedDocumentStyleChanges": { # Output only. The suggested changes to the style of the document, keyed by suggestion ID. - "a_key": { # A suggested change to the DocumentStyle. - "documentStyle": { # The style of the document. # A DocumentStyle that only includes the changes made in this suggestion. This can be used along with the document_style_suggestion_state to see which fields have changed and their new values. - "background": { # Represents the background of a document. # The background of the document. Documents cannot have a transparent background color. - "color": { # A color that can either be fully opaque or fully transparent. # The background color. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionId": "A String", # The suggested insertion ID. If empty, then this is not a suggested insertion. + "suggestedPositionedObjectPropertiesChanges": { # The suggested changes to the positioned object properties, keyed by suggestion ID. + "a_key": { # A suggested change to PositionedObjectProperties. + "positionedObjectProperties": { # Properties of a PositionedObject. # A PositionedObjectProperties that only includes the changes made in this suggestion. This can be used along with the positioned_object_properties_suggestion_state to see which fields have changed and their new values. + "embeddedObject": { # An embedded object in the document. # The embedded object of this positioned object. + "description": "A String", # The description of the embedded object. The `title` and `description` are both combined to display alt text. + "embeddedDrawingProperties": { # The properties of an embedded drawing and used to differentiate the object type. An embedded drawing is one that's created and edited within a document. Note that extensive details are not supported. # The properties of an embedded drawing. + }, + "embeddedObjectBorder": { # A border around an EmbeddedObject. # The border of the embedded object. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "propertyState": "A String", # The property state of the border property. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "imageProperties": { # The properties of an image. # The properties of an image. + "angle": 3.14, # The clockwise rotation angle of the image, in radians. + "brightness": 3.14, # The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. + "contentUri": "A String", # A URI to the image with a default lifetime of 30 minutes. This URI is tagged with the account of the requester. Anyone with the URI effectively accesses the image as the original requester. Access to the image may be lost if the document's sharing settings change. + "contrast": 3.14, # The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. + "cropProperties": { # The crop properties of an image. The crop rectangle is represented using fractional offsets from the original content's 4 edges. - If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the image's original bounding rectangle. - If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the image's original bounding rectangle. - If all offsets and rotation angle are 0, the image is not cropped. # The crop properties of the image. + "angle": 3.14, # The clockwise rotation angle of the crop rectangle around its center, in radians. Rotation is applied after the offsets. + "offsetBottom": 3.14, # The offset specifies how far inwards the bottom edge of the crop rectangle is from the bottom edge of the original content as a fraction of the original content's height. + "offsetLeft": 3.14, # The offset specifies how far inwards the left edge of the crop rectangle is from the left edge of the original content as a fraction of the original content's width. + "offsetRight": 3.14, # The offset specifies how far inwards the right edge of the crop rectangle is from the right edge of the original content as a fraction of the original content's width. + "offsetTop": 3.14, # The offset specifies how far inwards the top edge of the crop rectangle is from the top edge of the original content as a fraction of the original content's height. + }, + "sourceUri": "A String", # The source URI is the URI used to insert the image. The source URI can be empty. + "transparency": 3.14, # The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means transparent. + }, + "linkedContentReference": { # A reference to the external linked source content. # A reference to the external linked source content. For example, it contains a reference to the source Google Sheets chart when the embedded object is a linked chart. If unset, then the embedded object is not linked. + "sheetsChartReference": { # A reference to a linked chart embedded from Google Sheets. # A reference to the linked chart. + "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that's embedded. + "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart. + }, + }, + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginLeft": { # A magnitude in a single direction in the specified units. # The left margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginRight": { # A magnitude in a single direction in the specified units. # The right margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginTop": { # A magnitude in a single direction in the specified units. # The top margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "size": { # A width and height. # The visible size of the image after cropping. + "height": { # A magnitude in a single direction in the specified units. # The height of the object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "title": "A String", # The title of the embedded object. The `title` and `description` are both combined to display alt text. + }, + "positioning": { # The positioning of a PositionedObject. The positioned object is positioned relative to the beginning of the Paragraph it's tethered to. # The positioning of this positioned object relative to the newline of the Paragraph that references this positioned object. + "layout": "A String", # The layout of this positioned object. + "leftOffset": { # A magnitude in a single direction in the specified units. # The offset of the left edge of the positioned object relative to the beginning of the Paragraph it's tethered to. The exact positioning of the object can depend on other content in the document and the document's styling. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "topOffset": { # A magnitude in a single direction in the specified units. # The offset of the top edge of the positioned object relative to the beginning of the Paragraph it's tethered to. The exact positioning of the object can depend on other content in the document and the document's styling. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + }, + "positionedObjectPropertiesSuggestionState": { # A mask that indicates which of the fields on the base PositionedObjectProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base PositionedObjectProperties have been changed in this suggestion. + "embeddedObjectSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedObject have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_object have been changed in this suggestion. + "descriptionSuggested": True or False, # Indicates if there was a suggested change to description. + "embeddedDrawingPropertiesSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedDrawingProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_drawing_properties have been changed in this suggestion. + }, + "embeddedObjectBorderSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedObjectBorder have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_object_border have been changed in this suggestion. + "colorSuggested": True or False, # Indicates if there was a suggested change to color. + "dashStyleSuggested": True or False, # Indicates if there was a suggested change to dash_style. + "propertyStateSuggested": True or False, # Indicates if there was a suggested change to property_state. + "widthSuggested": True or False, # Indicates if there was a suggested change to width. + }, + "imagePropertiesSuggestionState": { # A mask that indicates which of the fields on the base ImageProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in image_properties have been changed in this suggestion. + "angleSuggested": True or False, # Indicates if there was a suggested change to angle. + "brightnessSuggested": True or False, # Indicates if there was a suggested change to brightness. + "contentUriSuggested": True or False, # Indicates if there was a suggested change to content_uri. + "contrastSuggested": True or False, # Indicates if there was a suggested change to contrast. + "cropPropertiesSuggestionState": { # A mask that indicates which of the fields on the base CropProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in crop_properties have been changed in this suggestion. + "angleSuggested": True or False, # Indicates if there was a suggested change to angle. + "offsetBottomSuggested": True or False, # Indicates if there was a suggested change to offset_bottom. + "offsetLeftSuggested": True or False, # Indicates if there was a suggested change to offset_left. + "offsetRightSuggested": True or False, # Indicates if there was a suggested change to offset_right. + "offsetTopSuggested": True or False, # Indicates if there was a suggested change to offset_top. + }, + "sourceUriSuggested": True or False, # Indicates if there was a suggested change to source_uri. + "transparencySuggested": True or False, # Indicates if there was a suggested change to transparency. + }, + "linkedContentReferenceSuggestionState": { # A mask that indicates which of the fields on the base LinkedContentReference have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in linked_content_reference have been changed in this suggestion. + "sheetsChartReferenceSuggestionState": { # A mask that indicates which of the fields on the base SheetsChartReference have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in sheets_chart_reference have been changed in this suggestion. + "chartIdSuggested": True or False, # Indicates if there was a suggested change to chart_id. + "spreadsheetIdSuggested": True or False, # Indicates if there was a suggested change to spreadsheet_id. + }, + }, + "marginBottomSuggested": True or False, # Indicates if there was a suggested change to margin_bottom. + "marginLeftSuggested": True or False, # Indicates if there was a suggested change to margin_left. + "marginRightSuggested": True or False, # Indicates if there was a suggested change to margin_right. + "marginTopSuggested": True or False, # Indicates if there was a suggested change to margin_top. + "sizeSuggestionState": { # A mask that indicates which of the fields on the base Size have been changed in this suggestion. For any field set to true, the Size has a new suggested value. # A mask that indicates which of the fields in size have been changed in this suggestion. + "heightSuggested": True or False, # Indicates if there was a suggested change to height. + "widthSuggested": True or False, # Indicates if there was a suggested change to width. + }, + "titleSuggested": True or False, # Indicates if there was a suggested change to title. + }, + "positioningSuggestionState": { # A mask that indicates which of the fields on the base PositionedObjectPositioning have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in positioning have been changed in this suggestion. + "layoutSuggested": True or False, # Indicates if there was a suggested change to layout. + "leftOffsetSuggested": True or False, # Indicates if there was a suggested change to left_offset. + "topOffsetSuggested": True or False, # Indicates if there was a suggested change to top_offset. + }, + }, }, }, }, }, - "defaultFooterId": "A String", # The ID of the default footer. If not set, there's no default footer. This property is read-only. - "defaultHeaderId": "A String", # The ID of the default header. If not set, there's no default header. This property is read-only. - "evenPageFooterId": "A String", # The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. This property is read-only. - "evenPageHeaderId": "A String", # The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. This property is read-only. - "firstPageFooterId": "A String", # The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. This property is read-only. - "firstPageHeaderId": "A String", # The ID of the header used only for the first page. If not set then a unique header for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_header_id or this value for the header on the first page. If not set, there's no first page header. This property is read-only. - "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of the page_size, which allows changing the page orientation between portrait and landscape. - "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin. Updating the bottom page margin on the document style clears the bottom page margin on all section styles. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginFooter": { # A magnitude in a single direction in the specified units. # The amount of space between the bottom of the page and the contents of the footer. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginHeader": { # A magnitude in a single direction in the specified units. # The amount of space between the top of the page and the contents of the header. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin. Updating the left page margin on the document style clears the left page margin on all section styles. It may also cause columns to resize in all sections. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin. Updating the right page margin on the document style clears the right page margin on all section styles. It may also cause columns to resize in all sections. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin. Updating the top page margin on the document style clears the top page margin on all section styles. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "pageNumberStart": 42, # The page number from which to start counting the number of pages. - "pageSize": { # A width and height. # The size of a page in the document. - "height": { # A magnitude in a single direction in the specified units. # The height of the object. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the object. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "useCustomHeaderFooterMargins": True or False, # Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected. When false, the default values in the Docs editor for header and footer margin are used. This property is read-only. - "useEvenPageHeaderFooter": True or False, # Indicates whether to use the even page header / footer IDs for the even pages. - "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page. - }, - "documentStyleSuggestionState": { # A mask that indicates which of the fields on the base DocumentStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DocumentStyle have been changed in this suggestion. - "backgroundSuggestionState": { # A mask that indicates which of the fields on the base Background have been changed in this suggestion. For any field set to true, the Backgound has a new suggested value. # A mask that indicates which of the fields in background have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates whether the current background color has been modified in this suggestion. - }, - "defaultFooterIdSuggested": True or False, # Indicates if there was a suggested change to default_footer_id. - "defaultHeaderIdSuggested": True or False, # Indicates if there was a suggested change to default_header_id. - "evenPageFooterIdSuggested": True or False, # Indicates if there was a suggested change to even_page_footer_id. - "evenPageHeaderIdSuggested": True or False, # Indicates if there was a suggested change to even_page_header_id. - "firstPageFooterIdSuggested": True or False, # Indicates if there was a suggested change to first_page_footer_id. - "firstPageHeaderIdSuggested": True or False, # Indicates if there was a suggested change to first_page_header_id. - "flipPageOrientationSuggested": True or False, # Optional. Indicates if there was a suggested change to flip_page_orientation. - "marginBottomSuggested": True or False, # Indicates if there was a suggested change to margin_bottom. - "marginFooterSuggested": True or False, # Indicates if there was a suggested change to margin_footer. - "marginHeaderSuggested": True or False, # Indicates if there was a suggested change to margin_header. - "marginLeftSuggested": True or False, # Indicates if there was a suggested change to margin_left. - "marginRightSuggested": True or False, # Indicates if there was a suggested change to margin_right. - "marginTopSuggested": True or False, # Indicates if there was a suggested change to margin_top. - "pageNumberStartSuggested": True or False, # Indicates if there was a suggested change to page_number_start. - "pageSizeSuggestionState": { # A mask that indicates which of the fields on the base Size have been changed in this suggestion. For any field set to true, the Size has a new suggested value. # A mask that indicates which of the fields in size have been changed in this suggestion. - "heightSuggested": True or False, # Indicates if there was a suggested change to height. - "widthSuggested": True or False, # Indicates if there was a suggested change to width. - }, - "useCustomHeaderFooterMarginsSuggested": True or False, # Indicates if there was a suggested change to use_custom_header_footer_margins. - "useEvenPageHeaderFooterSuggested": True or False, # Indicates if there was a suggested change to use_even_page_header_footer. - "useFirstPageHeaderFooterSuggested": True or False, # Indicates if there was a suggested change to use_first_page_header_footer. - }, - }, - }, - "suggestedNamedStylesChanges": { # Output only. The suggested changes to the named styles of the document, keyed by suggestion ID. - "a_key": { # A suggested change to the NamedStyles. - "namedStyles": { # The named styles. Paragraphs in the document can inherit their TextStyle and ParagraphStyle from these named styles. # A NamedStyles that only includes the changes made in this suggestion. This can be used along with the named_styles_suggestion_state to see which fields have changed and their new values. - "styles": [ # The named styles. There's an entry for each of the possible named style types. - { # A named style. Paragraphs in the document can inherit their TextStyle and ParagraphStyle from this named style when they have the same named style type. - "namedStyleType": "A String", # The type of this named style. - "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph style of this named style. - "alignment": "A String", # The text alignment for this paragraph. - "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. - "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "suggestedDocumentStyleChanges": { # The suggested changes to the style of the document tab, keyed by suggestion ID. + "a_key": { # A suggested change to the DocumentStyle. + "documentStyle": { # The style of the document. # A DocumentStyle that only includes the changes made in this suggestion. This can be used along with the document_style_suggestion_state to see which fields have changed and their new values. + "background": { # Represents the background of a document. # The background of the document. Documents cannot have a transparent background color. + "color": { # A color that can either be fully opaque or fully transparent. # The background color. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -25427,235 +54720,347 @@

Method Details

}, }, }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + }, + "defaultFooterId": "A String", # The ID of the default footer. If not set, there's no default footer. This property is read-only. + "defaultHeaderId": "A String", # The ID of the default header. If not set, there's no default header. This property is read-only. + "evenPageFooterId": "A String", # The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. This property is read-only. + "evenPageHeaderId": "A String", # The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. This property is read-only. + "firstPageFooterId": "A String", # The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. This property is read-only. + "firstPageHeaderId": "A String", # The ID of the header used only for the first page. If not set then a unique header for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_header_id or this value for the header on the first page. If not set, there's no first page header. This property is read-only. + "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of the page_size, which allows changing the page orientation between portrait and landscape. + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin. Updating the bottom page margin on the document style clears the bottom page margin on all section styles. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginFooter": { # A magnitude in a single direction in the specified units. # The amount of space between the bottom of the page and the contents of the footer. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginHeader": { # A magnitude in a single direction in the specified units. # The amount of space between the top of the page and the contents of the header. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin. Updating the left page margin on the document style clears the left page margin on all section styles. It may also cause columns to resize in all sections. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin. Updating the right page margin on the document style clears the right page margin on all section styles. It may also cause columns to resize in all sections. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin. Updating the top page margin on the document style clears the top page margin on all section styles. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "pageNumberStart": 42, # The page number from which to start counting the number of pages. + "pageSize": { # A width and height. # The size of a page in the document. + "height": { # A magnitude in a single direction in the specified units. # The height of the object. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the object. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, }, - "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "useCustomHeaderFooterMargins": True or False, # Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected. When false, the default values in the Docs editor for header and footer margin are used. This property is read-only. + "useEvenPageHeaderFooter": True or False, # Indicates whether to use the even page header / footer IDs for the even pages. + "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page. + }, + "documentStyleSuggestionState": { # A mask that indicates which of the fields on the base DocumentStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DocumentStyle have been changed in this suggestion. + "backgroundSuggestionState": { # A mask that indicates which of the fields on the base Background have been changed in this suggestion. For any field set to true, the Backgound has a new suggested value. # A mask that indicates which of the fields in background have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates whether the current background color has been modified in this suggestion. + }, + "defaultFooterIdSuggested": True or False, # Indicates if there was a suggested change to default_footer_id. + "defaultHeaderIdSuggested": True or False, # Indicates if there was a suggested change to default_header_id. + "evenPageFooterIdSuggested": True or False, # Indicates if there was a suggested change to even_page_footer_id. + "evenPageHeaderIdSuggested": True or False, # Indicates if there was a suggested change to even_page_header_id. + "firstPageFooterIdSuggested": True or False, # Indicates if there was a suggested change to first_page_footer_id. + "firstPageHeaderIdSuggested": True or False, # Indicates if there was a suggested change to first_page_header_id. + "flipPageOrientationSuggested": True or False, # Optional. Indicates if there was a suggested change to flip_page_orientation. + "marginBottomSuggested": True or False, # Indicates if there was a suggested change to margin_bottom. + "marginFooterSuggested": True or False, # Indicates if there was a suggested change to margin_footer. + "marginHeaderSuggested": True or False, # Indicates if there was a suggested change to margin_header. + "marginLeftSuggested": True or False, # Indicates if there was a suggested change to margin_left. + "marginRightSuggested": True or False, # Indicates if there was a suggested change to margin_right. + "marginTopSuggested": True or False, # Indicates if there was a suggested change to margin_top. + "pageNumberStartSuggested": True or False, # Indicates if there was a suggested change to page_number_start. + "pageSizeSuggestionState": { # A mask that indicates which of the fields on the base Size have been changed in this suggestion. For any field set to true, the Size has a new suggested value. # A mask that indicates which of the fields in size have been changed in this suggestion. + "heightSuggested": True or False, # Indicates if there was a suggested change to height. + "widthSuggested": True or False, # Indicates if there was a suggested change to width. + }, + "useCustomHeaderFooterMarginsSuggested": True or False, # Indicates if there was a suggested change to use_custom_header_footer_margins. + "useEvenPageHeaderFooterSuggested": True or False, # Indicates if there was a suggested change to use_even_page_header_footer. + "useFirstPageHeaderFooterSuggested": True or False, # Indicates if there was a suggested change to use_first_page_header_footer. + }, + }, + }, + "suggestedNamedStylesChanges": { # The suggested changes to the named styles of the document tab, keyed by suggestion ID. + "a_key": { # A suggested change to the NamedStyles. + "namedStyles": { # The named styles. Paragraphs in the document can inherit their TextStyle and ParagraphStyle from these named styles. # A NamedStyles that only includes the changes made in this suggestion. This can be used along with the named_styles_suggestion_state to see which fields have changed and their new values. + "styles": [ # The named styles. There's an entry for each of the possible named style types. + { # A named style. Paragraphs in the document can inherit their TextStyle and ParagraphStyle from this named style when they have the same named style type. + "namedStyleType": "A String", # The type of this named style. + "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph style of this named style. + "alignment": "A String", # The text alignment for this paragraph. + "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. + "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. + "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. + "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. + "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. + "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. + "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. + "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. + "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, + "spacingMode": "A String", # The spacing mode for the paragraph. + "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. + { # A tab stop within a paragraph. + "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. + "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + ], }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this named style. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. - "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. - "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. - "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. - "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. - "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. - "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. - "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, - }, - }, - }, - "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "spacingMode": "A String", # The spacing mode for the paragraph. - "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. - { # A tab stop within a paragraph. - "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. - "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. }, }, ], }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this named style. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "namedStylesSuggestionState": { # The suggestion state of a NamedStyles message. # A mask that indicates which of the fields on the base NamedStyles have been changed in this suggestion. + "stylesSuggestionStates": [ # A mask that indicates which of the fields on the corresponding NamedStyle in styles have been changed in this suggestion. The order of these named style suggestion states matches the order of the corresponding named style within the named styles suggestion. + { # A suggestion state of a NamedStyle message. + "namedStyleType": "A String", # The named style type that this suggestion state corresponds to. This field is provided as a convenience for matching the NamedStyleSuggestionState with its corresponding NamedStyle. + "paragraphStyleSuggestionState": { # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in paragraph style have been changed in this suggestion. + "alignmentSuggested": True or False, # Indicates if there was a suggested change to alignment. + "avoidWidowAndOrphanSuggested": True or False, # Indicates if there was a suggested change to avoid_widow_and_orphan. + "borderBetweenSuggested": True or False, # Indicates if there was a suggested change to border_between. + "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. + "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. + "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. + "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. + "directionSuggested": True or False, # Indicates if there was a suggested change to direction. + "headingIdSuggested": True or False, # Indicates if there was a suggested change to heading_id. + "indentEndSuggested": True or False, # Indicates if there was a suggested change to indent_end. + "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line. + "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start. + "keepLinesTogetherSuggested": True or False, # Indicates if there was a suggested change to keep_lines_together. + "keepWithNextSuggested": True or False, # Indicates if there was a suggested change to keep_with_next. + "lineSpacingSuggested": True or False, # Indicates if there was a suggested change to line_spacing. + "namedStyleTypeSuggested": True or False, # Indicates if there was a suggested change to named_style_type. + "pageBreakBeforeSuggested": True or False, # Indicates if there was a suggested change to page_break_before. + "shadingSuggestionState": { # A mask that indicates which of the fields on the base Shading have been changed in this suggested change. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in shading have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to the Shading. + }, + "spaceAboveSuggested": True or False, # Indicates if there was a suggested change to space_above. + "spaceBelowSuggested": True or False, # Indicates if there was a suggested change to space_below. + "spacingModeSuggested": True or False, # Indicates if there was a suggested change to spacing_mode. }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. }, }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, + ], }, }, - ], + }, }, - "namedStylesSuggestionState": { # The suggestion state of a NamedStyles message. # A mask that indicates which of the fields on the base NamedStyles have been changed in this suggestion. - "stylesSuggestionStates": [ # A mask that indicates which of the fields on the corresponding NamedStyle in styles have been changed in this suggestion. The order of these named style suggestion states matches the order of the corresponding named style within the named styles suggestion. - { # A suggestion state of a NamedStyle message. - "namedStyleType": "A String", # The named style type that this suggestion state corresponds to. This field is provided as a convenience for matching the NamedStyleSuggestionState with its corresponding NamedStyle. - "paragraphStyleSuggestionState": { # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in paragraph style have been changed in this suggestion. - "alignmentSuggested": True or False, # Indicates if there was a suggested change to alignment. - "avoidWidowAndOrphanSuggested": True or False, # Indicates if there was a suggested change to avoid_widow_and_orphan. - "borderBetweenSuggested": True or False, # Indicates if there was a suggested change to border_between. - "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. - "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. - "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. - "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. - "directionSuggested": True or False, # Indicates if there was a suggested change to direction. - "headingIdSuggested": True or False, # Indicates if there was a suggested change to heading_id. - "indentEndSuggested": True or False, # Indicates if there was a suggested change to indent_end. - "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line. - "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start. - "keepLinesTogetherSuggested": True or False, # Indicates if there was a suggested change to keep_lines_together. - "keepWithNextSuggested": True or False, # Indicates if there was a suggested change to keep_with_next. - "lineSpacingSuggested": True or False, # Indicates if there was a suggested change to line_spacing. - "namedStyleTypeSuggested": True or False, # Indicates if there was a suggested change to named_style_type. - "pageBreakBeforeSuggested": True or False, # Indicates if there was a suggested change to page_break_before. - "shadingSuggestionState": { # A mask that indicates which of the fields on the base Shading have been changed in this suggested change. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in shading have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to the Shading. - }, - "spaceAboveSuggested": True or False, # Indicates if there was a suggested change to space_above. - "spaceBelowSuggested": True or False, # Indicates if there was a suggested change to space_below. - "spacingModeSuggested": True or False, # Indicates if there was a suggested change to spacing_mode. - }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, - }, - ], + "tabProperties": { # Properties of a tab. # The properties of the tab, like ID and title. + "index": 42, # The index of the tab within the parent. + "nestingLevel": 42, # Output only. The depth of the tab within the document. Root-level tabs start at 0. + "parentTabId": "A String", # Optional. The ID of the parent tab. Empty when the current tab is a root-level tab, which means it doesn't have any parents. + "tabId": "A String", # Output only. The ID of the tab. This field can't be changed. + "title": "A String", # The user-visible name of the tab. }, }, - }, - "suggestionsViewMode": "A String", # Output only. The suggestions view mode applied to the document. Note: When editing a document, changes must be based on a document with SUGGESTIONS_INLINE. + ], "title": "A String", # The title of the document. }
diff --git a/docs/dyn/documentai_v1.projects.locations.processors.processorVersions.html b/docs/dyn/documentai_v1.projects.locations.processors.processorVersions.html index beeaefc6202..043d1daa237 100644 --- a/docs/dyn/documentai_v1.projects.locations.processors.processorVersions.html +++ b/docs/dyn/documentai_v1.projects.locations.processors.processorVersions.html @@ -436,6 +436,16 @@

Method Details

"skipNamingValidation": True or False, # If set, we will skip the naming format validation in the schema. So the string values in `DocumentSchema.EntityType.name` and `DocumentSchema.EntityType.Property.name` will not be checked. }, }, + "genAiModelInfo": { # Information about Generative AI model-based processor versions. # Output only. Information about Generative AI model-based processor versions. + "customGenAiModelInfo": { # Information for a custom Generative AI model created by the user. These are created with `Create New Version` in either the `Call foundation model` or `Fine tuning` tabs. # Information for a custom Generative AI model created by the user. + "baseProcessorVersionId": "A String", # The base processor version ID for the custom model. + "customModelType": "A String", # The type of custom model created by the user. + }, + "foundationGenAiModelInfo": { # Information for a pretrained Google-managed foundation model. # Information for a pretrained Google-managed foundation model. + "finetuningAllowed": True or False, # Whether finetuning is allowed for this base processor version. + "minTrainLabeledDocuments": 42, # The minimum number of labeled documents in the training dataset required for finetuning. + }, + }, "googleManaged": True or False, # Output only. Denotes that this `ProcessorVersion` is managed by Google. "kmsKeyName": "A String", # The KMS key name used for encryption. "kmsKeyVersionName": "A String", # The KMS key version with which data is encrypted. @@ -535,6 +545,16 @@

Method Details

"skipNamingValidation": True or False, # If set, we will skip the naming format validation in the schema. So the string values in `DocumentSchema.EntityType.name` and `DocumentSchema.EntityType.Property.name` will not be checked. }, }, + "genAiModelInfo": { # Information about Generative AI model-based processor versions. # Output only. Information about Generative AI model-based processor versions. + "customGenAiModelInfo": { # Information for a custom Generative AI model created by the user. These are created with `Create New Version` in either the `Call foundation model` or `Fine tuning` tabs. # Information for a custom Generative AI model created by the user. + "baseProcessorVersionId": "A String", # The base processor version ID for the custom model. + "customModelType": "A String", # The type of custom model created by the user. + }, + "foundationGenAiModelInfo": { # Information for a pretrained Google-managed foundation model. # Information for a pretrained Google-managed foundation model. + "finetuningAllowed": True or False, # Whether finetuning is allowed for this base processor version. + "minTrainLabeledDocuments": 42, # The minimum number of labeled documents in the training dataset required for finetuning. + }, + }, "googleManaged": True or False, # Output only. Denotes that this `ProcessorVersion` is managed by Google. "kmsKeyName": "A String", # The KMS key name used for encryption. "kmsKeyVersionName": "A String", # The KMS key version with which data is encrypted. @@ -2691,6 +2711,16 @@

Method Details

"skipNamingValidation": True or False, # If set, we will skip the naming format validation in the schema. So the string values in `DocumentSchema.EntityType.name` and `DocumentSchema.EntityType.Property.name` will not be checked. }, }, + "genAiModelInfo": { # Information about Generative AI model-based processor versions. # Output only. Information about Generative AI model-based processor versions. + "customGenAiModelInfo": { # Information for a custom Generative AI model created by the user. These are created with `Create New Version` in either the `Call foundation model` or `Fine tuning` tabs. # Information for a custom Generative AI model created by the user. + "baseProcessorVersionId": "A String", # The base processor version ID for the custom model. + "customModelType": "A String", # The type of custom model created by the user. + }, + "foundationGenAiModelInfo": { # Information for a pretrained Google-managed foundation model. # Information for a pretrained Google-managed foundation model. + "finetuningAllowed": True or False, # Whether finetuning is allowed for this base processor version. + "minTrainLabeledDocuments": 42, # The minimum number of labeled documents in the training dataset required for finetuning. + }, + }, "googleManaged": True or False, # Output only. Denotes that this `ProcessorVersion` is managed by Google. "kmsKeyName": "A String", # The KMS key name used for encryption. "kmsKeyVersionName": "A String", # The KMS key version with which data is encrypted. diff --git a/docs/dyn/documentai_v1beta3.projects.locations.processors.processorVersions.html b/docs/dyn/documentai_v1beta3.projects.locations.processors.processorVersions.html index 398b3c8d3df..25286e20191 100644 --- a/docs/dyn/documentai_v1beta3.projects.locations.processors.processorVersions.html +++ b/docs/dyn/documentai_v1beta3.projects.locations.processors.processorVersions.html @@ -474,6 +474,16 @@

Method Details

"skipNamingValidation": True or False, # If set, we will skip the naming format validation in the schema. So the string values in `DocumentSchema.EntityType.name` and `DocumentSchema.EntityType.Property.name` will not be checked. }, }, + "genAiModelInfo": { # Information about Generative AI model-based processor versions. # Output only. Information about Generative AI model-based processor versions. + "customGenAiModelInfo": { # Information for a custom Generative AI model created by the user. These are created with `Create New Version` in either the `Call foundation model` or `Fine tuning` tabs. # Information for a custom Generative AI model created by the user. + "baseProcessorVersionId": "A String", # The base processor version ID for the custom model. + "customModelType": "A String", # The type of custom model created by the user. + }, + "foundationGenAiModelInfo": { # Information for a pretrained Google-managed foundation model. # Information for a pretrained Google-managed foundation model. + "finetuningAllowed": True or False, # Whether finetuning is allowed for this base processor version. + "minTrainLabeledDocuments": 42, # The minimum number of labeled documents in the training dataset required for finetuning. + }, + }, "googleManaged": True or False, # Output only. Denotes that this `ProcessorVersion` is managed by Google. "kmsKeyName": "A String", # The KMS key name used for encryption. "kmsKeyVersionName": "A String", # The KMS key version with which data is encrypted. @@ -631,6 +641,16 @@

Method Details

"skipNamingValidation": True or False, # If set, we will skip the naming format validation in the schema. So the string values in `DocumentSchema.EntityType.name` and `DocumentSchema.EntityType.Property.name` will not be checked. }, }, + "genAiModelInfo": { # Information about Generative AI model-based processor versions. # Output only. Information about Generative AI model-based processor versions. + "customGenAiModelInfo": { # Information for a custom Generative AI model created by the user. These are created with `Create New Version` in either the `Call foundation model` or `Fine tuning` tabs. # Information for a custom Generative AI model created by the user. + "baseProcessorVersionId": "A String", # The base processor version ID for the custom model. + "customModelType": "A String", # The type of custom model created by the user. + }, + "foundationGenAiModelInfo": { # Information for a pretrained Google-managed foundation model. # Information for a pretrained Google-managed foundation model. + "finetuningAllowed": True or False, # Whether finetuning is allowed for this base processor version. + "minTrainLabeledDocuments": 42, # The minimum number of labeled documents in the training dataset required for finetuning. + }, + }, "googleManaged": True or False, # Output only. Denotes that this `ProcessorVersion` is managed by Google. "kmsKeyName": "A String", # The KMS key name used for encryption. "kmsKeyVersionName": "A String", # The KMS key version with which data is encrypted. @@ -3762,6 +3782,16 @@

Method Details

"skipNamingValidation": True or False, # If set, we will skip the naming format validation in the schema. So the string values in `DocumentSchema.EntityType.name` and `DocumentSchema.EntityType.Property.name` will not be checked. }, }, + "genAiModelInfo": { # Information about Generative AI model-based processor versions. # Output only. Information about Generative AI model-based processor versions. + "customGenAiModelInfo": { # Information for a custom Generative AI model created by the user. These are created with `Create New Version` in either the `Call foundation model` or `Fine tuning` tabs. # Information for a custom Generative AI model created by the user. + "baseProcessorVersionId": "A String", # The base processor version ID for the custom model. + "customModelType": "A String", # The type of custom model created by the user. + }, + "foundationGenAiModelInfo": { # Information for a pretrained Google-managed foundation model. # Information for a pretrained Google-managed foundation model. + "finetuningAllowed": True or False, # Whether finetuning is allowed for this base processor version. + "minTrainLabeledDocuments": 42, # The minimum number of labeled documents in the training dataset required for finetuning. + }, + }, "googleManaged": True or False, # Output only. Denotes that this `ProcessorVersion` is managed by Google. "kmsKeyName": "A String", # The KMS key name used for encryption. "kmsKeyVersionName": "A String", # The KMS key version with which data is encrypted. diff --git a/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html b/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html index 659755b06e2..848116843a9 100644 --- a/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html +++ b/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html @@ -239,7 +239,7 @@

Method Details

"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. }, "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. - "disableAttribution": True or False, # Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation. + "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported. "vertexAiSearch": { # Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/vertex-ai-search-and-conversation # Set to use data source powered by Vertex AI Search. "datastore": "A String", # Required. Fully-qualified Vertex AI Search's datastore resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` }, @@ -477,7 +477,7 @@

Method Details

"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. }, "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. - "disableAttribution": True or False, # Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation. + "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported. "vertexAiSearch": { # Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/vertex-ai-search-and-conversation # Set to use data source powered by Vertex AI Search. "datastore": "A String", # Required. Fully-qualified Vertex AI Search's datastore resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` }, @@ -613,7 +613,6 @@

Method Details

"severityScore": 3.14, # Output only. Harm severity score. }, ], - "score": 3.14, # Output only. Confidence score of the candidate. }, ], "promptFeedback": { # Content filter results for a prompt sent in the request. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. @@ -838,7 +837,7 @@

Method Details

"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. }, "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. - "disableAttribution": True or False, # Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation. + "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported. "vertexAiSearch": { # Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/vertex-ai-search-and-conversation # Set to use data source powered by Vertex AI Search. "datastore": "A String", # Required. Fully-qualified Vertex AI Search's datastore resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` }, @@ -974,7 +973,6 @@

Method Details

"severityScore": 3.14, # Output only. Harm severity score. }, ], - "score": 3.14, # Output only. Confidence score of the candidate. }, ], "promptFeedback": { # Content filter results for a prompt sent in the request. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. diff --git a/docs/dyn/firestore_v1.projects.databases.backupSchedules.html b/docs/dyn/firestore_v1.projects.databases.backupSchedules.html index 11ad3023ad7..5e239dc54c5 100644 --- a/docs/dyn/firestore_v1.projects.databases.backupSchedules.html +++ b/docs/dyn/firestore_v1.projects.databases.backupSchedules.html @@ -110,24 +110,12 @@

Method Details

{ # A backup schedule for a Cloud Firestore Database. This resource is owned by the database it is backing up, and is deleted along with the database. The actual backups are not though. "createTime": "A String", # Output only. The timestamp at which this backup schedule was created and effective since. No backups will be created for this schedule before this time. "dailyRecurrence": { # Represents a recurring schedule that runs every day. The time zone is UTC. # For a schedule that runs daily. - "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Time of the day. The first run scheduled will be either on the same day if schedule creation time precedes time_of_day or the next day otherwise. - "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. - "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. - "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. - "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. - }, }, "name": "A String", # Output only. The unique backup schedule identifier across all locations and databases for the given project. This will be auto-assigned. Format is `projects/{project}/databases/{database}/backupSchedules/{backup_schedule}` - "retention": "A String", # At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. The maximum supported retention is 14 weeks. + "retention": "A String", # At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. The maximum supported retention period is 14 weeks. "updateTime": "A String", # Output only. The timestamp at which this backup schedule was most recently updated. When a backup schedule is first created, this is the same as create_time. "weeklyRecurrence": { # Represents a recurring schedule that runs on a specified day of the week. The time zone is UTC. # For a schedule that runs weekly on a specific day. "day": "A String", # The day of week to run. DAY_OF_WEEK_UNSPECIFIED is not allowed. - "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Time of the day. If day is today, the first run will happen today if schedule creation time precedes time_of_day, and the next week otherwise. - "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. - "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. - "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. - "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. - }, }, } @@ -142,24 +130,12 @@

Method Details

{ # A backup schedule for a Cloud Firestore Database. This resource is owned by the database it is backing up, and is deleted along with the database. The actual backups are not though. "createTime": "A String", # Output only. The timestamp at which this backup schedule was created and effective since. No backups will be created for this schedule before this time. "dailyRecurrence": { # Represents a recurring schedule that runs every day. The time zone is UTC. # For a schedule that runs daily. - "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Time of the day. The first run scheduled will be either on the same day if schedule creation time precedes time_of_day or the next day otherwise. - "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. - "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. - "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. - "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. - }, }, "name": "A String", # Output only. The unique backup schedule identifier across all locations and databases for the given project. This will be auto-assigned. Format is `projects/{project}/databases/{database}/backupSchedules/{backup_schedule}` - "retention": "A String", # At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. The maximum supported retention is 14 weeks. + "retention": "A String", # At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. The maximum supported retention period is 14 weeks. "updateTime": "A String", # Output only. The timestamp at which this backup schedule was most recently updated. When a backup schedule is first created, this is the same as create_time. "weeklyRecurrence": { # Represents a recurring schedule that runs on a specified day of the week. The time zone is UTC. # For a schedule that runs weekly on a specific day. "day": "A String", # The day of week to run. DAY_OF_WEEK_UNSPECIFIED is not allowed. - "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Time of the day. If day is today, the first run will happen today if schedule creation time precedes time_of_day, and the next week otherwise. - "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. - "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. - "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. - "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. - }, }, } @@ -199,24 +175,12 @@

Method Details

{ # A backup schedule for a Cloud Firestore Database. This resource is owned by the database it is backing up, and is deleted along with the database. The actual backups are not though. "createTime": "A String", # Output only. The timestamp at which this backup schedule was created and effective since. No backups will be created for this schedule before this time. "dailyRecurrence": { # Represents a recurring schedule that runs every day. The time zone is UTC. # For a schedule that runs daily. - "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Time of the day. The first run scheduled will be either on the same day if schedule creation time precedes time_of_day or the next day otherwise. - "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. - "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. - "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. - "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. - }, }, "name": "A String", # Output only. The unique backup schedule identifier across all locations and databases for the given project. This will be auto-assigned. Format is `projects/{project}/databases/{database}/backupSchedules/{backup_schedule}` - "retention": "A String", # At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. The maximum supported retention is 14 weeks. + "retention": "A String", # At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. The maximum supported retention period is 14 weeks. "updateTime": "A String", # Output only. The timestamp at which this backup schedule was most recently updated. When a backup schedule is first created, this is the same as create_time. "weeklyRecurrence": { # Represents a recurring schedule that runs on a specified day of the week. The time zone is UTC. # For a schedule that runs weekly on a specific day. "day": "A String", # The day of week to run. DAY_OF_WEEK_UNSPECIFIED is not allowed. - "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Time of the day. If day is today, the first run will happen today if schedule creation time precedes time_of_day, and the next week otherwise. - "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. - "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. - "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. - "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. - }, }, } @@ -240,24 +204,12 @@

Method Details

{ # A backup schedule for a Cloud Firestore Database. This resource is owned by the database it is backing up, and is deleted along with the database. The actual backups are not though. "createTime": "A String", # Output only. The timestamp at which this backup schedule was created and effective since. No backups will be created for this schedule before this time. "dailyRecurrence": { # Represents a recurring schedule that runs every day. The time zone is UTC. # For a schedule that runs daily. - "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Time of the day. The first run scheduled will be either on the same day if schedule creation time precedes time_of_day or the next day otherwise. - "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. - "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. - "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. - "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. - }, }, "name": "A String", # Output only. The unique backup schedule identifier across all locations and databases for the given project. This will be auto-assigned. Format is `projects/{project}/databases/{database}/backupSchedules/{backup_schedule}` - "retention": "A String", # At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. The maximum supported retention is 14 weeks. + "retention": "A String", # At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. The maximum supported retention period is 14 weeks. "updateTime": "A String", # Output only. The timestamp at which this backup schedule was most recently updated. When a backup schedule is first created, this is the same as create_time. "weeklyRecurrence": { # Represents a recurring schedule that runs on a specified day of the week. The time zone is UTC. # For a schedule that runs weekly on a specific day. "day": "A String", # The day of week to run. DAY_OF_WEEK_UNSPECIFIED is not allowed. - "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Time of the day. If day is today, the first run will happen today if schedule creation time precedes time_of_day, and the next week otherwise. - "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. - "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. - "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. - "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. - }, }, }, ], @@ -276,24 +228,12 @@

Method Details

{ # A backup schedule for a Cloud Firestore Database. This resource is owned by the database it is backing up, and is deleted along with the database. The actual backups are not though. "createTime": "A String", # Output only. The timestamp at which this backup schedule was created and effective since. No backups will be created for this schedule before this time. "dailyRecurrence": { # Represents a recurring schedule that runs every day. The time zone is UTC. # For a schedule that runs daily. - "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Time of the day. The first run scheduled will be either on the same day if schedule creation time precedes time_of_day or the next day otherwise. - "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. - "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. - "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. - "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. - }, }, "name": "A String", # Output only. The unique backup schedule identifier across all locations and databases for the given project. This will be auto-assigned. Format is `projects/{project}/databases/{database}/backupSchedules/{backup_schedule}` - "retention": "A String", # At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. The maximum supported retention is 14 weeks. + "retention": "A String", # At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. The maximum supported retention period is 14 weeks. "updateTime": "A String", # Output only. The timestamp at which this backup schedule was most recently updated. When a backup schedule is first created, this is the same as create_time. "weeklyRecurrence": { # Represents a recurring schedule that runs on a specified day of the week. The time zone is UTC. # For a schedule that runs weekly on a specific day. "day": "A String", # The day of week to run. DAY_OF_WEEK_UNSPECIFIED is not allowed. - "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Time of the day. If day is today, the first run will happen today if schedule creation time precedes time_of_day, and the next week otherwise. - "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. - "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. - "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. - "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. - }, }, } @@ -309,24 +249,12 @@

Method Details

{ # A backup schedule for a Cloud Firestore Database. This resource is owned by the database it is backing up, and is deleted along with the database. The actual backups are not though. "createTime": "A String", # Output only. The timestamp at which this backup schedule was created and effective since. No backups will be created for this schedule before this time. "dailyRecurrence": { # Represents a recurring schedule that runs every day. The time zone is UTC. # For a schedule that runs daily. - "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Time of the day. The first run scheduled will be either on the same day if schedule creation time precedes time_of_day or the next day otherwise. - "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. - "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. - "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. - "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. - }, }, "name": "A String", # Output only. The unique backup schedule identifier across all locations and databases for the given project. This will be auto-assigned. Format is `projects/{project}/databases/{database}/backupSchedules/{backup_schedule}` - "retention": "A String", # At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. The maximum supported retention is 14 weeks. + "retention": "A String", # At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. The maximum supported retention period is 14 weeks. "updateTime": "A String", # Output only. The timestamp at which this backup schedule was most recently updated. When a backup schedule is first created, this is the same as create_time. "weeklyRecurrence": { # Represents a recurring schedule that runs on a specified day of the week. The time zone is UTC. # For a schedule that runs weekly on a specific day. "day": "A String", # The day of week to run. DAY_OF_WEEK_UNSPECIFIED is not allowed. - "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Time of the day. If day is today, the first run will happen today if schedule creation time precedes time_of_day, and the next week otherwise. - "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. - "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. - "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. - "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. - }, }, } diff --git a/docs/dyn/firestore_v1.projects.databases.documents.html b/docs/dyn/firestore_v1.projects.databases.documents.html index bd23e9a936c..773353a79ed 100644 --- a/docs/dyn/firestore_v1.projects.databases.documents.html +++ b/docs/dyn/firestore_v1.projects.databases.documents.html @@ -1227,7 +1227,7 @@

Method Details

}, ], }, - "findNearest": { # Nearest Neighbors search config. # Optional. A potential nearest neighbors search. Applies after all other filters and ordering. Finds the closest vector embeddings to the given query vector. + "findNearest": { # Nearest Neighbors search config. The ordering provided by FindNearest supersedes the order_by stage. If multiple documents have the same vector distance, the returned document order is not guaranteed to be stable between queries. # Optional. A potential nearest neighbors search. Applies after all other filters and ordering. Finds the closest vector embeddings to the given query vector. "distanceMeasure": "A String", # Required. The distance measure to use, required. "limit": 42, # Required. The number of nearest neighbors to return. Must be a positive integer of no more than 1000. "queryVector": { # A message that can hold any of the supported value types. # Required. The query vector that we are searching on. Must be a vector of no more than 2048 dimensions. @@ -1503,7 +1503,7 @@

Method Details

}, ], }, - "findNearest": { # Nearest Neighbors search config. # Optional. A potential nearest neighbors search. Applies after all other filters and ordering. Finds the closest vector embeddings to the given query vector. + "findNearest": { # Nearest Neighbors search config. The ordering provided by FindNearest supersedes the order_by stage. If multiple documents have the same vector distance, the returned document order is not guaranteed to be stable between queries. # Optional. A potential nearest neighbors search. Applies after all other filters and ordering. Finds the closest vector embeddings to the given query vector. "distanceMeasure": "A String", # Required. The distance measure to use, required. "limit": 42, # Required. The number of nearest neighbors to return. Must be a positive integer of no more than 1000. "queryVector": { # A message that can hold any of the supported value types. # Required. The query vector that we are searching on. Must be a vector of no more than 2048 dimensions. @@ -1873,7 +1873,7 @@

Method Details

}, ], }, - "findNearest": { # Nearest Neighbors search config. # Optional. A potential nearest neighbors search. Applies after all other filters and ordering. Finds the closest vector embeddings to the given query vector. + "findNearest": { # Nearest Neighbors search config. The ordering provided by FindNearest supersedes the order_by stage. If multiple documents have the same vector distance, the returned document order is not guaranteed to be stable between queries. # Optional. A potential nearest neighbors search. Applies after all other filters and ordering. Finds the closest vector embeddings to the given query vector. "distanceMeasure": "A String", # Required. The distance measure to use, required. "limit": 42, # Required. The number of nearest neighbors to return. Must be a positive integer of no more than 1000. "queryVector": { # A message that can hold any of the supported value types. # Required. The query vector that we are searching on. Must be a vector of no more than 2048 dimensions. @@ -2116,7 +2116,7 @@

Method Details

}, ], }, - "findNearest": { # Nearest Neighbors search config. # Optional. A potential nearest neighbors search. Applies after all other filters and ordering. Finds the closest vector embeddings to the given query vector. + "findNearest": { # Nearest Neighbors search config. The ordering provided by FindNearest supersedes the order_by stage. If multiple documents have the same vector distance, the returned document order is not guaranteed to be stable between queries. # Optional. A potential nearest neighbors search. Applies after all other filters and ordering. Finds the closest vector embeddings to the given query vector. "distanceMeasure": "A String", # Required. The distance measure to use, required. "limit": 42, # Required. The number of nearest neighbors to return. Must be a positive integer of no more than 1000. "queryVector": { # A message that can hold any of the supported value types. # Required. The query vector that we are searching on. Must be a vector of no more than 2048 dimensions. diff --git a/docs/dyn/firestore_v1beta1.projects.databases.documents.html b/docs/dyn/firestore_v1beta1.projects.databases.documents.html index a86bb4b6ef9..6c2d1f0876a 100644 --- a/docs/dyn/firestore_v1beta1.projects.databases.documents.html +++ b/docs/dyn/firestore_v1beta1.projects.databases.documents.html @@ -1227,7 +1227,7 @@

Method Details

}, ], }, - "findNearest": { # Nearest Neighbors search config. # Optional. A potential nearest neighbors search. Applies after all other filters and ordering. Finds the closest vector embeddings to the given query vector. + "findNearest": { # Nearest Neighbors search config. The ordering provided by FindNearest supersedes the order_by stage. If multiple documents have the same vector distance, the returned document order is not guaranteed to be stable between queries. # Optional. A potential nearest neighbors search. Applies after all other filters and ordering. Finds the closest vector embeddings to the given query vector. "distanceMeasure": "A String", # Required. The distance measure to use, required. "limit": 42, # Required. The number of nearest neighbors to return. Must be a positive integer of no more than 1000. "queryVector": { # A message that can hold any of the supported value types. # Required. The query vector that we are searching on. Must be a vector of no more than 2048 dimensions. @@ -1503,7 +1503,7 @@

Method Details

}, ], }, - "findNearest": { # Nearest Neighbors search config. # Optional. A potential nearest neighbors search. Applies after all other filters and ordering. Finds the closest vector embeddings to the given query vector. + "findNearest": { # Nearest Neighbors search config. The ordering provided by FindNearest supersedes the order_by stage. If multiple documents have the same vector distance, the returned document order is not guaranteed to be stable between queries. # Optional. A potential nearest neighbors search. Applies after all other filters and ordering. Finds the closest vector embeddings to the given query vector. "distanceMeasure": "A String", # Required. The distance measure to use, required. "limit": 42, # Required. The number of nearest neighbors to return. Must be a positive integer of no more than 1000. "queryVector": { # A message that can hold any of the supported value types. # Required. The query vector that we are searching on. Must be a vector of no more than 2048 dimensions. @@ -1873,7 +1873,7 @@

Method Details

}, ], }, - "findNearest": { # Nearest Neighbors search config. # Optional. A potential nearest neighbors search. Applies after all other filters and ordering. Finds the closest vector embeddings to the given query vector. + "findNearest": { # Nearest Neighbors search config. The ordering provided by FindNearest supersedes the order_by stage. If multiple documents have the same vector distance, the returned document order is not guaranteed to be stable between queries. # Optional. A potential nearest neighbors search. Applies after all other filters and ordering. Finds the closest vector embeddings to the given query vector. "distanceMeasure": "A String", # Required. The distance measure to use, required. "limit": 42, # Required. The number of nearest neighbors to return. Must be a positive integer of no more than 1000. "queryVector": { # A message that can hold any of the supported value types. # Required. The query vector that we are searching on. Must be a vector of no more than 2048 dimensions. @@ -2116,7 +2116,7 @@

Method Details

}, ], }, - "findNearest": { # Nearest Neighbors search config. # Optional. A potential nearest neighbors search. Applies after all other filters and ordering. Finds the closest vector embeddings to the given query vector. + "findNearest": { # Nearest Neighbors search config. The ordering provided by FindNearest supersedes the order_by stage. If multiple documents have the same vector distance, the returned document order is not guaranteed to be stable between queries. # Optional. A potential nearest neighbors search. Applies after all other filters and ordering. Finds the closest vector embeddings to the given query vector. "distanceMeasure": "A String", # Required. The distance measure to use, required. "limit": 42, # Required. The number of nearest neighbors to return. Must be a positive integer of no more than 1000. "queryVector": { # A message that can hold any of the supported value types. # Required. The query vector that we are searching on. Must be a vector of no more than 2048 dimensions. diff --git a/docs/dyn/healthcare_v1.projects.locations.datasets.dicomStores.html b/docs/dyn/healthcare_v1.projects.locations.datasets.dicomStores.html index 6e194f21b3b..ded0b959705 100644 --- a/docs/dyn/healthcare_v1.projects.locations.datasets.dicomStores.html +++ b/docs/dyn/healthcare_v1.projects.locations.datasets.dicomStores.html @@ -303,7 +303,7 @@

Method Details

}, ], }, - "useRegionalDataProcessing": True or False, # Ensures in-flight data remains in the region of origin during de-identification. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. + "useRegionalDataProcessing": True or False, # Ensures in-flight data remains in the region of origin during de-identification. The default value is false. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. }, "destinationStore": "A String", # Required. The name of the DICOM store to create and write the redacted data to. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. * The destination dataset must exist. * The source dataset and destination dataset must both reside in the same location. De-identifying data across multiple locations is not supported. * The destination DICOM store must not exist. * The caller must have the necessary permissions to create the destination DICOM store. "filterConfig": { # Specifies the filter configuration for DICOM resources. # Filter configuration. diff --git a/docs/dyn/healthcare_v1.projects.locations.datasets.fhirStores.html b/docs/dyn/healthcare_v1.projects.locations.datasets.fhirStores.html index aa7cae266bb..a602b6a6713 100644 --- a/docs/dyn/healthcare_v1.projects.locations.datasets.fhirStores.html +++ b/docs/dyn/healthcare_v1.projects.locations.datasets.fhirStores.html @@ -141,10 +141,10 @@

Method Details

{ # Represents a FHIR store. "complexDataTypeReferenceParsing": "A String", # Enable parsing of references within complex FHIR data types such as Extensions. If this value is set to ENABLED, then features like referential integrity and Bundle reference rewriting apply to all references. If this flag has not been specified the behavior of the FHIR store will not change, references in complex data types will not be parsed. New stores will have this value set to ENABLED after a notification period. Warning: turning on this flag causes processing existing resources to fail if they contain references to non-existent resources. - "defaultSearchHandlingStrict": True or False, # If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. + "defaultSearchHandlingStrict": True or False, # If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. Defaults to false. "disableReferentialIntegrity": True or False, # Immutable. Whether to disable referential integrity in this FHIR store. This field is immutable after FHIR store creation. The default value is false, meaning that the API enforces referential integrity and fails the requests that result in inconsistent state in the FHIR store. When this field is set to true, the API skips referential integrity checks. Consequently, operations that rely on references, such as GetPatientEverything, do not return all the results if broken references exist. - "disableResourceVersioning": True or False, # Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, which is the default behavior, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. - "enableUpdateCreate": True or False, # Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. + "disableResourceVersioning": True or False, # Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. Defaults to false. + "enableUpdateCreate": True or False, # Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. Defaults to false. "labels": { # User-supplied key-value pairs used to organize FHIR stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store. "a_key": "A String", }, @@ -156,15 +156,15 @@

Method Details

"notificationConfigs": [ # Specifies where and whether to send notifications upon changes to a FHIR store. { # Contains the configuration for FHIR notifications. "pubsubTopic": "A String", # The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. The notification is a `PubsubMessage` with the following fields: * `PubsubMessage.Data` contains the resource name. * `PubsubMessage.MessageId` is the ID of this notification. It is guaranteed to be unique within the topic. * `PubsubMessage.PublishTime` is the time when the message was published. Note that notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. The Cloud Healthcare API service account, service-@gcp-sa-healthcare.iam.gserviceaccount.com, must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail (https://cloud.google.com/healthcare-api/docs/permissions-healthcare-api-gcp-products#dicom_fhir_and_hl7v2_store_cloud_pubsub_permissions). If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare-api/docs/how-tos/logging). - "sendFullResource": True or False, # Whether to send full FHIR resource to this Pub/Sub topic. - "sendPreviousResourceOnDelete": True or False, # Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation. + "sendFullResource": True or False, # Whether to send full FHIR resource to this Pub/Sub topic. The default value is false. + "sendPreviousResourceOnDelete": True or False, # Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. The default value is false. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation. }, ], "streamConfigs": [ # A list of streaming configs that configure the destinations of streaming export for every resource mutation in this FHIR store. Each store is allowed to have up to 10 streaming configs. After a new config is added, the next resource mutation is streamed to the new location in addition to the existing ones. When a location is removed from the list, the server stops streaming to that location. Before adding a new config, you must add the required [`bigquery.dataEditor`](https://cloud.google.com/bigquery/docs/access-control#bigquery.dataEditor) role to your project's **Cloud Healthcare Service Agent** [service account](https://cloud.google.com/iam/docs/service-accounts). Some lag (typically on the order of dozens of seconds) is expected before the results show up in the streaming destination. { # Contains configuration for streaming FHIR export. "bigqueryDestination": { # The configuration for exporting to BigQuery. # The destination BigQuery structure that contains both the dataset location and corresponding schema config. The output is organized in one table per resource type. The server reuses the existing tables (if any) that are named after the resource types. For example, "Patient", "Observation". When there is no existing table for a given resource type, the server attempts to create one. When a table schema doesn't align with the schema config, either because of existing incompatible schema or out of band incompatible modification, the server does not stream in new data. BigQuery imposes a 1 MB limit on streaming insert row size, therefore any resource mutation that generates more than 1 MB of BigQuery data is not streamed. One resolution in this case is to delete the incompatible table and let the server recreate one, though the newly created table only contains data after the table recreation. Results are written to BigQuery tables according to the parameters in BigQueryDestination.WriteDisposition. Different versions of the same resource are distinguishable by the meta.versionId and meta.lastUpdated columns. The operation (CREATE/UPDATE/DELETE) that results in the new version is recorded in the meta.tag. The tables contain all historical resource versions since streaming was enabled. For query convenience, the server also creates one view per table of the same name containing only the current resource version. The streamed data in the BigQuery dataset is not guaranteed to be completely unique. The combination of the id and meta.versionId columns should ideally identify a single unique row. But in rare cases, duplicates may exist. At query time, users may use the SQL select statement to keep only one of the duplicate rows given an id and meta.versionId pair. Alternatively, the server created view mentioned above also filters out duplicates. If a resource mutation cannot be streamed to BigQuery, errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). "datasetUri": "A String", # BigQuery URI to an existing dataset, up to 2000 characters long, in the format `bq://projectId.bqDatasetId`. - "force": True or False, # If this flag is `TRUE`, all tables are deleted from the dataset before the new exported tables are written. If the flag is not set and the destination dataset contains tables, the export call returns an error. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE. + "force": True or False, # The default value is false. If this flag is `TRUE`, all tables are deleted from the dataset before the new exported tables are written. If the flag is not set and the destination dataset contains tables, the export call returns an error. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE. "schemaConfig": { # Configuration for the FHIR BigQuery schema. Determines how the server generates the schema. # The configuration for the exported BigQuery schema. "lastUpdatedPartitionConfig": { # Configuration for FHIR BigQuery time-partitioned tables. # The configuration for exported BigQuery tables to be partitioned by FHIR resource's last updated time column. "expirationMs": "A String", # Number of milliseconds for which to keep the storage for a partition. @@ -266,7 +266,7 @@

Method Details

}, ], }, - "useRegionalDataProcessing": True or False, # Ensures in-flight data remains in the region of origin during de-identification. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. + "useRegionalDataProcessing": True or False, # Ensures in-flight data remains in the region of origin during de-identification. The default value is false. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. }, "store": "A String", # The full resource name of a Cloud Healthcare FHIR store, for example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. }, @@ -276,10 +276,10 @@

Method Details

}, ], "validationConfig": { # Contains the configuration for FHIR profiles and validation. # Configuration for how to validate incoming FHIR resources against configured profiles. - "disableFhirpathValidation": True or False, # Whether to disable FHIRPath validation for incoming resources. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. - "disableProfileValidation": True or False, # Whether to disable profile validation for this FHIR store. Set this to true to disable checking incoming resources for conformance against structure definitions in this FHIR store. - "disableReferenceTypeValidation": True or False, # Whether to disable reference type validation for incoming resources. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. - "disableRequiredFieldValidation": True or False, # Whether to disable required fields validation for incoming resources. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableFhirpathValidation": True or False, # Whether to disable FHIRPath validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableProfileValidation": True or False, # Whether to disable profile validation for this FHIR store. The default value is false. Set this to true to disable checking incoming resources for conformance against structure definitions in this FHIR store. + "disableReferenceTypeValidation": True or False, # Whether to disable reference type validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableRequiredFieldValidation": True or False, # Whether to disable required fields validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. "enabledImplementationGuides": [ # A list of implementation guide URLs in this FHIR store that are used to configure the profiles to use for validation. For example, to use the US Core profiles for validation, set `enabled_implementation_guides` to `["http://hl7.org/fhir/us/core/ImplementationGuide/ig"]`. If `enabled_implementation_guides` is empty or omitted, then incoming resources are only required to conform to the base FHIR profiles. Otherwise, a resource must conform to at least one profile listed in the `global` property of one of the enabled ImplementationGuides. The Cloud Healthcare API does not currently enforce all of the rules in a StructureDefinition. The following rules are supported: - min/max - minValue/maxValue - maxLength - type - fixed[x] - pattern[x] on simple types - slicing, when using "value" as the discriminator type When a URL cannot be resolved (for example, in a type assertion), the server does not return an error. "A String", ], @@ -298,10 +298,10 @@

Method Details

{ # Represents a FHIR store. "complexDataTypeReferenceParsing": "A String", # Enable parsing of references within complex FHIR data types such as Extensions. If this value is set to ENABLED, then features like referential integrity and Bundle reference rewriting apply to all references. If this flag has not been specified the behavior of the FHIR store will not change, references in complex data types will not be parsed. New stores will have this value set to ENABLED after a notification period. Warning: turning on this flag causes processing existing resources to fail if they contain references to non-existent resources. - "defaultSearchHandlingStrict": True or False, # If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. + "defaultSearchHandlingStrict": True or False, # If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. Defaults to false. "disableReferentialIntegrity": True or False, # Immutable. Whether to disable referential integrity in this FHIR store. This field is immutable after FHIR store creation. The default value is false, meaning that the API enforces referential integrity and fails the requests that result in inconsistent state in the FHIR store. When this field is set to true, the API skips referential integrity checks. Consequently, operations that rely on references, such as GetPatientEverything, do not return all the results if broken references exist. - "disableResourceVersioning": True or False, # Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, which is the default behavior, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. - "enableUpdateCreate": True or False, # Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. + "disableResourceVersioning": True or False, # Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. Defaults to false. + "enableUpdateCreate": True or False, # Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. Defaults to false. "labels": { # User-supplied key-value pairs used to organize FHIR stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store. "a_key": "A String", }, @@ -313,15 +313,15 @@

Method Details

"notificationConfigs": [ # Specifies where and whether to send notifications upon changes to a FHIR store. { # Contains the configuration for FHIR notifications. "pubsubTopic": "A String", # The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. The notification is a `PubsubMessage` with the following fields: * `PubsubMessage.Data` contains the resource name. * `PubsubMessage.MessageId` is the ID of this notification. It is guaranteed to be unique within the topic. * `PubsubMessage.PublishTime` is the time when the message was published. Note that notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. The Cloud Healthcare API service account, service-@gcp-sa-healthcare.iam.gserviceaccount.com, must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail (https://cloud.google.com/healthcare-api/docs/permissions-healthcare-api-gcp-products#dicom_fhir_and_hl7v2_store_cloud_pubsub_permissions). If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare-api/docs/how-tos/logging). - "sendFullResource": True or False, # Whether to send full FHIR resource to this Pub/Sub topic. - "sendPreviousResourceOnDelete": True or False, # Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation. + "sendFullResource": True or False, # Whether to send full FHIR resource to this Pub/Sub topic. The default value is false. + "sendPreviousResourceOnDelete": True or False, # Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. The default value is false. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation. }, ], "streamConfigs": [ # A list of streaming configs that configure the destinations of streaming export for every resource mutation in this FHIR store. Each store is allowed to have up to 10 streaming configs. After a new config is added, the next resource mutation is streamed to the new location in addition to the existing ones. When a location is removed from the list, the server stops streaming to that location. Before adding a new config, you must add the required [`bigquery.dataEditor`](https://cloud.google.com/bigquery/docs/access-control#bigquery.dataEditor) role to your project's **Cloud Healthcare Service Agent** [service account](https://cloud.google.com/iam/docs/service-accounts). Some lag (typically on the order of dozens of seconds) is expected before the results show up in the streaming destination. { # Contains configuration for streaming FHIR export. "bigqueryDestination": { # The configuration for exporting to BigQuery. # The destination BigQuery structure that contains both the dataset location and corresponding schema config. The output is organized in one table per resource type. The server reuses the existing tables (if any) that are named after the resource types. For example, "Patient", "Observation". When there is no existing table for a given resource type, the server attempts to create one. When a table schema doesn't align with the schema config, either because of existing incompatible schema or out of band incompatible modification, the server does not stream in new data. BigQuery imposes a 1 MB limit on streaming insert row size, therefore any resource mutation that generates more than 1 MB of BigQuery data is not streamed. One resolution in this case is to delete the incompatible table and let the server recreate one, though the newly created table only contains data after the table recreation. Results are written to BigQuery tables according to the parameters in BigQueryDestination.WriteDisposition. Different versions of the same resource are distinguishable by the meta.versionId and meta.lastUpdated columns. The operation (CREATE/UPDATE/DELETE) that results in the new version is recorded in the meta.tag. The tables contain all historical resource versions since streaming was enabled. For query convenience, the server also creates one view per table of the same name containing only the current resource version. The streamed data in the BigQuery dataset is not guaranteed to be completely unique. The combination of the id and meta.versionId columns should ideally identify a single unique row. But in rare cases, duplicates may exist. At query time, users may use the SQL select statement to keep only one of the duplicate rows given an id and meta.versionId pair. Alternatively, the server created view mentioned above also filters out duplicates. If a resource mutation cannot be streamed to BigQuery, errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). "datasetUri": "A String", # BigQuery URI to an existing dataset, up to 2000 characters long, in the format `bq://projectId.bqDatasetId`. - "force": True or False, # If this flag is `TRUE`, all tables are deleted from the dataset before the new exported tables are written. If the flag is not set and the destination dataset contains tables, the export call returns an error. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE. + "force": True or False, # The default value is false. If this flag is `TRUE`, all tables are deleted from the dataset before the new exported tables are written. If the flag is not set and the destination dataset contains tables, the export call returns an error. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE. "schemaConfig": { # Configuration for the FHIR BigQuery schema. Determines how the server generates the schema. # The configuration for the exported BigQuery schema. "lastUpdatedPartitionConfig": { # Configuration for FHIR BigQuery time-partitioned tables. # The configuration for exported BigQuery tables to be partitioned by FHIR resource's last updated time column. "expirationMs": "A String", # Number of milliseconds for which to keep the storage for a partition. @@ -423,7 +423,7 @@

Method Details

}, ], }, - "useRegionalDataProcessing": True or False, # Ensures in-flight data remains in the region of origin during de-identification. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. + "useRegionalDataProcessing": True or False, # Ensures in-flight data remains in the region of origin during de-identification. The default value is false. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. }, "store": "A String", # The full resource name of a Cloud Healthcare FHIR store, for example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. }, @@ -433,10 +433,10 @@

Method Details

}, ], "validationConfig": { # Contains the configuration for FHIR profiles and validation. # Configuration for how to validate incoming FHIR resources against configured profiles. - "disableFhirpathValidation": True or False, # Whether to disable FHIRPath validation for incoming resources. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. - "disableProfileValidation": True or False, # Whether to disable profile validation for this FHIR store. Set this to true to disable checking incoming resources for conformance against structure definitions in this FHIR store. - "disableReferenceTypeValidation": True or False, # Whether to disable reference type validation for incoming resources. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. - "disableRequiredFieldValidation": True or False, # Whether to disable required fields validation for incoming resources. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableFhirpathValidation": True or False, # Whether to disable FHIRPath validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableProfileValidation": True or False, # Whether to disable profile validation for this FHIR store. The default value is false. Set this to true to disable checking incoming resources for conformance against structure definitions in this FHIR store. + "disableReferenceTypeValidation": True or False, # Whether to disable reference type validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableRequiredFieldValidation": True or False, # Whether to disable required fields validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. "enabledImplementationGuides": [ # A list of implementation guide URLs in this FHIR store that are used to configure the profiles to use for validation. For example, to use the US Core profiles for validation, set `enabled_implementation_guides` to `["http://hl7.org/fhir/us/core/ImplementationGuide/ig"]`. If `enabled_implementation_guides` is empty or omitted, then incoming resources are only required to conform to the base FHIR profiles. Otherwise, a resource must conform to at least one profile listed in the `global` property of one of the enabled ImplementationGuides. The Cloud Healthcare API does not currently enforce all of the rules in a StructureDefinition. The following rules are supported: - min/max - minValue/maxValue - maxLength - type - fixed[x] - pattern[x] on simple types - slicing, when using "value" as the discriminator type When a URL cannot be resolved (for example, in a type assertion), the server does not return an error. "A String", ], @@ -545,7 +545,7 @@

Method Details

}, ], }, - "useRegionalDataProcessing": True or False, # Ensures in-flight data remains in the region of origin during de-identification. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. + "useRegionalDataProcessing": True or False, # Ensures in-flight data remains in the region of origin during de-identification. The default value is false. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. }, "destinationStore": "A String", # Required. The name of the FHIR store to create and write the redacted data to. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. * The destination dataset must exist. * The source dataset and destination dataset must both reside in the same location. De-identifying data across multiple locations is not supported. * The destination FHIR store must exist. * The caller must have the healthcare.fhirResources.update permission to write to the destination FHIR store. "gcsConfigUri": "A String", # Cloud Storage location to read the JSON cloud.healthcare.deidentify.DeidentifyConfig from, overriding the default config. Must be of the form `gs://{bucket_id}/path/to/object`. The Cloud Storage location must grant the Cloud IAM role `roles/storage.objectViewer` to the project's Cloud Healthcare Service Agent service account. Only one of `config` and `gcs_config_uri` can be specified. @@ -620,7 +620,7 @@

Method Details

"_type": "A String", # String of comma-delimited FHIR resource types. If provided, only resources of the specified resource type(s) are exported. "bigqueryDestination": { # The configuration for exporting to BigQuery. # The BigQuery output destination. The Cloud Healthcare Service Agent requires two IAM roles on the BigQuery location: `roles/bigquery.dataEditor` and `roles/bigquery.jobUser`. The output is one BigQuery table per resource type. Unlike when setting `BigQueryDestination` for `StreamConfig`, `ExportResources` does not create BigQuery views. "datasetUri": "A String", # BigQuery URI to an existing dataset, up to 2000 characters long, in the format `bq://projectId.bqDatasetId`. - "force": True or False, # If this flag is `TRUE`, all tables are deleted from the dataset before the new exported tables are written. If the flag is not set and the destination dataset contains tables, the export call returns an error. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE. + "force": True or False, # The default value is false. If this flag is `TRUE`, all tables are deleted from the dataset before the new exported tables are written. If the flag is not set and the destination dataset contains tables, the export call returns an error. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE. "schemaConfig": { # Configuration for the FHIR BigQuery schema. Determines how the server generates the schema. # The configuration for the exported BigQuery schema. "lastUpdatedPartitionConfig": { # Configuration for FHIR BigQuery time-partitioned tables. # The configuration for exported BigQuery tables to be partitioned by FHIR resource's last updated time column. "expirationMs": "A String", # Number of milliseconds for which to keep the storage for a partition. @@ -681,10 +681,10 @@

Method Details

{ # Represents a FHIR store. "complexDataTypeReferenceParsing": "A String", # Enable parsing of references within complex FHIR data types such as Extensions. If this value is set to ENABLED, then features like referential integrity and Bundle reference rewriting apply to all references. If this flag has not been specified the behavior of the FHIR store will not change, references in complex data types will not be parsed. New stores will have this value set to ENABLED after a notification period. Warning: turning on this flag causes processing existing resources to fail if they contain references to non-existent resources. - "defaultSearchHandlingStrict": True or False, # If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. + "defaultSearchHandlingStrict": True or False, # If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. Defaults to false. "disableReferentialIntegrity": True or False, # Immutable. Whether to disable referential integrity in this FHIR store. This field is immutable after FHIR store creation. The default value is false, meaning that the API enforces referential integrity and fails the requests that result in inconsistent state in the FHIR store. When this field is set to true, the API skips referential integrity checks. Consequently, operations that rely on references, such as GetPatientEverything, do not return all the results if broken references exist. - "disableResourceVersioning": True or False, # Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, which is the default behavior, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. - "enableUpdateCreate": True or False, # Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. + "disableResourceVersioning": True or False, # Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. Defaults to false. + "enableUpdateCreate": True or False, # Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. Defaults to false. "labels": { # User-supplied key-value pairs used to organize FHIR stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store. "a_key": "A String", }, @@ -696,15 +696,15 @@

Method Details

"notificationConfigs": [ # Specifies where and whether to send notifications upon changes to a FHIR store. { # Contains the configuration for FHIR notifications. "pubsubTopic": "A String", # The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. The notification is a `PubsubMessage` with the following fields: * `PubsubMessage.Data` contains the resource name. * `PubsubMessage.MessageId` is the ID of this notification. It is guaranteed to be unique within the topic. * `PubsubMessage.PublishTime` is the time when the message was published. Note that notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. The Cloud Healthcare API service account, service-@gcp-sa-healthcare.iam.gserviceaccount.com, must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail (https://cloud.google.com/healthcare-api/docs/permissions-healthcare-api-gcp-products#dicom_fhir_and_hl7v2_store_cloud_pubsub_permissions). If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare-api/docs/how-tos/logging). - "sendFullResource": True or False, # Whether to send full FHIR resource to this Pub/Sub topic. - "sendPreviousResourceOnDelete": True or False, # Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation. + "sendFullResource": True or False, # Whether to send full FHIR resource to this Pub/Sub topic. The default value is false. + "sendPreviousResourceOnDelete": True or False, # Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. The default value is false. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation. }, ], "streamConfigs": [ # A list of streaming configs that configure the destinations of streaming export for every resource mutation in this FHIR store. Each store is allowed to have up to 10 streaming configs. After a new config is added, the next resource mutation is streamed to the new location in addition to the existing ones. When a location is removed from the list, the server stops streaming to that location. Before adding a new config, you must add the required [`bigquery.dataEditor`](https://cloud.google.com/bigquery/docs/access-control#bigquery.dataEditor) role to your project's **Cloud Healthcare Service Agent** [service account](https://cloud.google.com/iam/docs/service-accounts). Some lag (typically on the order of dozens of seconds) is expected before the results show up in the streaming destination. { # Contains configuration for streaming FHIR export. "bigqueryDestination": { # The configuration for exporting to BigQuery. # The destination BigQuery structure that contains both the dataset location and corresponding schema config. The output is organized in one table per resource type. The server reuses the existing tables (if any) that are named after the resource types. For example, "Patient", "Observation". When there is no existing table for a given resource type, the server attempts to create one. When a table schema doesn't align with the schema config, either because of existing incompatible schema or out of band incompatible modification, the server does not stream in new data. BigQuery imposes a 1 MB limit on streaming insert row size, therefore any resource mutation that generates more than 1 MB of BigQuery data is not streamed. One resolution in this case is to delete the incompatible table and let the server recreate one, though the newly created table only contains data after the table recreation. Results are written to BigQuery tables according to the parameters in BigQueryDestination.WriteDisposition. Different versions of the same resource are distinguishable by the meta.versionId and meta.lastUpdated columns. The operation (CREATE/UPDATE/DELETE) that results in the new version is recorded in the meta.tag. The tables contain all historical resource versions since streaming was enabled. For query convenience, the server also creates one view per table of the same name containing only the current resource version. The streamed data in the BigQuery dataset is not guaranteed to be completely unique. The combination of the id and meta.versionId columns should ideally identify a single unique row. But in rare cases, duplicates may exist. At query time, users may use the SQL select statement to keep only one of the duplicate rows given an id and meta.versionId pair. Alternatively, the server created view mentioned above also filters out duplicates. If a resource mutation cannot be streamed to BigQuery, errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). "datasetUri": "A String", # BigQuery URI to an existing dataset, up to 2000 characters long, in the format `bq://projectId.bqDatasetId`. - "force": True or False, # If this flag is `TRUE`, all tables are deleted from the dataset before the new exported tables are written. If the flag is not set and the destination dataset contains tables, the export call returns an error. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE. + "force": True or False, # The default value is false. If this flag is `TRUE`, all tables are deleted from the dataset before the new exported tables are written. If the flag is not set and the destination dataset contains tables, the export call returns an error. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE. "schemaConfig": { # Configuration for the FHIR BigQuery schema. Determines how the server generates the schema. # The configuration for the exported BigQuery schema. "lastUpdatedPartitionConfig": { # Configuration for FHIR BigQuery time-partitioned tables. # The configuration for exported BigQuery tables to be partitioned by FHIR resource's last updated time column. "expirationMs": "A String", # Number of milliseconds for which to keep the storage for a partition. @@ -806,7 +806,7 @@

Method Details

}, ], }, - "useRegionalDataProcessing": True or False, # Ensures in-flight data remains in the region of origin during de-identification. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. + "useRegionalDataProcessing": True or False, # Ensures in-flight data remains in the region of origin during de-identification. The default value is false. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. }, "store": "A String", # The full resource name of a Cloud Healthcare FHIR store, for example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. }, @@ -816,10 +816,10 @@

Method Details

}, ], "validationConfig": { # Contains the configuration for FHIR profiles and validation. # Configuration for how to validate incoming FHIR resources against configured profiles. - "disableFhirpathValidation": True or False, # Whether to disable FHIRPath validation for incoming resources. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. - "disableProfileValidation": True or False, # Whether to disable profile validation for this FHIR store. Set this to true to disable checking incoming resources for conformance against structure definitions in this FHIR store. - "disableReferenceTypeValidation": True or False, # Whether to disable reference type validation for incoming resources. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. - "disableRequiredFieldValidation": True or False, # Whether to disable required fields validation for incoming resources. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableFhirpathValidation": True or False, # Whether to disable FHIRPath validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableProfileValidation": True or False, # Whether to disable profile validation for this FHIR store. The default value is false. Set this to true to disable checking incoming resources for conformance against structure definitions in this FHIR store. + "disableReferenceTypeValidation": True or False, # Whether to disable reference type validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableRequiredFieldValidation": True or False, # Whether to disable required fields validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. "enabledImplementationGuides": [ # A list of implementation guide URLs in this FHIR store that are used to configure the profiles to use for validation. For example, to use the US Core profiles for validation, set `enabled_implementation_guides` to `["http://hl7.org/fhir/us/core/ImplementationGuide/ig"]`. If `enabled_implementation_guides` is empty or omitted, then incoming resources are only required to conform to the base FHIR profiles. Otherwise, a resource must conform to at least one profile listed in the `global` property of one of the enabled ImplementationGuides. The Cloud Healthcare API does not currently enforce all of the rules in a StructureDefinition. The following rules are supported: - min/max - minValue/maxValue - maxLength - type - fixed[x] - pattern[x] on simple types - slicing, when using "value" as the discriminator type When a URL cannot be resolved (for example, in a type assertion), the server does not return an error. "A String", ], @@ -968,10 +968,10 @@

Method Details

"fhirStores": [ # The returned FHIR stores. Won't be more FHIR stores than the value of page_size in the request. { # Represents a FHIR store. "complexDataTypeReferenceParsing": "A String", # Enable parsing of references within complex FHIR data types such as Extensions. If this value is set to ENABLED, then features like referential integrity and Bundle reference rewriting apply to all references. If this flag has not been specified the behavior of the FHIR store will not change, references in complex data types will not be parsed. New stores will have this value set to ENABLED after a notification period. Warning: turning on this flag causes processing existing resources to fail if they contain references to non-existent resources. - "defaultSearchHandlingStrict": True or False, # If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. + "defaultSearchHandlingStrict": True or False, # If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. Defaults to false. "disableReferentialIntegrity": True or False, # Immutable. Whether to disable referential integrity in this FHIR store. This field is immutable after FHIR store creation. The default value is false, meaning that the API enforces referential integrity and fails the requests that result in inconsistent state in the FHIR store. When this field is set to true, the API skips referential integrity checks. Consequently, operations that rely on references, such as GetPatientEverything, do not return all the results if broken references exist. - "disableResourceVersioning": True or False, # Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, which is the default behavior, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. - "enableUpdateCreate": True or False, # Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. + "disableResourceVersioning": True or False, # Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. Defaults to false. + "enableUpdateCreate": True or False, # Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. Defaults to false. "labels": { # User-supplied key-value pairs used to organize FHIR stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store. "a_key": "A String", }, @@ -983,15 +983,15 @@

Method Details

"notificationConfigs": [ # Specifies where and whether to send notifications upon changes to a FHIR store. { # Contains the configuration for FHIR notifications. "pubsubTopic": "A String", # The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. The notification is a `PubsubMessage` with the following fields: * `PubsubMessage.Data` contains the resource name. * `PubsubMessage.MessageId` is the ID of this notification. It is guaranteed to be unique within the topic. * `PubsubMessage.PublishTime` is the time when the message was published. Note that notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. The Cloud Healthcare API service account, service-@gcp-sa-healthcare.iam.gserviceaccount.com, must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail (https://cloud.google.com/healthcare-api/docs/permissions-healthcare-api-gcp-products#dicom_fhir_and_hl7v2_store_cloud_pubsub_permissions). If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare-api/docs/how-tos/logging). - "sendFullResource": True or False, # Whether to send full FHIR resource to this Pub/Sub topic. - "sendPreviousResourceOnDelete": True or False, # Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation. + "sendFullResource": True or False, # Whether to send full FHIR resource to this Pub/Sub topic. The default value is false. + "sendPreviousResourceOnDelete": True or False, # Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. The default value is false. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation. }, ], "streamConfigs": [ # A list of streaming configs that configure the destinations of streaming export for every resource mutation in this FHIR store. Each store is allowed to have up to 10 streaming configs. After a new config is added, the next resource mutation is streamed to the new location in addition to the existing ones. When a location is removed from the list, the server stops streaming to that location. Before adding a new config, you must add the required [`bigquery.dataEditor`](https://cloud.google.com/bigquery/docs/access-control#bigquery.dataEditor) role to your project's **Cloud Healthcare Service Agent** [service account](https://cloud.google.com/iam/docs/service-accounts). Some lag (typically on the order of dozens of seconds) is expected before the results show up in the streaming destination. { # Contains configuration for streaming FHIR export. "bigqueryDestination": { # The configuration for exporting to BigQuery. # The destination BigQuery structure that contains both the dataset location and corresponding schema config. The output is organized in one table per resource type. The server reuses the existing tables (if any) that are named after the resource types. For example, "Patient", "Observation". When there is no existing table for a given resource type, the server attempts to create one. When a table schema doesn't align with the schema config, either because of existing incompatible schema or out of band incompatible modification, the server does not stream in new data. BigQuery imposes a 1 MB limit on streaming insert row size, therefore any resource mutation that generates more than 1 MB of BigQuery data is not streamed. One resolution in this case is to delete the incompatible table and let the server recreate one, though the newly created table only contains data after the table recreation. Results are written to BigQuery tables according to the parameters in BigQueryDestination.WriteDisposition. Different versions of the same resource are distinguishable by the meta.versionId and meta.lastUpdated columns. The operation (CREATE/UPDATE/DELETE) that results in the new version is recorded in the meta.tag. The tables contain all historical resource versions since streaming was enabled. For query convenience, the server also creates one view per table of the same name containing only the current resource version. The streamed data in the BigQuery dataset is not guaranteed to be completely unique. The combination of the id and meta.versionId columns should ideally identify a single unique row. But in rare cases, duplicates may exist. At query time, users may use the SQL select statement to keep only one of the duplicate rows given an id and meta.versionId pair. Alternatively, the server created view mentioned above also filters out duplicates. If a resource mutation cannot be streamed to BigQuery, errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). "datasetUri": "A String", # BigQuery URI to an existing dataset, up to 2000 characters long, in the format `bq://projectId.bqDatasetId`. - "force": True or False, # If this flag is `TRUE`, all tables are deleted from the dataset before the new exported tables are written. If the flag is not set and the destination dataset contains tables, the export call returns an error. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE. + "force": True or False, # The default value is false. If this flag is `TRUE`, all tables are deleted from the dataset before the new exported tables are written. If the flag is not set and the destination dataset contains tables, the export call returns an error. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE. "schemaConfig": { # Configuration for the FHIR BigQuery schema. Determines how the server generates the schema. # The configuration for the exported BigQuery schema. "lastUpdatedPartitionConfig": { # Configuration for FHIR BigQuery time-partitioned tables. # The configuration for exported BigQuery tables to be partitioned by FHIR resource's last updated time column. "expirationMs": "A String", # Number of milliseconds for which to keep the storage for a partition. @@ -1093,7 +1093,7 @@

Method Details

}, ], }, - "useRegionalDataProcessing": True or False, # Ensures in-flight data remains in the region of origin during de-identification. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. + "useRegionalDataProcessing": True or False, # Ensures in-flight data remains in the region of origin during de-identification. The default value is false. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. }, "store": "A String", # The full resource name of a Cloud Healthcare FHIR store, for example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. }, @@ -1103,10 +1103,10 @@

Method Details

}, ], "validationConfig": { # Contains the configuration for FHIR profiles and validation. # Configuration for how to validate incoming FHIR resources against configured profiles. - "disableFhirpathValidation": True or False, # Whether to disable FHIRPath validation for incoming resources. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. - "disableProfileValidation": True or False, # Whether to disable profile validation for this FHIR store. Set this to true to disable checking incoming resources for conformance against structure definitions in this FHIR store. - "disableReferenceTypeValidation": True or False, # Whether to disable reference type validation for incoming resources. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. - "disableRequiredFieldValidation": True or False, # Whether to disable required fields validation for incoming resources. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableFhirpathValidation": True or False, # Whether to disable FHIRPath validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableProfileValidation": True or False, # Whether to disable profile validation for this FHIR store. The default value is false. Set this to true to disable checking incoming resources for conformance against structure definitions in this FHIR store. + "disableReferenceTypeValidation": True or False, # Whether to disable reference type validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableRequiredFieldValidation": True or False, # Whether to disable required fields validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. "enabledImplementationGuides": [ # A list of implementation guide URLs in this FHIR store that are used to configure the profiles to use for validation. For example, to use the US Core profiles for validation, set `enabled_implementation_guides` to `["http://hl7.org/fhir/us/core/ImplementationGuide/ig"]`. If `enabled_implementation_guides` is empty or omitted, then incoming resources are only required to conform to the base FHIR profiles. Otherwise, a resource must conform to at least one profile listed in the `global` property of one of the enabled ImplementationGuides. The Cloud Healthcare API does not currently enforce all of the rules in a StructureDefinition. The following rules are supported: - min/max - minValue/maxValue - maxLength - type - fixed[x] - pattern[x] on simple types - slicing, when using "value" as the discriminator type When a URL cannot be resolved (for example, in a type assertion), the server does not return an error. "A String", ], @@ -1143,10 +1143,10 @@

Method Details

{ # Represents a FHIR store. "complexDataTypeReferenceParsing": "A String", # Enable parsing of references within complex FHIR data types such as Extensions. If this value is set to ENABLED, then features like referential integrity and Bundle reference rewriting apply to all references. If this flag has not been specified the behavior of the FHIR store will not change, references in complex data types will not be parsed. New stores will have this value set to ENABLED after a notification period. Warning: turning on this flag causes processing existing resources to fail if they contain references to non-existent resources. - "defaultSearchHandlingStrict": True or False, # If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. + "defaultSearchHandlingStrict": True or False, # If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. Defaults to false. "disableReferentialIntegrity": True or False, # Immutable. Whether to disable referential integrity in this FHIR store. This field is immutable after FHIR store creation. The default value is false, meaning that the API enforces referential integrity and fails the requests that result in inconsistent state in the FHIR store. When this field is set to true, the API skips referential integrity checks. Consequently, operations that rely on references, such as GetPatientEverything, do not return all the results if broken references exist. - "disableResourceVersioning": True or False, # Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, which is the default behavior, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. - "enableUpdateCreate": True or False, # Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. + "disableResourceVersioning": True or False, # Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. Defaults to false. + "enableUpdateCreate": True or False, # Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. Defaults to false. "labels": { # User-supplied key-value pairs used to organize FHIR stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store. "a_key": "A String", }, @@ -1158,15 +1158,15 @@

Method Details

"notificationConfigs": [ # Specifies where and whether to send notifications upon changes to a FHIR store. { # Contains the configuration for FHIR notifications. "pubsubTopic": "A String", # The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. The notification is a `PubsubMessage` with the following fields: * `PubsubMessage.Data` contains the resource name. * `PubsubMessage.MessageId` is the ID of this notification. It is guaranteed to be unique within the topic. * `PubsubMessage.PublishTime` is the time when the message was published. Note that notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. The Cloud Healthcare API service account, service-@gcp-sa-healthcare.iam.gserviceaccount.com, must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail (https://cloud.google.com/healthcare-api/docs/permissions-healthcare-api-gcp-products#dicom_fhir_and_hl7v2_store_cloud_pubsub_permissions). If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare-api/docs/how-tos/logging). - "sendFullResource": True or False, # Whether to send full FHIR resource to this Pub/Sub topic. - "sendPreviousResourceOnDelete": True or False, # Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation. + "sendFullResource": True or False, # Whether to send full FHIR resource to this Pub/Sub topic. The default value is false. + "sendPreviousResourceOnDelete": True or False, # Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. The default value is false. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation. }, ], "streamConfigs": [ # A list of streaming configs that configure the destinations of streaming export for every resource mutation in this FHIR store. Each store is allowed to have up to 10 streaming configs. After a new config is added, the next resource mutation is streamed to the new location in addition to the existing ones. When a location is removed from the list, the server stops streaming to that location. Before adding a new config, you must add the required [`bigquery.dataEditor`](https://cloud.google.com/bigquery/docs/access-control#bigquery.dataEditor) role to your project's **Cloud Healthcare Service Agent** [service account](https://cloud.google.com/iam/docs/service-accounts). Some lag (typically on the order of dozens of seconds) is expected before the results show up in the streaming destination. { # Contains configuration for streaming FHIR export. "bigqueryDestination": { # The configuration for exporting to BigQuery. # The destination BigQuery structure that contains both the dataset location and corresponding schema config. The output is organized in one table per resource type. The server reuses the existing tables (if any) that are named after the resource types. For example, "Patient", "Observation". When there is no existing table for a given resource type, the server attempts to create one. When a table schema doesn't align with the schema config, either because of existing incompatible schema or out of band incompatible modification, the server does not stream in new data. BigQuery imposes a 1 MB limit on streaming insert row size, therefore any resource mutation that generates more than 1 MB of BigQuery data is not streamed. One resolution in this case is to delete the incompatible table and let the server recreate one, though the newly created table only contains data after the table recreation. Results are written to BigQuery tables according to the parameters in BigQueryDestination.WriteDisposition. Different versions of the same resource are distinguishable by the meta.versionId and meta.lastUpdated columns. The operation (CREATE/UPDATE/DELETE) that results in the new version is recorded in the meta.tag. The tables contain all historical resource versions since streaming was enabled. For query convenience, the server also creates one view per table of the same name containing only the current resource version. The streamed data in the BigQuery dataset is not guaranteed to be completely unique. The combination of the id and meta.versionId columns should ideally identify a single unique row. But in rare cases, duplicates may exist. At query time, users may use the SQL select statement to keep only one of the duplicate rows given an id and meta.versionId pair. Alternatively, the server created view mentioned above also filters out duplicates. If a resource mutation cannot be streamed to BigQuery, errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). "datasetUri": "A String", # BigQuery URI to an existing dataset, up to 2000 characters long, in the format `bq://projectId.bqDatasetId`. - "force": True or False, # If this flag is `TRUE`, all tables are deleted from the dataset before the new exported tables are written. If the flag is not set and the destination dataset contains tables, the export call returns an error. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE. + "force": True or False, # The default value is false. If this flag is `TRUE`, all tables are deleted from the dataset before the new exported tables are written. If the flag is not set and the destination dataset contains tables, the export call returns an error. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE. "schemaConfig": { # Configuration for the FHIR BigQuery schema. Determines how the server generates the schema. # The configuration for the exported BigQuery schema. "lastUpdatedPartitionConfig": { # Configuration for FHIR BigQuery time-partitioned tables. # The configuration for exported BigQuery tables to be partitioned by FHIR resource's last updated time column. "expirationMs": "A String", # Number of milliseconds for which to keep the storage for a partition. @@ -1268,7 +1268,7 @@

Method Details

}, ], }, - "useRegionalDataProcessing": True or False, # Ensures in-flight data remains in the region of origin during de-identification. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. + "useRegionalDataProcessing": True or False, # Ensures in-flight data remains in the region of origin during de-identification. The default value is false. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. }, "store": "A String", # The full resource name of a Cloud Healthcare FHIR store, for example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. }, @@ -1278,10 +1278,10 @@

Method Details

}, ], "validationConfig": { # Contains the configuration for FHIR profiles and validation. # Configuration for how to validate incoming FHIR resources against configured profiles. - "disableFhirpathValidation": True or False, # Whether to disable FHIRPath validation for incoming resources. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. - "disableProfileValidation": True or False, # Whether to disable profile validation for this FHIR store. Set this to true to disable checking incoming resources for conformance against structure definitions in this FHIR store. - "disableReferenceTypeValidation": True or False, # Whether to disable reference type validation for incoming resources. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. - "disableRequiredFieldValidation": True or False, # Whether to disable required fields validation for incoming resources. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableFhirpathValidation": True or False, # Whether to disable FHIRPath validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableProfileValidation": True or False, # Whether to disable profile validation for this FHIR store. The default value is false. Set this to true to disable checking incoming resources for conformance against structure definitions in this FHIR store. + "disableReferenceTypeValidation": True or False, # Whether to disable reference type validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableRequiredFieldValidation": True or False, # Whether to disable required fields validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. "enabledImplementationGuides": [ # A list of implementation guide URLs in this FHIR store that are used to configure the profiles to use for validation. For example, to use the US Core profiles for validation, set `enabled_implementation_guides` to `["http://hl7.org/fhir/us/core/ImplementationGuide/ig"]`. If `enabled_implementation_guides` is empty or omitted, then incoming resources are only required to conform to the base FHIR profiles. Otherwise, a resource must conform to at least one profile listed in the `global` property of one of the enabled ImplementationGuides. The Cloud Healthcare API does not currently enforce all of the rules in a StructureDefinition. The following rules are supported: - min/max - minValue/maxValue - maxLength - type - fixed[x] - pattern[x] on simple types - slicing, when using "value" as the discriminator type When a URL cannot be resolved (for example, in a type assertion), the server does not return an error. "A String", ], @@ -1300,10 +1300,10 @@

Method Details

{ # Represents a FHIR store. "complexDataTypeReferenceParsing": "A String", # Enable parsing of references within complex FHIR data types such as Extensions. If this value is set to ENABLED, then features like referential integrity and Bundle reference rewriting apply to all references. If this flag has not been specified the behavior of the FHIR store will not change, references in complex data types will not be parsed. New stores will have this value set to ENABLED after a notification period. Warning: turning on this flag causes processing existing resources to fail if they contain references to non-existent resources. - "defaultSearchHandlingStrict": True or False, # If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. + "defaultSearchHandlingStrict": True or False, # If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. Defaults to false. "disableReferentialIntegrity": True or False, # Immutable. Whether to disable referential integrity in this FHIR store. This field is immutable after FHIR store creation. The default value is false, meaning that the API enforces referential integrity and fails the requests that result in inconsistent state in the FHIR store. When this field is set to true, the API skips referential integrity checks. Consequently, operations that rely on references, such as GetPatientEverything, do not return all the results if broken references exist. - "disableResourceVersioning": True or False, # Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, which is the default behavior, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. - "enableUpdateCreate": True or False, # Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. + "disableResourceVersioning": True or False, # Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. Defaults to false. + "enableUpdateCreate": True or False, # Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. Defaults to false. "labels": { # User-supplied key-value pairs used to organize FHIR stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store. "a_key": "A String", }, @@ -1315,15 +1315,15 @@

Method Details

"notificationConfigs": [ # Specifies where and whether to send notifications upon changes to a FHIR store. { # Contains the configuration for FHIR notifications. "pubsubTopic": "A String", # The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. The notification is a `PubsubMessage` with the following fields: * `PubsubMessage.Data` contains the resource name. * `PubsubMessage.MessageId` is the ID of this notification. It is guaranteed to be unique within the topic. * `PubsubMessage.PublishTime` is the time when the message was published. Note that notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. The Cloud Healthcare API service account, service-@gcp-sa-healthcare.iam.gserviceaccount.com, must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail (https://cloud.google.com/healthcare-api/docs/permissions-healthcare-api-gcp-products#dicom_fhir_and_hl7v2_store_cloud_pubsub_permissions). If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare-api/docs/how-tos/logging). - "sendFullResource": True or False, # Whether to send full FHIR resource to this Pub/Sub topic. - "sendPreviousResourceOnDelete": True or False, # Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation. + "sendFullResource": True or False, # Whether to send full FHIR resource to this Pub/Sub topic. The default value is false. + "sendPreviousResourceOnDelete": True or False, # Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. The default value is false. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation. }, ], "streamConfigs": [ # A list of streaming configs that configure the destinations of streaming export for every resource mutation in this FHIR store. Each store is allowed to have up to 10 streaming configs. After a new config is added, the next resource mutation is streamed to the new location in addition to the existing ones. When a location is removed from the list, the server stops streaming to that location. Before adding a new config, you must add the required [`bigquery.dataEditor`](https://cloud.google.com/bigquery/docs/access-control#bigquery.dataEditor) role to your project's **Cloud Healthcare Service Agent** [service account](https://cloud.google.com/iam/docs/service-accounts). Some lag (typically on the order of dozens of seconds) is expected before the results show up in the streaming destination. { # Contains configuration for streaming FHIR export. "bigqueryDestination": { # The configuration for exporting to BigQuery. # The destination BigQuery structure that contains both the dataset location and corresponding schema config. The output is organized in one table per resource type. The server reuses the existing tables (if any) that are named after the resource types. For example, "Patient", "Observation". When there is no existing table for a given resource type, the server attempts to create one. When a table schema doesn't align with the schema config, either because of existing incompatible schema or out of band incompatible modification, the server does not stream in new data. BigQuery imposes a 1 MB limit on streaming insert row size, therefore any resource mutation that generates more than 1 MB of BigQuery data is not streamed. One resolution in this case is to delete the incompatible table and let the server recreate one, though the newly created table only contains data after the table recreation. Results are written to BigQuery tables according to the parameters in BigQueryDestination.WriteDisposition. Different versions of the same resource are distinguishable by the meta.versionId and meta.lastUpdated columns. The operation (CREATE/UPDATE/DELETE) that results in the new version is recorded in the meta.tag. The tables contain all historical resource versions since streaming was enabled. For query convenience, the server also creates one view per table of the same name containing only the current resource version. The streamed data in the BigQuery dataset is not guaranteed to be completely unique. The combination of the id and meta.versionId columns should ideally identify a single unique row. But in rare cases, duplicates may exist. At query time, users may use the SQL select statement to keep only one of the duplicate rows given an id and meta.versionId pair. Alternatively, the server created view mentioned above also filters out duplicates. If a resource mutation cannot be streamed to BigQuery, errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). "datasetUri": "A String", # BigQuery URI to an existing dataset, up to 2000 characters long, in the format `bq://projectId.bqDatasetId`. - "force": True or False, # If this flag is `TRUE`, all tables are deleted from the dataset before the new exported tables are written. If the flag is not set and the destination dataset contains tables, the export call returns an error. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE. + "force": True or False, # The default value is false. If this flag is `TRUE`, all tables are deleted from the dataset before the new exported tables are written. If the flag is not set and the destination dataset contains tables, the export call returns an error. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE. "schemaConfig": { # Configuration for the FHIR BigQuery schema. Determines how the server generates the schema. # The configuration for the exported BigQuery schema. "lastUpdatedPartitionConfig": { # Configuration for FHIR BigQuery time-partitioned tables. # The configuration for exported BigQuery tables to be partitioned by FHIR resource's last updated time column. "expirationMs": "A String", # Number of milliseconds for which to keep the storage for a partition. @@ -1425,7 +1425,7 @@

Method Details

}, ], }, - "useRegionalDataProcessing": True or False, # Ensures in-flight data remains in the region of origin during de-identification. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. + "useRegionalDataProcessing": True or False, # Ensures in-flight data remains in the region of origin during de-identification. The default value is false. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. }, "store": "A String", # The full resource name of a Cloud Healthcare FHIR store, for example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. }, @@ -1435,10 +1435,10 @@

Method Details

}, ], "validationConfig": { # Contains the configuration for FHIR profiles and validation. # Configuration for how to validate incoming FHIR resources against configured profiles. - "disableFhirpathValidation": True or False, # Whether to disable FHIRPath validation for incoming resources. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. - "disableProfileValidation": True or False, # Whether to disable profile validation for this FHIR store. Set this to true to disable checking incoming resources for conformance against structure definitions in this FHIR store. - "disableReferenceTypeValidation": True or False, # Whether to disable reference type validation for incoming resources. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. - "disableRequiredFieldValidation": True or False, # Whether to disable required fields validation for incoming resources. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableFhirpathValidation": True or False, # Whether to disable FHIRPath validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableProfileValidation": True or False, # Whether to disable profile validation for this FHIR store. The default value is false. Set this to true to disable checking incoming resources for conformance against structure definitions in this FHIR store. + "disableReferenceTypeValidation": True or False, # Whether to disable reference type validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableRequiredFieldValidation": True or False, # Whether to disable required fields validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. "enabledImplementationGuides": [ # A list of implementation guide URLs in this FHIR store that are used to configure the profiles to use for validation. For example, to use the US Core profiles for validation, set `enabled_implementation_guides` to `["http://hl7.org/fhir/us/core/ImplementationGuide/ig"]`. If `enabled_implementation_guides` is empty or omitted, then incoming resources are only required to conform to the base FHIR profiles. Otherwise, a resource must conform to at least one profile listed in the `global` property of one of the enabled ImplementationGuides. The Cloud Healthcare API does not currently enforce all of the rules in a StructureDefinition. The following rules are supported: - min/max - minValue/maxValue - maxLength - type - fixed[x] - pattern[x] on simple types - slicing, when using "value" as the discriminator type When a URL cannot be resolved (for example, in a type assertion), the server does not return an error. "A String", ], diff --git a/docs/dyn/healthcare_v1.projects.locations.datasets.hl7V2Stores.messages.html b/docs/dyn/healthcare_v1.projects.locations.datasets.hl7V2Stores.messages.html index e8a541c6d7d..69fe69d8eab 100644 --- a/docs/dyn/healthcare_v1.projects.locations.datasets.hl7V2Stores.messages.html +++ b/docs/dyn/healthcare_v1.projects.locations.datasets.hl7V2Stores.messages.html @@ -120,7 +120,7 @@

Method Details

"labels": { # User-supplied key-value pairs used to organize HL7v2 stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store. "a_key": "A String", }, - "messageType": "A String", # The message type for this message. MSH-9.1. + "messageType": "A String", # Output only. The message type for this message. MSH-9.1. "name": "A String", # Output only. Resource name of the Message, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`. "parsedData": { # The content of a HL7v2 message in a structured format. # Output only. The parsed version of the raw message data. "segments": [ @@ -133,18 +133,18 @@

Method Details

}, ], }, - "patientIds": [ # All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message. + "patientIds": [ # Output only. All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message. { # A patient identifier and associated type. "type": "A String", # ID type. For example, MRN or NHS. "value": "A String", # The patient's unique identifier. }, ], - "schematizedData": { # The content of an HL7v2 message in a structured format as specified by a schema. # The parsed version of the raw message data schematized according to this store's schemas and type definitions. + "schematizedData": { # The content of an HL7v2 message in a structured format as specified by a schema. # Output only. The parsed version of the raw message data schematized according to this store's schemas and type definitions. "data": "A String", # JSON output of the parser. "error": "A String", # The error output of the parser. }, - "sendFacility": "A String", # The hospital that this message came from. MSH-4. - "sendTime": "A String", # The datetime the sending application sent this message. MSH-7. + "sendFacility": "A String", # Output only. The hospital that this message came from. MSH-4. + "sendTime": "A String", # Output only. The datetime the sending application sent this message. MSH-7. }, } @@ -162,7 +162,7 @@

Method Details

"labels": { # User-supplied key-value pairs used to organize HL7v2 stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store. "a_key": "A String", }, - "messageType": "A String", # The message type for this message. MSH-9.1. + "messageType": "A String", # Output only. The message type for this message. MSH-9.1. "name": "A String", # Output only. Resource name of the Message, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`. "parsedData": { # The content of a HL7v2 message in a structured format. # Output only. The parsed version of the raw message data. "segments": [ @@ -175,18 +175,18 @@

Method Details

}, ], }, - "patientIds": [ # All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message. + "patientIds": [ # Output only. All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message. { # A patient identifier and associated type. "type": "A String", # ID type. For example, MRN or NHS. "value": "A String", # The patient's unique identifier. }, ], - "schematizedData": { # The content of an HL7v2 message in a structured format as specified by a schema. # The parsed version of the raw message data schematized according to this store's schemas and type definitions. + "schematizedData": { # The content of an HL7v2 message in a structured format as specified by a schema. # Output only. The parsed version of the raw message data schematized according to this store's schemas and type definitions. "data": "A String", # JSON output of the parser. "error": "A String", # The error output of the parser. }, - "sendFacility": "A String", # The hospital that this message came from. MSH-4. - "sendTime": "A String", # The datetime the sending application sent this message. MSH-7. + "sendFacility": "A String", # Output only. The hospital that this message came from. MSH-4. + "sendTime": "A String", # Output only. The datetime the sending application sent this message. MSH-7. } @@ -236,7 +236,7 @@

Method Details

"labels": { # User-supplied key-value pairs used to organize HL7v2 stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store. "a_key": "A String", }, - "messageType": "A String", # The message type for this message. MSH-9.1. + "messageType": "A String", # Output only. The message type for this message. MSH-9.1. "name": "A String", # Output only. Resource name of the Message, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`. "parsedData": { # The content of a HL7v2 message in a structured format. # Output only. The parsed version of the raw message data. "segments": [ @@ -249,18 +249,18 @@

Method Details

}, ], }, - "patientIds": [ # All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message. + "patientIds": [ # Output only. All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message. { # A patient identifier and associated type. "type": "A String", # ID type. For example, MRN or NHS. "value": "A String", # The patient's unique identifier. }, ], - "schematizedData": { # The content of an HL7v2 message in a structured format as specified by a schema. # The parsed version of the raw message data schematized according to this store's schemas and type definitions. + "schematizedData": { # The content of an HL7v2 message in a structured format as specified by a schema. # Output only. The parsed version of the raw message data schematized according to this store's schemas and type definitions. "data": "A String", # JSON output of the parser. "error": "A String", # The error output of the parser. }, - "sendFacility": "A String", # The hospital that this message came from. MSH-4. - "sendTime": "A String", # The datetime the sending application sent this message. MSH-7. + "sendFacility": "A String", # Output only. The hospital that this message came from. MSH-4. + "sendTime": "A String", # Output only. The datetime the sending application sent this message. MSH-7. } @@ -280,7 +280,7 @@

Method Details

"labels": { # User-supplied key-value pairs used to organize HL7v2 stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store. "a_key": "A String", }, - "messageType": "A String", # The message type for this message. MSH-9.1. + "messageType": "A String", # Output only. The message type for this message. MSH-9.1. "name": "A String", # Output only. Resource name of the Message, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`. "parsedData": { # The content of a HL7v2 message in a structured format. # Output only. The parsed version of the raw message data. "segments": [ @@ -293,18 +293,18 @@

Method Details

}, ], }, - "patientIds": [ # All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message. + "patientIds": [ # Output only. All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message. { # A patient identifier and associated type. "type": "A String", # ID type. For example, MRN or NHS. "value": "A String", # The patient's unique identifier. }, ], - "schematizedData": { # The content of an HL7v2 message in a structured format as specified by a schema. # The parsed version of the raw message data schematized according to this store's schemas and type definitions. + "schematizedData": { # The content of an HL7v2 message in a structured format as specified by a schema. # Output only. The parsed version of the raw message data schematized according to this store's schemas and type definitions. "data": "A String", # JSON output of the parser. "error": "A String", # The error output of the parser. }, - "sendFacility": "A String", # The hospital that this message came from. MSH-4. - "sendTime": "A String", # The datetime the sending application sent this message. MSH-7. + "sendFacility": "A String", # Output only. The hospital that this message came from. MSH-4. + "sendTime": "A String", # Output only. The datetime the sending application sent this message. MSH-7. }, } @@ -324,7 +324,7 @@

Method Details

"labels": { # User-supplied key-value pairs used to organize HL7v2 stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store. "a_key": "A String", }, - "messageType": "A String", # The message type for this message. MSH-9.1. + "messageType": "A String", # Output only. The message type for this message. MSH-9.1. "name": "A String", # Output only. Resource name of the Message, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`. "parsedData": { # The content of a HL7v2 message in a structured format. # Output only. The parsed version of the raw message data. "segments": [ @@ -337,18 +337,18 @@

Method Details

}, ], }, - "patientIds": [ # All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message. + "patientIds": [ # Output only. All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message. { # A patient identifier and associated type. "type": "A String", # ID type. For example, MRN or NHS. "value": "A String", # The patient's unique identifier. }, ], - "schematizedData": { # The content of an HL7v2 message in a structured format as specified by a schema. # The parsed version of the raw message data schematized according to this store's schemas and type definitions. + "schematizedData": { # The content of an HL7v2 message in a structured format as specified by a schema. # Output only. The parsed version of the raw message data schematized according to this store's schemas and type definitions. "data": "A String", # JSON output of the parser. "error": "A String", # The error output of the parser. }, - "sendFacility": "A String", # The hospital that this message came from. MSH-4. - "sendTime": "A String", # The datetime the sending application sent this message. MSH-7. + "sendFacility": "A String", # Output only. The hospital that this message came from. MSH-4. + "sendTime": "A String", # Output only. The datetime the sending application sent this message. MSH-7. }, } @@ -387,7 +387,7 @@

Method Details

"labels": { # User-supplied key-value pairs used to organize HL7v2 stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store. "a_key": "A String", }, - "messageType": "A String", # The message type for this message. MSH-9.1. + "messageType": "A String", # Output only. The message type for this message. MSH-9.1. "name": "A String", # Output only. Resource name of the Message, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`. "parsedData": { # The content of a HL7v2 message in a structured format. # Output only. The parsed version of the raw message data. "segments": [ @@ -400,18 +400,18 @@

Method Details

}, ], }, - "patientIds": [ # All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message. + "patientIds": [ # Output only. All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message. { # A patient identifier and associated type. "type": "A String", # ID type. For example, MRN or NHS. "value": "A String", # The patient's unique identifier. }, ], - "schematizedData": { # The content of an HL7v2 message in a structured format as specified by a schema. # The parsed version of the raw message data schematized according to this store's schemas and type definitions. + "schematizedData": { # The content of an HL7v2 message in a structured format as specified by a schema. # Output only. The parsed version of the raw message data schematized according to this store's schemas and type definitions. "data": "A String", # JSON output of the parser. "error": "A String", # The error output of the parser. }, - "sendFacility": "A String", # The hospital that this message came from. MSH-4. - "sendTime": "A String", # The datetime the sending application sent this message. MSH-7. + "sendFacility": "A String", # Output only. The hospital that this message came from. MSH-4. + "sendTime": "A String", # Output only. The datetime the sending application sent this message. MSH-7. }, ], "nextPageToken": "A String", # Token to retrieve the next page of results or empty if there are no more results in the list. @@ -447,7 +447,7 @@

Method Details

"labels": { # User-supplied key-value pairs used to organize HL7v2 stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store. "a_key": "A String", }, - "messageType": "A String", # The message type for this message. MSH-9.1. + "messageType": "A String", # Output only. The message type for this message. MSH-9.1. "name": "A String", # Output only. Resource name of the Message, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`. "parsedData": { # The content of a HL7v2 message in a structured format. # Output only. The parsed version of the raw message data. "segments": [ @@ -460,18 +460,18 @@

Method Details

}, ], }, - "patientIds": [ # All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message. + "patientIds": [ # Output only. All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message. { # A patient identifier and associated type. "type": "A String", # ID type. For example, MRN or NHS. "value": "A String", # The patient's unique identifier. }, ], - "schematizedData": { # The content of an HL7v2 message in a structured format as specified by a schema. # The parsed version of the raw message data schematized according to this store's schemas and type definitions. + "schematizedData": { # The content of an HL7v2 message in a structured format as specified by a schema. # Output only. The parsed version of the raw message data schematized according to this store's schemas and type definitions. "data": "A String", # JSON output of the parser. "error": "A String", # The error output of the parser. }, - "sendFacility": "A String", # The hospital that this message came from. MSH-4. - "sendTime": "A String", # The datetime the sending application sent this message. MSH-7. + "sendFacility": "A String", # Output only. The hospital that this message came from. MSH-4. + "sendTime": "A String", # Output only. The datetime the sending application sent this message. MSH-7. } updateMask: string, Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask @@ -489,7 +489,7 @@

Method Details

"labels": { # User-supplied key-value pairs used to organize HL7v2 stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store. "a_key": "A String", }, - "messageType": "A String", # The message type for this message. MSH-9.1. + "messageType": "A String", # Output only. The message type for this message. MSH-9.1. "name": "A String", # Output only. Resource name of the Message, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`. "parsedData": { # The content of a HL7v2 message in a structured format. # Output only. The parsed version of the raw message data. "segments": [ @@ -502,18 +502,18 @@

Method Details

}, ], }, - "patientIds": [ # All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message. + "patientIds": [ # Output only. All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message. { # A patient identifier and associated type. "type": "A String", # ID type. For example, MRN or NHS. "value": "A String", # The patient's unique identifier. }, ], - "schematizedData": { # The content of an HL7v2 message in a structured format as specified by a schema. # The parsed version of the raw message data schematized according to this store's schemas and type definitions. + "schematizedData": { # The content of an HL7v2 message in a structured format as specified by a schema. # Output only. The parsed version of the raw message data schematized according to this store's schemas and type definitions. "data": "A String", # JSON output of the parser. "error": "A String", # The error output of the parser. }, - "sendFacility": "A String", # The hospital that this message came from. MSH-4. - "sendTime": "A String", # The datetime the sending application sent this message. MSH-7. + "sendFacility": "A String", # Output only. The hospital that this message came from. MSH-4. + "sendTime": "A String", # Output only. The datetime the sending application sent this message. MSH-7. } diff --git a/docs/dyn/healthcare_v1.projects.locations.datasets.html b/docs/dyn/healthcare_v1.projects.locations.datasets.html index 7d4674a9b5d..e3cb7d9ce65 100644 --- a/docs/dyn/healthcare_v1.projects.locations.datasets.html +++ b/docs/dyn/healthcare_v1.projects.locations.datasets.html @@ -290,7 +290,7 @@

Method Details

}, ], }, - "useRegionalDataProcessing": True or False, # Ensures in-flight data remains in the region of origin during de-identification. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. + "useRegionalDataProcessing": True or False, # Ensures in-flight data remains in the region of origin during de-identification. The default value is false. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. }, "destinationDataset": "A String", # Required. The name of the dataset resource to create and write the redacted data to. * The destination dataset must not exist. * The destination dataset must be in the same location as the source dataset. De-identifying data across multiple locations is not supported. "gcsConfigUri": "A String", # Cloud Storage location to read the JSON cloud.healthcare.deidentify.DeidentifyConfig from, overriding the default config. Must be of the form `gs://{bucket_id}/path/to/object`. The Cloud Storage location must grant the Cloud IAM role `roles/storage.objectViewer` to the project's Cloud Healthcare Service Agent service account. Only one of `config` and `gcs_config_uri` can be specified. diff --git a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.dicomStores.html b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.dicomStores.html index 0f8eba6bf43..60442bbd510 100644 --- a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.dicomStores.html +++ b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.dicomStores.html @@ -414,7 +414,7 @@

Method Details

}, ], }, - "useRegionalDataProcessing": True or False, # Ensures in-flight data remains in the region of origin during de-identification. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. If the deprecated DicomConfig or FhirConfig are used, then `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. + "useRegionalDataProcessing": True or False, # Ensures in-flight data remains in the region of origin during de-identification. The default value is false. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. If the deprecated DicomConfig or FhirConfig are used, then `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. }, "destinationStore": "A String", # Required. The name of the DICOM store to create and write the redacted data to. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. * The destination dataset must exist. * The source dataset and destination dataset must both reside in the same location. De-identifying data across multiple locations is not supported. * The destination DICOM store must not exist. * The caller must have the necessary permissions to create the destination DICOM store. "filterConfig": { # Specifies the filter configuration for DICOM resources. # Filter configuration. diff --git a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.html b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.html index 1658c43b7ea..e706e1a210a 100644 --- a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.html +++ b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.html @@ -306,7 +306,7 @@

Method Details

"accessDeterminationLogConfig": { # Configures consent audit log config for FHIR create, read, update, and delete (CRUD) operations. Cloud audit log for healthcare API must be [enabled](https://cloud.google.com/logging/docs/audit/configure-data-access#config-console-enable). The consent-related logs are included as part of `protoPayload.metadata`. # Optional. Specifies how the server logs the consent-aware requests. If not specified, the `AccessDeterminationLogConfig.LogLevel.MINIMUM` option is used. "logLevel": "A String", # Optional. Controls the amount of detail to include as part of the audit logs. }, - "accessEnforced": True or False, # Optional. If set to true, when accessing FHIR resources, the consent headers will be verified against consents given by patients. See the ConsentEnforcementVersion for the supported consent headers. + "accessEnforced": True or False, # Optional. The default value is false. If set to true, when accessing FHIR resources, the consent headers will be verified against consents given by patients. See the ConsentEnforcementVersion for the supported consent headers. "consentHeaderHandling": { # How the server handles the consent header. # Optional. Different options to configure the behaviour of the server when handling the `X-Consent-Scope` header. "profile": "A String", # Optional. Specifies the default server behavior when the header is empty. If not specified, the `ScopeProfile.PERMIT_EMPTY_SCOPE` option is used. }, @@ -315,11 +315,11 @@

Method Details

], "version": "A String", # Required. Specifies which consent enforcement version is being used for this FHIR store. This field can only be set once by either CreateFhirStore or UpdateFhirStore. After that, you must call ApplyConsents to change the version. }, - "defaultSearchHandlingStrict": True or False, # If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. + "defaultSearchHandlingStrict": True or False, # If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. Defaults to false. "disableReferentialIntegrity": True or False, # Immutable. Whether to disable referential integrity in this FHIR store. This field is immutable after FHIR store creation. The default value is false, meaning that the API enforces referential integrity and fails the requests that result in inconsistent state in the FHIR store. When this field is set to true, the API skips referential integrity checks. Consequently, operations that rely on references, such as GetPatientEverything, do not return all the results if broken references exist. - "disableResourceVersioning": True or False, # Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, which is the default behavior, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. - "enableHistoryModifications": True or False, # Optional. Whether to allow ExecuteBundle to accept history bundles, and directly insert and overwrite historical resource versions into the FHIR store. If set to false, using history bundles fails with an error. - "enableUpdateCreate": True or False, # Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. + "disableResourceVersioning": True or False, # Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. Defaults to false. + "enableHistoryModifications": True or False, # Optional. Whether to allow ExecuteBundle to accept history bundles, and directly insert and overwrite historical resource versions into the FHIR store. If set to false, using history bundles fails with an error. Defaults to false. + "enableUpdateCreate": True or False, # Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. Defaults to false. "labels": { # User-supplied key-value pairs used to organize FHIR stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store. "a_key": "A String", }, @@ -331,8 +331,8 @@

Method Details

"notificationConfigs": [ # Specifies where and whether to send notifications upon changes to a Fhir store. { # Contains the configuration for FHIR notifications. "pubsubTopic": "A String", # The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. The notification is a `PubsubMessage` with the following fields: * `PubsubMessage.Data` contains the resource name. * `PubsubMessage.MessageId` is the ID of this notification. It is guaranteed to be unique within the topic. * `PubsubMessage.PublishTime` is the time when the message was published. Note that notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. The Cloud Healthcare API service account, service-@gcp-sa-healthcare.iam.gserviceaccount.com, must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail (https://cloud.google.com/healthcare-api/docs/permissions-healthcare-api-gcp-products#dicom_fhir_and_hl7v2_store_cloud_pubsub_permissions). If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare-api/docs/how-tos/logging). - "sendFullResource": True or False, # Whether to send full FHIR resource to this Pub/Sub topic for Create and Update operation. Note that setting this to true does not guarantee that all resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full resource as a separate operation. - "sendPreviousResourceOnDelete": True or False, # Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation. + "sendFullResource": True or False, # Whether to send full FHIR resource to this Pub/Sub topic for Create and Update operation. The default value is false. Note that setting this to true does not guarantee that all resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full resource as a separate operation. + "sendPreviousResourceOnDelete": True or False, # Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. The default value is false. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation. }, ], "searchConfig": { # Contains the configuration for FHIR search. # Configuration for how FHIR resources can be searched. @@ -557,7 +557,7 @@

Method Details

}, ], }, - "useRegionalDataProcessing": True or False, # Ensures in-flight data remains in the region of origin during de-identification. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. If the deprecated DicomConfig or FhirConfig are used, then `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. + "useRegionalDataProcessing": True or False, # Ensures in-flight data remains in the region of origin during de-identification. The default value is false. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. If the deprecated DicomConfig or FhirConfig are used, then `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. }, "store": "A String", # The full resource name of a Cloud Healthcare FHIR store, for example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. }, @@ -567,10 +567,10 @@

Method Details

}, ], "validationConfig": { # Contains the configuration for FHIR profiles and validation. # Configuration for how to validate incoming FHIR resources against configured profiles. - "disableFhirpathValidation": True or False, # Whether to disable FHIRPath validation for incoming resources. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. - "disableProfileValidation": True or False, # Whether to disable profile validation for this FHIR store. Set this to true to disable checking incoming resources for conformance against StructureDefinitions in this FHIR store. - "disableReferenceTypeValidation": True or False, # Whether to disable reference type validation for incoming resources. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. - "disableRequiredFieldValidation": True or False, # Whether to disable required fields validation for incoming resources. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableFhirpathValidation": True or False, # Whether to disable FHIRPath validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableProfileValidation": True or False, # Whether to disable profile validation for this FHIR store. The default value is false. Set this to true to disable checking incoming resources for conformance against StructureDefinitions in this FHIR store. + "disableReferenceTypeValidation": True or False, # Whether to disable reference type validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableRequiredFieldValidation": True or False, # Whether to disable required fields validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. "enabledImplementationGuides": [ # A list of ImplementationGuide URLs in this FHIR store that are used to configure the profiles to use for validation. For example, to use the US Core profiles for validation, set `enabled_implementation_guides` to `["http://hl7.org/fhir/us/core/ImplementationGuide/ig"]`. If `enabled_implementation_guides` is empty or omitted, then incoming resources are only required to conform to the base FHIR profiles. Otherwise, a resource must conform to at least one profile listed in the `global` property of one of the enabled ImplementationGuides. The Cloud Healthcare API does not currently enforce all of the rules in a StructureDefinition. The following rules are supported: - min/max - minValue/maxValue - maxLength - type - fixed[x] - pattern[x] on simple types - slicing, when using "value" as the discriminator type When a URL cannot be resolved (for example, in a type assertion), the server does not return an error. "A String", ], @@ -593,7 +593,7 @@

Method Details

"accessDeterminationLogConfig": { # Configures consent audit log config for FHIR create, read, update, and delete (CRUD) operations. Cloud audit log for healthcare API must be [enabled](https://cloud.google.com/logging/docs/audit/configure-data-access#config-console-enable). The consent-related logs are included as part of `protoPayload.metadata`. # Optional. Specifies how the server logs the consent-aware requests. If not specified, the `AccessDeterminationLogConfig.LogLevel.MINIMUM` option is used. "logLevel": "A String", # Optional. Controls the amount of detail to include as part of the audit logs. }, - "accessEnforced": True or False, # Optional. If set to true, when accessing FHIR resources, the consent headers will be verified against consents given by patients. See the ConsentEnforcementVersion for the supported consent headers. + "accessEnforced": True or False, # Optional. The default value is false. If set to true, when accessing FHIR resources, the consent headers will be verified against consents given by patients. See the ConsentEnforcementVersion for the supported consent headers. "consentHeaderHandling": { # How the server handles the consent header. # Optional. Different options to configure the behaviour of the server when handling the `X-Consent-Scope` header. "profile": "A String", # Optional. Specifies the default server behavior when the header is empty. If not specified, the `ScopeProfile.PERMIT_EMPTY_SCOPE` option is used. }, @@ -602,11 +602,11 @@

Method Details

], "version": "A String", # Required. Specifies which consent enforcement version is being used for this FHIR store. This field can only be set once by either CreateFhirStore or UpdateFhirStore. After that, you must call ApplyConsents to change the version. }, - "defaultSearchHandlingStrict": True or False, # If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. + "defaultSearchHandlingStrict": True or False, # If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. Defaults to false. "disableReferentialIntegrity": True or False, # Immutable. Whether to disable referential integrity in this FHIR store. This field is immutable after FHIR store creation. The default value is false, meaning that the API enforces referential integrity and fails the requests that result in inconsistent state in the FHIR store. When this field is set to true, the API skips referential integrity checks. Consequently, operations that rely on references, such as GetPatientEverything, do not return all the results if broken references exist. - "disableResourceVersioning": True or False, # Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, which is the default behavior, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. - "enableHistoryModifications": True or False, # Optional. Whether to allow ExecuteBundle to accept history bundles, and directly insert and overwrite historical resource versions into the FHIR store. If set to false, using history bundles fails with an error. - "enableUpdateCreate": True or False, # Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. + "disableResourceVersioning": True or False, # Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. Defaults to false. + "enableHistoryModifications": True or False, # Optional. Whether to allow ExecuteBundle to accept history bundles, and directly insert and overwrite historical resource versions into the FHIR store. If set to false, using history bundles fails with an error. Defaults to false. + "enableUpdateCreate": True or False, # Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. Defaults to false. "labels": { # User-supplied key-value pairs used to organize FHIR stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store. "a_key": "A String", }, @@ -618,8 +618,8 @@

Method Details

"notificationConfigs": [ # Specifies where and whether to send notifications upon changes to a Fhir store. { # Contains the configuration for FHIR notifications. "pubsubTopic": "A String", # The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. The notification is a `PubsubMessage` with the following fields: * `PubsubMessage.Data` contains the resource name. * `PubsubMessage.MessageId` is the ID of this notification. It is guaranteed to be unique within the topic. * `PubsubMessage.PublishTime` is the time when the message was published. Note that notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. The Cloud Healthcare API service account, service-@gcp-sa-healthcare.iam.gserviceaccount.com, must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail (https://cloud.google.com/healthcare-api/docs/permissions-healthcare-api-gcp-products#dicom_fhir_and_hl7v2_store_cloud_pubsub_permissions). If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare-api/docs/how-tos/logging). - "sendFullResource": True or False, # Whether to send full FHIR resource to this Pub/Sub topic for Create and Update operation. Note that setting this to true does not guarantee that all resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full resource as a separate operation. - "sendPreviousResourceOnDelete": True or False, # Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation. + "sendFullResource": True or False, # Whether to send full FHIR resource to this Pub/Sub topic for Create and Update operation. The default value is false. Note that setting this to true does not guarantee that all resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full resource as a separate operation. + "sendPreviousResourceOnDelete": True or False, # Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. The default value is false. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation. }, ], "searchConfig": { # Contains the configuration for FHIR search. # Configuration for how FHIR resources can be searched. @@ -844,7 +844,7 @@

Method Details

}, ], }, - "useRegionalDataProcessing": True or False, # Ensures in-flight data remains in the region of origin during de-identification. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. If the deprecated DicomConfig or FhirConfig are used, then `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. + "useRegionalDataProcessing": True or False, # Ensures in-flight data remains in the region of origin during de-identification. The default value is false. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. If the deprecated DicomConfig or FhirConfig are used, then `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. }, "store": "A String", # The full resource name of a Cloud Healthcare FHIR store, for example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. }, @@ -854,10 +854,10 @@

Method Details

}, ], "validationConfig": { # Contains the configuration for FHIR profiles and validation. # Configuration for how to validate incoming FHIR resources against configured profiles. - "disableFhirpathValidation": True or False, # Whether to disable FHIRPath validation for incoming resources. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. - "disableProfileValidation": True or False, # Whether to disable profile validation for this FHIR store. Set this to true to disable checking incoming resources for conformance against StructureDefinitions in this FHIR store. - "disableReferenceTypeValidation": True or False, # Whether to disable reference type validation for incoming resources. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. - "disableRequiredFieldValidation": True or False, # Whether to disable required fields validation for incoming resources. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableFhirpathValidation": True or False, # Whether to disable FHIRPath validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableProfileValidation": True or False, # Whether to disable profile validation for this FHIR store. The default value is false. Set this to true to disable checking incoming resources for conformance against StructureDefinitions in this FHIR store. + "disableReferenceTypeValidation": True or False, # Whether to disable reference type validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableRequiredFieldValidation": True or False, # Whether to disable required fields validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. "enabledImplementationGuides": [ # A list of ImplementationGuide URLs in this FHIR store that are used to configure the profiles to use for validation. For example, to use the US Core profiles for validation, set `enabled_implementation_guides` to `["http://hl7.org/fhir/us/core/ImplementationGuide/ig"]`. If `enabled_implementation_guides` is empty or omitted, then incoming resources are only required to conform to the base FHIR profiles. Otherwise, a resource must conform to at least one profile listed in the `global` property of one of the enabled ImplementationGuides. The Cloud Healthcare API does not currently enforce all of the rules in a StructureDefinition. The following rules are supported: - min/max - minValue/maxValue - maxLength - type - fixed[x] - pattern[x] on simple types - slicing, when using "value" as the discriminator type When a URL cannot be resolved (for example, in a type assertion), the server does not return an error. "A String", ], @@ -1074,7 +1074,7 @@

Method Details

}, ], }, - "useRegionalDataProcessing": True or False, # Ensures in-flight data remains in the region of origin during de-identification. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. If the deprecated DicomConfig or FhirConfig are used, then `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. + "useRegionalDataProcessing": True or False, # Ensures in-flight data remains in the region of origin during de-identification. The default value is false. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. If the deprecated DicomConfig or FhirConfig are used, then `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. }, "destinationStore": "A String", # Required. The name of the FHIR store to create and write the redacted data to. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. * The destination dataset must exist. * The source dataset and destination dataset must both reside in the same location. De-identifying data across multiple locations is not supported. * The destination FHIR store must exist. * The caller must have the healthcare.fhirResources.update permission to write to the destination FHIR store. "gcsConfigUri": "A String", # Cloud Storage location to read the JSON cloud.healthcare.deidentify.DeidentifyConfig from, overriding the default config. Must be of the form `gs://{bucket_id}/path/to/object`. The Cloud Storage location must grant the Cloud IAM role `roles/storage.objectViewer` to the project's Cloud Healthcare Service Agent service account. Only one of `config` and `gcs_config_uri` can be specified. @@ -1315,7 +1315,7 @@

Method Details

"accessDeterminationLogConfig": { # Configures consent audit log config for FHIR create, read, update, and delete (CRUD) operations. Cloud audit log for healthcare API must be [enabled](https://cloud.google.com/logging/docs/audit/configure-data-access#config-console-enable). The consent-related logs are included as part of `protoPayload.metadata`. # Optional. Specifies how the server logs the consent-aware requests. If not specified, the `AccessDeterminationLogConfig.LogLevel.MINIMUM` option is used. "logLevel": "A String", # Optional. Controls the amount of detail to include as part of the audit logs. }, - "accessEnforced": True or False, # Optional. If set to true, when accessing FHIR resources, the consent headers will be verified against consents given by patients. See the ConsentEnforcementVersion for the supported consent headers. + "accessEnforced": True or False, # Optional. The default value is false. If set to true, when accessing FHIR resources, the consent headers will be verified against consents given by patients. See the ConsentEnforcementVersion for the supported consent headers. "consentHeaderHandling": { # How the server handles the consent header. # Optional. Different options to configure the behaviour of the server when handling the `X-Consent-Scope` header. "profile": "A String", # Optional. Specifies the default server behavior when the header is empty. If not specified, the `ScopeProfile.PERMIT_EMPTY_SCOPE` option is used. }, @@ -1324,11 +1324,11 @@

Method Details

], "version": "A String", # Required. Specifies which consent enforcement version is being used for this FHIR store. This field can only be set once by either CreateFhirStore or UpdateFhirStore. After that, you must call ApplyConsents to change the version. }, - "defaultSearchHandlingStrict": True or False, # If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. + "defaultSearchHandlingStrict": True or False, # If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. Defaults to false. "disableReferentialIntegrity": True or False, # Immutable. Whether to disable referential integrity in this FHIR store. This field is immutable after FHIR store creation. The default value is false, meaning that the API enforces referential integrity and fails the requests that result in inconsistent state in the FHIR store. When this field is set to true, the API skips referential integrity checks. Consequently, operations that rely on references, such as GetPatientEverything, do not return all the results if broken references exist. - "disableResourceVersioning": True or False, # Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, which is the default behavior, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. - "enableHistoryModifications": True or False, # Optional. Whether to allow ExecuteBundle to accept history bundles, and directly insert and overwrite historical resource versions into the FHIR store. If set to false, using history bundles fails with an error. - "enableUpdateCreate": True or False, # Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. + "disableResourceVersioning": True or False, # Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. Defaults to false. + "enableHistoryModifications": True or False, # Optional. Whether to allow ExecuteBundle to accept history bundles, and directly insert and overwrite historical resource versions into the FHIR store. If set to false, using history bundles fails with an error. Defaults to false. + "enableUpdateCreate": True or False, # Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. Defaults to false. "labels": { # User-supplied key-value pairs used to organize FHIR stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store. "a_key": "A String", }, @@ -1340,8 +1340,8 @@

Method Details

"notificationConfigs": [ # Specifies where and whether to send notifications upon changes to a Fhir store. { # Contains the configuration for FHIR notifications. "pubsubTopic": "A String", # The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. The notification is a `PubsubMessage` with the following fields: * `PubsubMessage.Data` contains the resource name. * `PubsubMessage.MessageId` is the ID of this notification. It is guaranteed to be unique within the topic. * `PubsubMessage.PublishTime` is the time when the message was published. Note that notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. The Cloud Healthcare API service account, service-@gcp-sa-healthcare.iam.gserviceaccount.com, must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail (https://cloud.google.com/healthcare-api/docs/permissions-healthcare-api-gcp-products#dicom_fhir_and_hl7v2_store_cloud_pubsub_permissions). If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare-api/docs/how-tos/logging). - "sendFullResource": True or False, # Whether to send full FHIR resource to this Pub/Sub topic for Create and Update operation. Note that setting this to true does not guarantee that all resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full resource as a separate operation. - "sendPreviousResourceOnDelete": True or False, # Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation. + "sendFullResource": True or False, # Whether to send full FHIR resource to this Pub/Sub topic for Create and Update operation. The default value is false. Note that setting this to true does not guarantee that all resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full resource as a separate operation. + "sendPreviousResourceOnDelete": True or False, # Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. The default value is false. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation. }, ], "searchConfig": { # Contains the configuration for FHIR search. # Configuration for how FHIR resources can be searched. @@ -1566,7 +1566,7 @@

Method Details

}, ], }, - "useRegionalDataProcessing": True or False, # Ensures in-flight data remains in the region of origin during de-identification. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. If the deprecated DicomConfig or FhirConfig are used, then `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. + "useRegionalDataProcessing": True or False, # Ensures in-flight data remains in the region of origin during de-identification. The default value is false. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. If the deprecated DicomConfig or FhirConfig are used, then `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. }, "store": "A String", # The full resource name of a Cloud Healthcare FHIR store, for example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. }, @@ -1576,10 +1576,10 @@

Method Details

}, ], "validationConfig": { # Contains the configuration for FHIR profiles and validation. # Configuration for how to validate incoming FHIR resources against configured profiles. - "disableFhirpathValidation": True or False, # Whether to disable FHIRPath validation for incoming resources. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. - "disableProfileValidation": True or False, # Whether to disable profile validation for this FHIR store. Set this to true to disable checking incoming resources for conformance against StructureDefinitions in this FHIR store. - "disableReferenceTypeValidation": True or False, # Whether to disable reference type validation for incoming resources. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. - "disableRequiredFieldValidation": True or False, # Whether to disable required fields validation for incoming resources. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableFhirpathValidation": True or False, # Whether to disable FHIRPath validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableProfileValidation": True or False, # Whether to disable profile validation for this FHIR store. The default value is false. Set this to true to disable checking incoming resources for conformance against StructureDefinitions in this FHIR store. + "disableReferenceTypeValidation": True or False, # Whether to disable reference type validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableRequiredFieldValidation": True or False, # Whether to disable required fields validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. "enabledImplementationGuides": [ # A list of ImplementationGuide URLs in this FHIR store that are used to configure the profiles to use for validation. For example, to use the US Core profiles for validation, set `enabled_implementation_guides` to `["http://hl7.org/fhir/us/core/ImplementationGuide/ig"]`. If `enabled_implementation_guides` is empty or omitted, then incoming resources are only required to conform to the base FHIR profiles. Otherwise, a resource must conform to at least one profile listed in the `global` property of one of the enabled ImplementationGuides. The Cloud Healthcare API does not currently enforce all of the rules in a StructureDefinition. The following rules are supported: - min/max - minValue/maxValue - maxLength - type - fixed[x] - pattern[x] on simple types - slicing, when using "value" as the discriminator type When a URL cannot be resolved (for example, in a type assertion), the server does not return an error. "A String", ], @@ -1778,7 +1778,7 @@

Method Details

"accessDeterminationLogConfig": { # Configures consent audit log config for FHIR create, read, update, and delete (CRUD) operations. Cloud audit log for healthcare API must be [enabled](https://cloud.google.com/logging/docs/audit/configure-data-access#config-console-enable). The consent-related logs are included as part of `protoPayload.metadata`. # Optional. Specifies how the server logs the consent-aware requests. If not specified, the `AccessDeterminationLogConfig.LogLevel.MINIMUM` option is used. "logLevel": "A String", # Optional. Controls the amount of detail to include as part of the audit logs. }, - "accessEnforced": True or False, # Optional. If set to true, when accessing FHIR resources, the consent headers will be verified against consents given by patients. See the ConsentEnforcementVersion for the supported consent headers. + "accessEnforced": True or False, # Optional. The default value is false. If set to true, when accessing FHIR resources, the consent headers will be verified against consents given by patients. See the ConsentEnforcementVersion for the supported consent headers. "consentHeaderHandling": { # How the server handles the consent header. # Optional. Different options to configure the behaviour of the server when handling the `X-Consent-Scope` header. "profile": "A String", # Optional. Specifies the default server behavior when the header is empty. If not specified, the `ScopeProfile.PERMIT_EMPTY_SCOPE` option is used. }, @@ -1787,11 +1787,11 @@

Method Details

], "version": "A String", # Required. Specifies which consent enforcement version is being used for this FHIR store. This field can only be set once by either CreateFhirStore or UpdateFhirStore. After that, you must call ApplyConsents to change the version. }, - "defaultSearchHandlingStrict": True or False, # If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. + "defaultSearchHandlingStrict": True or False, # If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. Defaults to false. "disableReferentialIntegrity": True or False, # Immutable. Whether to disable referential integrity in this FHIR store. This field is immutable after FHIR store creation. The default value is false, meaning that the API enforces referential integrity and fails the requests that result in inconsistent state in the FHIR store. When this field is set to true, the API skips referential integrity checks. Consequently, operations that rely on references, such as GetPatientEverything, do not return all the results if broken references exist. - "disableResourceVersioning": True or False, # Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, which is the default behavior, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. - "enableHistoryModifications": True or False, # Optional. Whether to allow ExecuteBundle to accept history bundles, and directly insert and overwrite historical resource versions into the FHIR store. If set to false, using history bundles fails with an error. - "enableUpdateCreate": True or False, # Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. + "disableResourceVersioning": True or False, # Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. Defaults to false. + "enableHistoryModifications": True or False, # Optional. Whether to allow ExecuteBundle to accept history bundles, and directly insert and overwrite historical resource versions into the FHIR store. If set to false, using history bundles fails with an error. Defaults to false. + "enableUpdateCreate": True or False, # Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. Defaults to false. "labels": { # User-supplied key-value pairs used to organize FHIR stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store. "a_key": "A String", }, @@ -1803,8 +1803,8 @@

Method Details

"notificationConfigs": [ # Specifies where and whether to send notifications upon changes to a Fhir store. { # Contains the configuration for FHIR notifications. "pubsubTopic": "A String", # The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. The notification is a `PubsubMessage` with the following fields: * `PubsubMessage.Data` contains the resource name. * `PubsubMessage.MessageId` is the ID of this notification. It is guaranteed to be unique within the topic. * `PubsubMessage.PublishTime` is the time when the message was published. Note that notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. The Cloud Healthcare API service account, service-@gcp-sa-healthcare.iam.gserviceaccount.com, must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail (https://cloud.google.com/healthcare-api/docs/permissions-healthcare-api-gcp-products#dicom_fhir_and_hl7v2_store_cloud_pubsub_permissions). If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare-api/docs/how-tos/logging). - "sendFullResource": True or False, # Whether to send full FHIR resource to this Pub/Sub topic for Create and Update operation. Note that setting this to true does not guarantee that all resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full resource as a separate operation. - "sendPreviousResourceOnDelete": True or False, # Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation. + "sendFullResource": True or False, # Whether to send full FHIR resource to this Pub/Sub topic for Create and Update operation. The default value is false. Note that setting this to true does not guarantee that all resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full resource as a separate operation. + "sendPreviousResourceOnDelete": True or False, # Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. The default value is false. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation. }, ], "searchConfig": { # Contains the configuration for FHIR search. # Configuration for how FHIR resources can be searched. @@ -2029,7 +2029,7 @@

Method Details

}, ], }, - "useRegionalDataProcessing": True or False, # Ensures in-flight data remains in the region of origin during de-identification. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. If the deprecated DicomConfig or FhirConfig are used, then `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. + "useRegionalDataProcessing": True or False, # Ensures in-flight data remains in the region of origin during de-identification. The default value is false. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. If the deprecated DicomConfig or FhirConfig are used, then `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. }, "store": "A String", # The full resource name of a Cloud Healthcare FHIR store, for example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. }, @@ -2039,10 +2039,10 @@

Method Details

}, ], "validationConfig": { # Contains the configuration for FHIR profiles and validation. # Configuration for how to validate incoming FHIR resources against configured profiles. - "disableFhirpathValidation": True or False, # Whether to disable FHIRPath validation for incoming resources. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. - "disableProfileValidation": True or False, # Whether to disable profile validation for this FHIR store. Set this to true to disable checking incoming resources for conformance against StructureDefinitions in this FHIR store. - "disableReferenceTypeValidation": True or False, # Whether to disable reference type validation for incoming resources. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. - "disableRequiredFieldValidation": True or False, # Whether to disable required fields validation for incoming resources. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableFhirpathValidation": True or False, # Whether to disable FHIRPath validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableProfileValidation": True or False, # Whether to disable profile validation for this FHIR store. The default value is false. Set this to true to disable checking incoming resources for conformance against StructureDefinitions in this FHIR store. + "disableReferenceTypeValidation": True or False, # Whether to disable reference type validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableRequiredFieldValidation": True or False, # Whether to disable required fields validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. "enabledImplementationGuides": [ # A list of ImplementationGuide URLs in this FHIR store that are used to configure the profiles to use for validation. For example, to use the US Core profiles for validation, set `enabled_implementation_guides` to `["http://hl7.org/fhir/us/core/ImplementationGuide/ig"]`. If `enabled_implementation_guides` is empty or omitted, then incoming resources are only required to conform to the base FHIR profiles. Otherwise, a resource must conform to at least one profile listed in the `global` property of one of the enabled ImplementationGuides. The Cloud Healthcare API does not currently enforce all of the rules in a StructureDefinition. The following rules are supported: - min/max - minValue/maxValue - maxLength - type - fixed[x] - pattern[x] on simple types - slicing, when using "value" as the discriminator type When a URL cannot be resolved (for example, in a type assertion), the server does not return an error. "A String", ], @@ -2083,7 +2083,7 @@

Method Details

"accessDeterminationLogConfig": { # Configures consent audit log config for FHIR create, read, update, and delete (CRUD) operations. Cloud audit log for healthcare API must be [enabled](https://cloud.google.com/logging/docs/audit/configure-data-access#config-console-enable). The consent-related logs are included as part of `protoPayload.metadata`. # Optional. Specifies how the server logs the consent-aware requests. If not specified, the `AccessDeterminationLogConfig.LogLevel.MINIMUM` option is used. "logLevel": "A String", # Optional. Controls the amount of detail to include as part of the audit logs. }, - "accessEnforced": True or False, # Optional. If set to true, when accessing FHIR resources, the consent headers will be verified against consents given by patients. See the ConsentEnforcementVersion for the supported consent headers. + "accessEnforced": True or False, # Optional. The default value is false. If set to true, when accessing FHIR resources, the consent headers will be verified against consents given by patients. See the ConsentEnforcementVersion for the supported consent headers. "consentHeaderHandling": { # How the server handles the consent header. # Optional. Different options to configure the behaviour of the server when handling the `X-Consent-Scope` header. "profile": "A String", # Optional. Specifies the default server behavior when the header is empty. If not specified, the `ScopeProfile.PERMIT_EMPTY_SCOPE` option is used. }, @@ -2092,11 +2092,11 @@

Method Details

], "version": "A String", # Required. Specifies which consent enforcement version is being used for this FHIR store. This field can only be set once by either CreateFhirStore or UpdateFhirStore. After that, you must call ApplyConsents to change the version. }, - "defaultSearchHandlingStrict": True or False, # If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. + "defaultSearchHandlingStrict": True or False, # If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. Defaults to false. "disableReferentialIntegrity": True or False, # Immutable. Whether to disable referential integrity in this FHIR store. This field is immutable after FHIR store creation. The default value is false, meaning that the API enforces referential integrity and fails the requests that result in inconsistent state in the FHIR store. When this field is set to true, the API skips referential integrity checks. Consequently, operations that rely on references, such as GetPatientEverything, do not return all the results if broken references exist. - "disableResourceVersioning": True or False, # Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, which is the default behavior, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. - "enableHistoryModifications": True or False, # Optional. Whether to allow ExecuteBundle to accept history bundles, and directly insert and overwrite historical resource versions into the FHIR store. If set to false, using history bundles fails with an error. - "enableUpdateCreate": True or False, # Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. + "disableResourceVersioning": True or False, # Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. Defaults to false. + "enableHistoryModifications": True or False, # Optional. Whether to allow ExecuteBundle to accept history bundles, and directly insert and overwrite historical resource versions into the FHIR store. If set to false, using history bundles fails with an error. Defaults to false. + "enableUpdateCreate": True or False, # Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. Defaults to false. "labels": { # User-supplied key-value pairs used to organize FHIR stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store. "a_key": "A String", }, @@ -2108,8 +2108,8 @@

Method Details

"notificationConfigs": [ # Specifies where and whether to send notifications upon changes to a Fhir store. { # Contains the configuration for FHIR notifications. "pubsubTopic": "A String", # The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. The notification is a `PubsubMessage` with the following fields: * `PubsubMessage.Data` contains the resource name. * `PubsubMessage.MessageId` is the ID of this notification. It is guaranteed to be unique within the topic. * `PubsubMessage.PublishTime` is the time when the message was published. Note that notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. The Cloud Healthcare API service account, service-@gcp-sa-healthcare.iam.gserviceaccount.com, must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail (https://cloud.google.com/healthcare-api/docs/permissions-healthcare-api-gcp-products#dicom_fhir_and_hl7v2_store_cloud_pubsub_permissions). If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare-api/docs/how-tos/logging). - "sendFullResource": True or False, # Whether to send full FHIR resource to this Pub/Sub topic for Create and Update operation. Note that setting this to true does not guarantee that all resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full resource as a separate operation. - "sendPreviousResourceOnDelete": True or False, # Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation. + "sendFullResource": True or False, # Whether to send full FHIR resource to this Pub/Sub topic for Create and Update operation. The default value is false. Note that setting this to true does not guarantee that all resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full resource as a separate operation. + "sendPreviousResourceOnDelete": True or False, # Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. The default value is false. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation. }, ], "searchConfig": { # Contains the configuration for FHIR search. # Configuration for how FHIR resources can be searched. @@ -2334,7 +2334,7 @@

Method Details

}, ], }, - "useRegionalDataProcessing": True or False, # Ensures in-flight data remains in the region of origin during de-identification. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. If the deprecated DicomConfig or FhirConfig are used, then `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. + "useRegionalDataProcessing": True or False, # Ensures in-flight data remains in the region of origin during de-identification. The default value is false. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. If the deprecated DicomConfig or FhirConfig are used, then `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. }, "store": "A String", # The full resource name of a Cloud Healthcare FHIR store, for example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. }, @@ -2344,10 +2344,10 @@

Method Details

}, ], "validationConfig": { # Contains the configuration for FHIR profiles and validation. # Configuration for how to validate incoming FHIR resources against configured profiles. - "disableFhirpathValidation": True or False, # Whether to disable FHIRPath validation for incoming resources. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. - "disableProfileValidation": True or False, # Whether to disable profile validation for this FHIR store. Set this to true to disable checking incoming resources for conformance against StructureDefinitions in this FHIR store. - "disableReferenceTypeValidation": True or False, # Whether to disable reference type validation for incoming resources. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. - "disableRequiredFieldValidation": True or False, # Whether to disable required fields validation for incoming resources. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableFhirpathValidation": True or False, # Whether to disable FHIRPath validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableProfileValidation": True or False, # Whether to disable profile validation for this FHIR store. The default value is false. Set this to true to disable checking incoming resources for conformance against StructureDefinitions in this FHIR store. + "disableReferenceTypeValidation": True or False, # Whether to disable reference type validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableRequiredFieldValidation": True or False, # Whether to disable required fields validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. "enabledImplementationGuides": [ # A list of ImplementationGuide URLs in this FHIR store that are used to configure the profiles to use for validation. For example, to use the US Core profiles for validation, set `enabled_implementation_guides` to `["http://hl7.org/fhir/us/core/ImplementationGuide/ig"]`. If `enabled_implementation_guides` is empty or omitted, then incoming resources are only required to conform to the base FHIR profiles. Otherwise, a resource must conform to at least one profile listed in the `global` property of one of the enabled ImplementationGuides. The Cloud Healthcare API does not currently enforce all of the rules in a StructureDefinition. The following rules are supported: - min/max - minValue/maxValue - maxLength - type - fixed[x] - pattern[x] on simple types - slicing, when using "value" as the discriminator type When a URL cannot be resolved (for example, in a type assertion), the server does not return an error. "A String", ], @@ -2370,7 +2370,7 @@

Method Details

"accessDeterminationLogConfig": { # Configures consent audit log config for FHIR create, read, update, and delete (CRUD) operations. Cloud audit log for healthcare API must be [enabled](https://cloud.google.com/logging/docs/audit/configure-data-access#config-console-enable). The consent-related logs are included as part of `protoPayload.metadata`. # Optional. Specifies how the server logs the consent-aware requests. If not specified, the `AccessDeterminationLogConfig.LogLevel.MINIMUM` option is used. "logLevel": "A String", # Optional. Controls the amount of detail to include as part of the audit logs. }, - "accessEnforced": True or False, # Optional. If set to true, when accessing FHIR resources, the consent headers will be verified against consents given by patients. See the ConsentEnforcementVersion for the supported consent headers. + "accessEnforced": True or False, # Optional. The default value is false. If set to true, when accessing FHIR resources, the consent headers will be verified against consents given by patients. See the ConsentEnforcementVersion for the supported consent headers. "consentHeaderHandling": { # How the server handles the consent header. # Optional. Different options to configure the behaviour of the server when handling the `X-Consent-Scope` header. "profile": "A String", # Optional. Specifies the default server behavior when the header is empty. If not specified, the `ScopeProfile.PERMIT_EMPTY_SCOPE` option is used. }, @@ -2379,11 +2379,11 @@

Method Details

], "version": "A String", # Required. Specifies which consent enforcement version is being used for this FHIR store. This field can only be set once by either CreateFhirStore or UpdateFhirStore. After that, you must call ApplyConsents to change the version. }, - "defaultSearchHandlingStrict": True or False, # If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. + "defaultSearchHandlingStrict": True or False, # If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. Defaults to false. "disableReferentialIntegrity": True or False, # Immutable. Whether to disable referential integrity in this FHIR store. This field is immutable after FHIR store creation. The default value is false, meaning that the API enforces referential integrity and fails the requests that result in inconsistent state in the FHIR store. When this field is set to true, the API skips referential integrity checks. Consequently, operations that rely on references, such as GetPatientEverything, do not return all the results if broken references exist. - "disableResourceVersioning": True or False, # Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, which is the default behavior, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. - "enableHistoryModifications": True or False, # Optional. Whether to allow ExecuteBundle to accept history bundles, and directly insert and overwrite historical resource versions into the FHIR store. If set to false, using history bundles fails with an error. - "enableUpdateCreate": True or False, # Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. + "disableResourceVersioning": True or False, # Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. Defaults to false. + "enableHistoryModifications": True or False, # Optional. Whether to allow ExecuteBundle to accept history bundles, and directly insert and overwrite historical resource versions into the FHIR store. If set to false, using history bundles fails with an error. Defaults to false. + "enableUpdateCreate": True or False, # Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. Defaults to false. "labels": { # User-supplied key-value pairs used to organize FHIR stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store. "a_key": "A String", }, @@ -2395,8 +2395,8 @@

Method Details

"notificationConfigs": [ # Specifies where and whether to send notifications upon changes to a Fhir store. { # Contains the configuration for FHIR notifications. "pubsubTopic": "A String", # The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. The notification is a `PubsubMessage` with the following fields: * `PubsubMessage.Data` contains the resource name. * `PubsubMessage.MessageId` is the ID of this notification. It is guaranteed to be unique within the topic. * `PubsubMessage.PublishTime` is the time when the message was published. Note that notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. The Cloud Healthcare API service account, service-@gcp-sa-healthcare.iam.gserviceaccount.com, must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail (https://cloud.google.com/healthcare-api/docs/permissions-healthcare-api-gcp-products#dicom_fhir_and_hl7v2_store_cloud_pubsub_permissions). If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare-api/docs/how-tos/logging). - "sendFullResource": True or False, # Whether to send full FHIR resource to this Pub/Sub topic for Create and Update operation. Note that setting this to true does not guarantee that all resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full resource as a separate operation. - "sendPreviousResourceOnDelete": True or False, # Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation. + "sendFullResource": True or False, # Whether to send full FHIR resource to this Pub/Sub topic for Create and Update operation. The default value is false. Note that setting this to true does not guarantee that all resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full resource as a separate operation. + "sendPreviousResourceOnDelete": True or False, # Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. The default value is false. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation. }, ], "searchConfig": { # Contains the configuration for FHIR search. # Configuration for how FHIR resources can be searched. @@ -2621,7 +2621,7 @@

Method Details

}, ], }, - "useRegionalDataProcessing": True or False, # Ensures in-flight data remains in the region of origin during de-identification. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. If the deprecated DicomConfig or FhirConfig are used, then `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. + "useRegionalDataProcessing": True or False, # Ensures in-flight data remains in the region of origin during de-identification. The default value is false. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. If the deprecated DicomConfig or FhirConfig are used, then `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. }, "store": "A String", # The full resource name of a Cloud Healthcare FHIR store, for example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. }, @@ -2631,10 +2631,10 @@

Method Details

}, ], "validationConfig": { # Contains the configuration for FHIR profiles and validation. # Configuration for how to validate incoming FHIR resources against configured profiles. - "disableFhirpathValidation": True or False, # Whether to disable FHIRPath validation for incoming resources. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. - "disableProfileValidation": True or False, # Whether to disable profile validation for this FHIR store. Set this to true to disable checking incoming resources for conformance against StructureDefinitions in this FHIR store. - "disableReferenceTypeValidation": True or False, # Whether to disable reference type validation for incoming resources. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. - "disableRequiredFieldValidation": True or False, # Whether to disable required fields validation for incoming resources. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableFhirpathValidation": True or False, # Whether to disable FHIRPath validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableProfileValidation": True or False, # Whether to disable profile validation for this FHIR store. The default value is false. Set this to true to disable checking incoming resources for conformance against StructureDefinitions in this FHIR store. + "disableReferenceTypeValidation": True or False, # Whether to disable reference type validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableRequiredFieldValidation": True or False, # Whether to disable required fields validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. "enabledImplementationGuides": [ # A list of ImplementationGuide URLs in this FHIR store that are used to configure the profiles to use for validation. For example, to use the US Core profiles for validation, set `enabled_implementation_guides` to `["http://hl7.org/fhir/us/core/ImplementationGuide/ig"]`. If `enabled_implementation_guides` is empty or omitted, then incoming resources are only required to conform to the base FHIR profiles. Otherwise, a resource must conform to at least one profile listed in the `global` property of one of the enabled ImplementationGuides. The Cloud Healthcare API does not currently enforce all of the rules in a StructureDefinition. The following rules are supported: - min/max - minValue/maxValue - maxLength - type - fixed[x] - pattern[x] on simple types - slicing, when using "value" as the discriminator type When a URL cannot be resolved (for example, in a type assertion), the server does not return an error. "A String", ], diff --git a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.html b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.html index 91ac690d1ec..d8f7c006902 100644 --- a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.html +++ b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.html @@ -403,7 +403,7 @@

Method Details

}, ], }, - "useRegionalDataProcessing": True or False, # Ensures in-flight data remains in the region of origin during de-identification. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. If the deprecated DicomConfig or FhirConfig are used, then `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. + "useRegionalDataProcessing": True or False, # Ensures in-flight data remains in the region of origin during de-identification. The default value is false. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. If the deprecated DicomConfig or FhirConfig are used, then `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. }, "destinationDataset": "A String", # Required. The name of the dataset resource to create and write the redacted data to. * The destination dataset must not exist. * The destination dataset must be in the same location as the source dataset. De-identifying data across multiple locations is not supported. "gcsConfigUri": "A String", # Cloud Storage location to read the JSON cloud.healthcare.deidentify.DeidentifyConfig from, overriding the default config. Must be of the form `gs://{bucket_id}/path/to/object`. The Cloud Storage location must grant the Cloud IAM role `roles/storage.objectViewer` to the project's Cloud Healthcare Service Agent service account. Only one of `config` and `gcs_config_uri` can be specified. diff --git a/docs/dyn/iam_v1.organizations.roles.html b/docs/dyn/iam_v1.organizations.roles.html index e24617f8b56..d2fd7ed9885 100644 --- a/docs/dyn/iam_v1.organizations.roles.html +++ b/docs/dyn/iam_v1.organizations.roles.html @@ -82,7 +82,7 @@

Instance Methods

Creates a new custom Role.

delete(name, etag=None, x__xgafv=None)

-

Deletes a custom Role. When you delete a custom role, the following changes occur immediately: * You cannot bind a principal to the custom role in an IAM Policy. * Existing bindings to the custom role are not changed, but they have no effect. * By default, the response from ListRoles does not include the custom role. You have 7 days to undelete the custom role. After 7 days, the following changes occur: * The custom role is permanently deleted and cannot be recovered. * If an IAM policy contains a binding to the custom role, the binding is permanently removed.

+

Deletes a custom Role. When you delete a custom role, the following changes occur immediately: * You cannot bind a principal to the custom role in an IAM Policy. * Existing bindings to the custom role are not changed, but they have no effect. * By default, the response from ListRoles does not include the custom role. A deleted custom role still counts toward the [custom role limit](/iam/quotas#limits) until it is permanently deleted. You have 7 days to undelete the custom role. After 7 days, the following changes occur: * The custom role is permanently deleted and cannot be recovered. * If an IAM policy contains a binding to the custom role, the binding is permanently removed. * The custom role no longer counts toward your custom role limit.

get(name, x__xgafv=None)

Gets the definition of a Role.

@@ -151,7 +151,7 @@

Method Details

delete(name, etag=None, x__xgafv=None) -
Deletes a custom Role. When you delete a custom role, the following changes occur immediately: * You cannot bind a principal to the custom role in an IAM Policy. * Existing bindings to the custom role are not changed, but they have no effect. * By default, the response from ListRoles does not include the custom role. You have 7 days to undelete the custom role. After 7 days, the following changes occur: * The custom role is permanently deleted and cannot be recovered. * If an IAM policy contains a binding to the custom role, the binding is permanently removed.
+  
Deletes a custom Role. When you delete a custom role, the following changes occur immediately: * You cannot bind a principal to the custom role in an IAM Policy. * Existing bindings to the custom role are not changed, but they have no effect. * By default, the response from ListRoles does not include the custom role. A deleted custom role still counts toward the [custom role limit](/iam/quotas#limits) until it is permanently deleted. You have 7 days to undelete the custom role. After 7 days, the following changes occur: * The custom role is permanently deleted and cannot be recovered. * If an IAM policy contains a binding to the custom role, the binding is permanently removed. * The custom role no longer counts toward your custom role limit.
 
 Args:
   name: string, The `name` parameter's value depends on the target resource for the request, namely [projects](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles) or [organizations](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each resource type's `name` value format is described below: * [projects.roles.delete](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/delete): `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method deletes only [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the project level. Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` * [organizations.roles.delete](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/delete): `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method deletes only [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the organization level. Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID. (required)
diff --git a/docs/dyn/iam_v1.projects.roles.html b/docs/dyn/iam_v1.projects.roles.html
index 586f98ae8dd..2383f955582 100644
--- a/docs/dyn/iam_v1.projects.roles.html
+++ b/docs/dyn/iam_v1.projects.roles.html
@@ -82,7 +82,7 @@ 

Instance Methods

Creates a new custom Role.

delete(name, etag=None, x__xgafv=None)

-

Deletes a custom Role. When you delete a custom role, the following changes occur immediately: * You cannot bind a principal to the custom role in an IAM Policy. * Existing bindings to the custom role are not changed, but they have no effect. * By default, the response from ListRoles does not include the custom role. You have 7 days to undelete the custom role. After 7 days, the following changes occur: * The custom role is permanently deleted and cannot be recovered. * If an IAM policy contains a binding to the custom role, the binding is permanently removed.

+

Deletes a custom Role. When you delete a custom role, the following changes occur immediately: * You cannot bind a principal to the custom role in an IAM Policy. * Existing bindings to the custom role are not changed, but they have no effect. * By default, the response from ListRoles does not include the custom role. A deleted custom role still counts toward the [custom role limit](/iam/quotas#limits) until it is permanently deleted. You have 7 days to undelete the custom role. After 7 days, the following changes occur: * The custom role is permanently deleted and cannot be recovered. * If an IAM policy contains a binding to the custom role, the binding is permanently removed. * The custom role no longer counts toward your custom role limit.

get(name, x__xgafv=None)

Gets the definition of a Role.

@@ -151,7 +151,7 @@

Method Details

delete(name, etag=None, x__xgafv=None) -
Deletes a custom Role. When you delete a custom role, the following changes occur immediately: * You cannot bind a principal to the custom role in an IAM Policy. * Existing bindings to the custom role are not changed, but they have no effect. * By default, the response from ListRoles does not include the custom role. You have 7 days to undelete the custom role. After 7 days, the following changes occur: * The custom role is permanently deleted and cannot be recovered. * If an IAM policy contains a binding to the custom role, the binding is permanently removed.
+  
Deletes a custom Role. When you delete a custom role, the following changes occur immediately: * You cannot bind a principal to the custom role in an IAM Policy. * Existing bindings to the custom role are not changed, but they have no effect. * By default, the response from ListRoles does not include the custom role. A deleted custom role still counts toward the [custom role limit](/iam/quotas#limits) until it is permanently deleted. You have 7 days to undelete the custom role. After 7 days, the following changes occur: * The custom role is permanently deleted and cannot be recovered. * If an IAM policy contains a binding to the custom role, the binding is permanently removed. * The custom role no longer counts toward your custom role limit.
 
 Args:
   name: string, The `name` parameter's value depends on the target resource for the request, namely [projects](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles) or [organizations](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each resource type's `name` value format is described below: * [projects.roles.delete](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/delete): `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method deletes only [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the project level. Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` * [organizations.roles.delete](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/delete): `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method deletes only [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the organization level. Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID. (required)
diff --git a/docs/dyn/iam_v1.projects.serviceAccounts.keys.html b/docs/dyn/iam_v1.projects.serviceAccounts.keys.html
index 208dda47cf7..39ceb9dee30 100644
--- a/docs/dyn/iam_v1.projects.serviceAccounts.keys.html
+++ b/docs/dyn/iam_v1.projects.serviceAccounts.keys.html
@@ -95,9 +95,6 @@ 

Instance Methods

list(name, keyTypes=None, x__xgafv=None)

Lists every ServiceAccountKey for a service account.

-

- patch(name, body=None, x__xgafv=None)

-

Patches a ServiceAccountKey.

upload(name, body=None, x__xgafv=None)

Uploads the public key portion of a key pair that you manage, and associates the public key with a ServiceAccount. After you upload the public key, you can use the private key from the key pair as a service account key.

@@ -130,9 +127,6 @@

Method Details

An object of the form: { # Represents a service account key. A service account has two sets of key-pairs: user-managed, and system-managed. User-managed key-pairs can be created and deleted by users. Users are responsible for rotating these keys periodically to ensure security of their service accounts. Users retain the private key of these key-pairs, and Google retains ONLY the public key. System-managed keys are automatically rotated by Google, and are used for signing for a maximum of two weeks. The rotation process is probabilistic, and usage of the new key will gradually ramp up and down over the key's lifetime. If you cache the public key set for a service account, we recommend that you update the cache every 15 minutes. User-managed keys can be added and removed at any time, so it is important to update the cache frequently. For Google-managed keys, Google will publish a key at least 6 hours before it is first used for signing and will keep publishing it for at least 6 hours after it was last used for signing. Public keys for all service accounts are also published at the OAuth2 Service Account API. - "contact": "A String", # Optional. A user provided email address as the point of contact for this service account key. Must be an email address. Limit 64 characters. - "creator": "A String", # Output only. The cloud identity that created this service account key. Populated automatically when the key is created and not editable by the user. - "description": "A String", # Optional. A user provided description of this service account key. "disableReason": "A String", # Output only. optional. If the key is disabled, it may have a DisableReason describing why it was disabled. "disabled": True or False, # The key status. "extendedStatus": [ # Output only. Extended Status provides permanent information about a service account key. For example, if this key was detected as exposed or compromised, that information will remain for the lifetime of the key in the extended_status. @@ -241,9 +235,6 @@

Method Details

An object of the form: { # Represents a service account key. A service account has two sets of key-pairs: user-managed, and system-managed. User-managed key-pairs can be created and deleted by users. Users are responsible for rotating these keys periodically to ensure security of their service accounts. Users retain the private key of these key-pairs, and Google retains ONLY the public key. System-managed keys are automatically rotated by Google, and are used for signing for a maximum of two weeks. The rotation process is probabilistic, and usage of the new key will gradually ramp up and down over the key's lifetime. If you cache the public key set for a service account, we recommend that you update the cache every 15 minutes. User-managed keys can be added and removed at any time, so it is important to update the cache frequently. For Google-managed keys, Google will publish a key at least 6 hours before it is first used for signing and will keep publishing it for at least 6 hours after it was last used for signing. Public keys for all service accounts are also published at the OAuth2 Service Account API. - "contact": "A String", # Optional. A user provided email address as the point of contact for this service account key. Must be an email address. Limit 64 characters. - "creator": "A String", # Output only. The cloud identity that created this service account key. Populated automatically when the key is created and not editable by the user. - "description": "A String", # Optional. A user provided description of this service account key. "disableReason": "A String", # Output only. optional. If the key is disabled, it may have a DisableReason describing why it was disabled. "disabled": True or False, # The key status. "extendedStatus": [ # Output only. Extended Status provides permanent information about a service account key. For example, if this key was detected as exposed or compromised, that information will remain for the lifetime of the key in the extended_status. @@ -286,9 +277,6 @@

Method Details

{ # The service account keys list response. "keys": [ # The public keys for the service account. { # Represents a service account key. A service account has two sets of key-pairs: user-managed, and system-managed. User-managed key-pairs can be created and deleted by users. Users are responsible for rotating these keys periodically to ensure security of their service accounts. Users retain the private key of these key-pairs, and Google retains ONLY the public key. System-managed keys are automatically rotated by Google, and are used for signing for a maximum of two weeks. The rotation process is probabilistic, and usage of the new key will gradually ramp up and down over the key's lifetime. If you cache the public key set for a service account, we recommend that you update the cache every 15 minutes. User-managed keys can be added and removed at any time, so it is important to update the cache frequently. For Google-managed keys, Google will publish a key at least 6 hours before it is first used for signing and will keep publishing it for at least 6 hours after it was last used for signing. Public keys for all service accounts are also published at the OAuth2 Service Account API. - "contact": "A String", # Optional. A user provided email address as the point of contact for this service account key. Must be an email address. Limit 64 characters. - "creator": "A String", # Output only. The cloud identity that created this service account key. Populated automatically when the key is created and not editable by the user. - "description": "A String", # Optional. A user provided description of this service account key. "disableReason": "A String", # Output only. optional. If the key is disabled, it may have a DisableReason describing why it was disabled. "disabled": True or False, # The key status. "extendedStatus": [ # Output only. Extended Status provides permanent information about a service account key. For example, if this key was detected as exposed or compromised, that information will remain for the lifetime of the key in the extended_status. @@ -311,73 +299,6 @@

Method Details

}
-
- patch(name, body=None, x__xgafv=None) -
Patches a ServiceAccountKey.
-
-Args:
-  name: string, The resource name of the service account key in the following format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}`. (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # The service account key patch request.
-  "serviceAccountKey": { # Represents a service account key. A service account has two sets of key-pairs: user-managed, and system-managed. User-managed key-pairs can be created and deleted by users. Users are responsible for rotating these keys periodically to ensure security of their service accounts. Users retain the private key of these key-pairs, and Google retains ONLY the public key. System-managed keys are automatically rotated by Google, and are used for signing for a maximum of two weeks. The rotation process is probabilistic, and usage of the new key will gradually ramp up and down over the key's lifetime. If you cache the public key set for a service account, we recommend that you update the cache every 15 minutes. User-managed keys can be added and removed at any time, so it is important to update the cache frequently. For Google-managed keys, Google will publish a key at least 6 hours before it is first used for signing and will keep publishing it for at least 6 hours after it was last used for signing. Public keys for all service accounts are also published at the OAuth2 Service Account API. # Required. The service account key to update.
-    "contact": "A String", # Optional. A user provided email address as the point of contact for this service account key. Must be an email address. Limit 64 characters.
-    "creator": "A String", # Output only. The cloud identity that created this service account key. Populated automatically when the key is created and not editable by the user.
-    "description": "A String", # Optional. A user provided description of this service account key.
-    "disableReason": "A String", # Output only. optional. If the key is disabled, it may have a DisableReason describing why it was disabled.
-    "disabled": True or False, # The key status.
-    "extendedStatus": [ # Output only. Extended Status provides permanent information about a service account key. For example, if this key was detected as exposed or compromised, that information will remain for the lifetime of the key in the extended_status.
-      { # Extended status can store additional metadata. For example, for keys disabled due to their private key data being expoesed we may include a message with more information about the exposure.
-        "key": "A String", # The key for this extended status.
-        "value": "A String", # The value for the extended status.
-      },
-    ],
-    "keyAlgorithm": "A String", # Specifies the algorithm (and possibly key size) for the key.
-    "keyOrigin": "A String", # The key origin.
-    "keyType": "A String", # The key type.
-    "name": "A String", # The resource name of the service account key in the following format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}`.
-    "privateKeyData": "A String", # The private key data. Only provided in `CreateServiceAccountKey` responses. Make sure to keep the private key data secure because it allows for the assertion of the service account identity. When base64 decoded, the private key data can be used to authenticate with Google API client libraries and with gcloud auth activate-service-account.
-    "privateKeyType": "A String", # The output format for the private key. Only provided in `CreateServiceAccountKey` responses, not in `GetServiceAccountKey` or `ListServiceAccountKey` responses. Google never exposes system-managed private keys, and never retains user-managed private keys.
-    "publicKeyData": "A String", # The public key data. Only provided in `GetServiceAccountKey` responses.
-    "validAfterTime": "A String", # The key can be used after this timestamp.
-    "validBeforeTime": "A String", # The key can be used before this timestamp. For system-managed key pairs, this timestamp is the end time for the private key signing operation. The public key could still be used for verification for a few hours after this time.
-  },
-  "updateMask": "A String", # Required. The update mask to apply to the service account key. Only the following fields are eligible for patching: - contact - description
-}
-
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Represents a service account key. A service account has two sets of key-pairs: user-managed, and system-managed. User-managed key-pairs can be created and deleted by users. Users are responsible for rotating these keys periodically to ensure security of their service accounts. Users retain the private key of these key-pairs, and Google retains ONLY the public key. System-managed keys are automatically rotated by Google, and are used for signing for a maximum of two weeks. The rotation process is probabilistic, and usage of the new key will gradually ramp up and down over the key's lifetime. If you cache the public key set for a service account, we recommend that you update the cache every 15 minutes. User-managed keys can be added and removed at any time, so it is important to update the cache frequently. For Google-managed keys, Google will publish a key at least 6 hours before it is first used for signing and will keep publishing it for at least 6 hours after it was last used for signing. Public keys for all service accounts are also published at the OAuth2 Service Account API.
-  "contact": "A String", # Optional. A user provided email address as the point of contact for this service account key. Must be an email address. Limit 64 characters.
-  "creator": "A String", # Output only. The cloud identity that created this service account key. Populated automatically when the key is created and not editable by the user.
-  "description": "A String", # Optional. A user provided description of this service account key.
-  "disableReason": "A String", # Output only. optional. If the key is disabled, it may have a DisableReason describing why it was disabled.
-  "disabled": True or False, # The key status.
-  "extendedStatus": [ # Output only. Extended Status provides permanent information about a service account key. For example, if this key was detected as exposed or compromised, that information will remain for the lifetime of the key in the extended_status.
-    { # Extended status can store additional metadata. For example, for keys disabled due to their private key data being expoesed we may include a message with more information about the exposure.
-      "key": "A String", # The key for this extended status.
-      "value": "A String", # The value for the extended status.
-    },
-  ],
-  "keyAlgorithm": "A String", # Specifies the algorithm (and possibly key size) for the key.
-  "keyOrigin": "A String", # The key origin.
-  "keyType": "A String", # The key type.
-  "name": "A String", # The resource name of the service account key in the following format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}`.
-  "privateKeyData": "A String", # The private key data. Only provided in `CreateServiceAccountKey` responses. Make sure to keep the private key data secure because it allows for the assertion of the service account identity. When base64 decoded, the private key data can be used to authenticate with Google API client libraries and with gcloud auth activate-service-account.
-  "privateKeyType": "A String", # The output format for the private key. Only provided in `CreateServiceAccountKey` responses, not in `GetServiceAccountKey` or `ListServiceAccountKey` responses. Google never exposes system-managed private keys, and never retains user-managed private keys.
-  "publicKeyData": "A String", # The public key data. Only provided in `GetServiceAccountKey` responses.
-  "validAfterTime": "A String", # The key can be used after this timestamp.
-  "validBeforeTime": "A String", # The key can be used before this timestamp. For system-managed key pairs, this timestamp is the end time for the private key signing operation. The public key could still be used for verification for a few hours after this time.
-}
-
-
upload(name, body=None, x__xgafv=None)
Uploads the public key portion of a key pair that you manage, and associates the public key with a ServiceAccount. After you upload the public key, you can use the private key from the key pair as a service account key.
@@ -400,9 +321,6 @@ 

Method Details

An object of the form: { # Represents a service account key. A service account has two sets of key-pairs: user-managed, and system-managed. User-managed key-pairs can be created and deleted by users. Users are responsible for rotating these keys periodically to ensure security of their service accounts. Users retain the private key of these key-pairs, and Google retains ONLY the public key. System-managed keys are automatically rotated by Google, and are used for signing for a maximum of two weeks. The rotation process is probabilistic, and usage of the new key will gradually ramp up and down over the key's lifetime. If you cache the public key set for a service account, we recommend that you update the cache every 15 minutes. User-managed keys can be added and removed at any time, so it is important to update the cache frequently. For Google-managed keys, Google will publish a key at least 6 hours before it is first used for signing and will keep publishing it for at least 6 hours after it was last used for signing. Public keys for all service accounts are also published at the OAuth2 Service Account API. - "contact": "A String", # Optional. A user provided email address as the point of contact for this service account key. Must be an email address. Limit 64 characters. - "creator": "A String", # Output only. The cloud identity that created this service account key. Populated automatically when the key is created and not editable by the user. - "description": "A String", # Optional. A user provided description of this service account key. "disableReason": "A String", # Output only. optional. If the key is disabled, it may have a DisableReason describing why it was disabled. "disabled": True or False, # The key status. "extendedStatus": [ # Output only. Extended Status provides permanent information about a service account key. For example, if this key was detected as exposed or compromised, that information will remain for the lifetime of the key in the extended_status. diff --git a/docs/dyn/index.md b/docs/dyn/index.md index 059ad88ad4f..4a7ce03a070 100644 --- a/docs/dyn/index.md +++ b/docs/dyn/index.md @@ -50,6 +50,7 @@ ## adsenseplatform +* [v1](http://googleapis.github.io/google-api-python-client/docs/dyn/adsenseplatform_v1.html) * [v1alpha](http://googleapis.github.io/google-api-python-client/docs/dyn/adsenseplatform_v1alpha.html) @@ -163,6 +164,7 @@ ## authorizedbuyersmarketplace * [v1](http://googleapis.github.io/google-api-python-client/docs/dyn/authorizedbuyersmarketplace_v1.html) +* [v1alpha](http://googleapis.github.io/google-api-python-client/docs/dyn/authorizedbuyersmarketplace_v1alpha.html) ## backupdr @@ -547,10 +549,6 @@ * [v1beta1](http://googleapis.github.io/google-api-python-client/docs/dyn/domains_v1beta1.html) -## domainsrdap -* [v1](http://googleapis.github.io/google-api-python-client/docs/dyn/domainsrdap_v1.html) - - ## doubleclickbidmanager * [v2](http://googleapis.github.io/google-api-python-client/docs/dyn/doubleclickbidmanager_v2.html) diff --git a/docs/dyn/manufacturers_v1.accounts.languages.productCertifications.html b/docs/dyn/manufacturers_v1.accounts.languages.productCertifications.html index 3e0fba6088f..c718ebf7113 100644 --- a/docs/dyn/manufacturers_v1.accounts.languages.productCertifications.html +++ b/docs/dyn/manufacturers_v1.accounts.languages.productCertifications.html @@ -154,6 +154,9 @@

Method Details

], "issues": [ # Output only. A server-generated list of issues associated with the product. { # Product issue. + "applicableCountries": [ # Output only. List of country codes (ISO 3166-1 alpha-2) where issue applies to the manufacturer product. + "A String", + ], "attribute": "A String", # If present, the attribute that triggered the issue. For more information about attributes, see https://support.google.com/manufacturers/answer/6124116. "description": "A String", # Longer description of the issue focused on how to resolve it. "destination": "A String", # The destination this issue applies to. @@ -221,6 +224,9 @@

Method Details

], "issues": [ # Output only. A server-generated list of issues associated with the product. { # Product issue. + "applicableCountries": [ # Output only. List of country codes (ISO 3166-1 alpha-2) where issue applies to the manufacturer product. + "A String", + ], "attribute": "A String", # If present, the attribute that triggered the issue. For more information about attributes, see https://support.google.com/manufacturers/answer/6124116. "description": "A String", # Longer description of the issue focused on how to resolve it. "destination": "A String", # The destination this issue applies to. @@ -294,6 +300,9 @@

Method Details

], "issues": [ # Output only. A server-generated list of issues associated with the product. { # Product issue. + "applicableCountries": [ # Output only. List of country codes (ISO 3166-1 alpha-2) where issue applies to the manufacturer product. + "A String", + ], "attribute": "A String", # If present, the attribute that triggered the issue. For more information about attributes, see https://support.google.com/manufacturers/answer/6124116. "description": "A String", # Longer description of the issue focused on how to resolve it. "destination": "A String", # The destination this issue applies to. @@ -350,6 +359,9 @@

Method Details

], "issues": [ # Output only. A server-generated list of issues associated with the product. { # Product issue. + "applicableCountries": [ # Output only. List of country codes (ISO 3166-1 alpha-2) where issue applies to the manufacturer product. + "A String", + ], "attribute": "A String", # If present, the attribute that triggered the issue. For more information about attributes, see https://support.google.com/manufacturers/answer/6124116. "description": "A String", # Longer description of the issue focused on how to resolve it. "destination": "A String", # The destination this issue applies to. diff --git a/docs/dyn/manufacturers_v1.accounts.products.html b/docs/dyn/manufacturers_v1.accounts.products.html index 48fbc73fcb9..adfe5f69c57 100644 --- a/docs/dyn/manufacturers_v1.accounts.products.html +++ b/docs/dyn/manufacturers_v1.accounts.products.html @@ -381,6 +381,9 @@

Method Details

], "issues": [ # A server-generated list of issues associated with the product. { # Product issue. + "applicableCountries": [ # Output only. List of country codes (ISO 3166-1 alpha-2) where issue applies to the manufacturer product. + "A String", + ], "attribute": "A String", # If present, the attribute that triggered the issue. For more information about attributes, see https://support.google.com/manufacturers/answer/6124116. "description": "A String", # Longer description of the issue focused on how to resolve it. "destination": "A String", # The destination this issue applies to. @@ -666,6 +669,9 @@

Method Details

], "issues": [ # A server-generated list of issues associated with the product. { # Product issue. + "applicableCountries": [ # Output only. List of country codes (ISO 3166-1 alpha-2) where issue applies to the manufacturer product. + "A String", + ], "attribute": "A String", # If present, the attribute that triggered the issue. For more information about attributes, see https://support.google.com/manufacturers/answer/6124116. "description": "A String", # Longer description of the issue focused on how to resolve it. "destination": "A String", # The destination this issue applies to. diff --git a/docs/dyn/meet_v2.spaces.html b/docs/dyn/meet_v2.spaces.html index 9512ee26de6..d7f913b2575 100644 --- a/docs/dyn/meet_v2.spaces.html +++ b/docs/dyn/meet_v2.spaces.html @@ -82,13 +82,13 @@

Instance Methods

Creates a space.

endActiveConference(name, body=None, x__xgafv=None)

-

Ends an active conference (if there's one).

+

Ends an active conference (if there's one). For an example, see [End active conference](https://developers.google.com/meet/api/guides/meeting-spaces#end-active-conference).

get(name, x__xgafv=None)

-

Gets a space by `space_id` or `meeting_code`.

+

Gets details about a meeting space. For an example, see [Get a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#get-meeting-space).

patch(name, body=None, updateMask=None, x__xgafv=None)

-

Updates a space.

+

Updates details about a meeting space. For an example, see [Update a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#update-meeting-space).

Method Details

close() @@ -111,9 +111,9 @@

Method Details

"accessType": "A String", # Access type of the meeting space that determines who can join without knocking. Default: The user's default access settings. Controlled by the user's admin for enterprise users or RESTRICTED. "entryPointAccess": "A String", # Defines the entry points that can be used to join meetings hosted in this meeting space. Default: EntryPointAccess.ALL }, - "meetingCode": "A String", # Output only. Type friendly code to join the meeting. Format: `[a-z]+-[a-z]+-[a-z]+` such as `abc-mnop-xyz`. The maximum length is 128 characters. Can only be used as an alias of the space ID to get the space. - "meetingUri": "A String", # Output only. URI used to join meetings, such as `https://meet.google.com/abc-mnop-xyz`. - "name": "A String", # Immutable. Resource name of the space. Format: `spaces/{space}` + "meetingCode": "A String", # Output only. Type friendly unique string used to join the meeting. Format: `[a-z]+-[a-z]+-[a-z]+`. For example, `abc-mnop-xyz`. The maximum length is 128 characters. Can only be used as an alias of the space name to get the space. + "meetingUri": "A String", # Output only. URI used to join meetings consisting of `https://meet.google.com/` followed by the `meeting_code`. For example, `https://meet.google.com/abc-mnop-xyz`. + "name": "A String", # Immutable. Resource name of the space. Format: `spaces/{space}`. `{space}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. For more information, see [How Meet identifies a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space). } x__xgafv: string, V1 error format. @@ -132,18 +132,18 @@

Method Details

"accessType": "A String", # Access type of the meeting space that determines who can join without knocking. Default: The user's default access settings. Controlled by the user's admin for enterprise users or RESTRICTED. "entryPointAccess": "A String", # Defines the entry points that can be used to join meetings hosted in this meeting space. Default: EntryPointAccess.ALL }, - "meetingCode": "A String", # Output only. Type friendly code to join the meeting. Format: `[a-z]+-[a-z]+-[a-z]+` such as `abc-mnop-xyz`. The maximum length is 128 characters. Can only be used as an alias of the space ID to get the space. - "meetingUri": "A String", # Output only. URI used to join meetings, such as `https://meet.google.com/abc-mnop-xyz`. - "name": "A String", # Immutable. Resource name of the space. Format: `spaces/{space}` + "meetingCode": "A String", # Output only. Type friendly unique string used to join the meeting. Format: `[a-z]+-[a-z]+-[a-z]+`. For example, `abc-mnop-xyz`. The maximum length is 128 characters. Can only be used as an alias of the space name to get the space. + "meetingUri": "A String", # Output only. URI used to join meetings consisting of `https://meet.google.com/` followed by the `meeting_code`. For example, `https://meet.google.com/abc-mnop-xyz`. + "name": "A String", # Immutable. Resource name of the space. Format: `spaces/{space}`. `{space}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. For more information, see [How Meet identifies a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space). }
endActiveConference(name, body=None, x__xgafv=None) -
Ends an active conference (if there's one).
+  
Ends an active conference (if there's one). For an example, see [End active conference](https://developers.google.com/meet/api/guides/meeting-spaces#end-active-conference).
 
 Args:
-  name: string, Required. Resource name of the space. (required)
+  name: string, Required. Resource name of the space. Format: `spaces/{space}`. `{space}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. For more information, see [How Meet identifies a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space). (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -164,10 +164,10 @@ 

Method Details

get(name, x__xgafv=None) -
Gets a space by `space_id` or `meeting_code`.
+  
Gets details about a meeting space. For an example, see [Get a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#get-meeting-space).
 
 Args:
-  name: string, Required. Resource name of the space. (required)
+  name: string, Required. Resource name of the space. Format: `spaces/{space}` or `spaces/{meetingCode}`. `{space}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. `{meetingCode}` is an alias for the space. It's a typeable, unique character string and is non-case sensitive. For example, `abc-mnop-xyz`. The maximum length is 128 characters. A `meetingCode` shouldn't be stored long term as it can become dissociated from a meeting space and can be reused for different meeting spaces in the future. Generally, a `meetingCode` expires 365 days after last use. For more information, see [Learn about meeting codes in Google Meet](https://support.google.com/meet/answer/10710509). For more information, see [How Meet identifies a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space). (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -184,18 +184,18 @@ 

Method Details

"accessType": "A String", # Access type of the meeting space that determines who can join without knocking. Default: The user's default access settings. Controlled by the user's admin for enterprise users or RESTRICTED. "entryPointAccess": "A String", # Defines the entry points that can be used to join meetings hosted in this meeting space. Default: EntryPointAccess.ALL }, - "meetingCode": "A String", # Output only. Type friendly code to join the meeting. Format: `[a-z]+-[a-z]+-[a-z]+` such as `abc-mnop-xyz`. The maximum length is 128 characters. Can only be used as an alias of the space ID to get the space. - "meetingUri": "A String", # Output only. URI used to join meetings, such as `https://meet.google.com/abc-mnop-xyz`. - "name": "A String", # Immutable. Resource name of the space. Format: `spaces/{space}` + "meetingCode": "A String", # Output only. Type friendly unique string used to join the meeting. Format: `[a-z]+-[a-z]+-[a-z]+`. For example, `abc-mnop-xyz`. The maximum length is 128 characters. Can only be used as an alias of the space name to get the space. + "meetingUri": "A String", # Output only. URI used to join meetings consisting of `https://meet.google.com/` followed by the `meeting_code`. For example, `https://meet.google.com/abc-mnop-xyz`. + "name": "A String", # Immutable. Resource name of the space. Format: `spaces/{space}`. `{space}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. For more information, see [How Meet identifies a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space). }
patch(name, body=None, updateMask=None, x__xgafv=None) -
Updates a space.
+  
Updates details about a meeting space. For an example, see [Update a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#update-meeting-space).
 
 Args:
-  name: string, Immutable. Resource name of the space. Format: `spaces/{space}` (required)
+  name: string, Immutable. Resource name of the space. Format: `spaces/{space}`. `{space}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. For more information, see [How Meet identifies a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space). (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -207,9 +207,9 @@ 

Method Details

"accessType": "A String", # Access type of the meeting space that determines who can join without knocking. Default: The user's default access settings. Controlled by the user's admin for enterprise users or RESTRICTED. "entryPointAccess": "A String", # Defines the entry points that can be used to join meetings hosted in this meeting space. Default: EntryPointAccess.ALL }, - "meetingCode": "A String", # Output only. Type friendly code to join the meeting. Format: `[a-z]+-[a-z]+-[a-z]+` such as `abc-mnop-xyz`. The maximum length is 128 characters. Can only be used as an alias of the space ID to get the space. - "meetingUri": "A String", # Output only. URI used to join meetings, such as `https://meet.google.com/abc-mnop-xyz`. - "name": "A String", # Immutable. Resource name of the space. Format: `spaces/{space}` + "meetingCode": "A String", # Output only. Type friendly unique string used to join the meeting. Format: `[a-z]+-[a-z]+-[a-z]+`. For example, `abc-mnop-xyz`. The maximum length is 128 characters. Can only be used as an alias of the space name to get the space. + "meetingUri": "A String", # Output only. URI used to join meetings consisting of `https://meet.google.com/` followed by the `meeting_code`. For example, `https://meet.google.com/abc-mnop-xyz`. + "name": "A String", # Immutable. Resource name of the space. Format: `spaces/{space}`. `{space}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. For more information, see [How Meet identifies a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space). } updateMask: string, Optional. Field mask used to specify the fields to be updated in the space. If update_mask isn't provided, it defaults to '*' and updates all fields provided in the request, including deleting fields not set in the request. @@ -229,9 +229,9 @@

Method Details

"accessType": "A String", # Access type of the meeting space that determines who can join without knocking. Default: The user's default access settings. Controlled by the user's admin for enterprise users or RESTRICTED. "entryPointAccess": "A String", # Defines the entry points that can be used to join meetings hosted in this meeting space. Default: EntryPointAccess.ALL }, - "meetingCode": "A String", # Output only. Type friendly code to join the meeting. Format: `[a-z]+-[a-z]+-[a-z]+` such as `abc-mnop-xyz`. The maximum length is 128 characters. Can only be used as an alias of the space ID to get the space. - "meetingUri": "A String", # Output only. URI used to join meetings, such as `https://meet.google.com/abc-mnop-xyz`. - "name": "A String", # Immutable. Resource name of the space. Format: `spaces/{space}` + "meetingCode": "A String", # Output only. Type friendly unique string used to join the meeting. Format: `[a-z]+-[a-z]+-[a-z]+`. For example, `abc-mnop-xyz`. The maximum length is 128 characters. Can only be used as an alias of the space name to get the space. + "meetingUri": "A String", # Output only. URI used to join meetings consisting of `https://meet.google.com/` followed by the `meeting_code`. For example, `https://meet.google.com/abc-mnop-xyz`. + "name": "A String", # Immutable. Resource name of the space. Format: `spaces/{space}`. `{space}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. For more information, see [How Meet identifies a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space). }
diff --git a/docs/dyn/merchantapi_accounts_v1beta.accounts.termsOfServiceAgreementStates.html b/docs/dyn/merchantapi_accounts_v1beta.accounts.termsOfServiceAgreementStates.html index 1e395b2dce6..dfb4ac59f9e 100644 --- a/docs/dyn/merchantapi_accounts_v1beta.accounts.termsOfServiceAgreementStates.html +++ b/docs/dyn/merchantapi_accounts_v1beta.accounts.termsOfServiceAgreementStates.html @@ -94,7 +94,7 @@

Method Details

Returns the state of a terms of service agreement.
 
 Args:
-  name: string, Required. The resource name of the terms of service version. Format: `accounts/{account}/termsOfServiceAgreementState/{identifier}` (required)
+  name: string, Required. The resource name of the terms of service version. Format: `accounts/{account}/termsOfServiceAgreementState/{identifier}` The identifier format is: `{TermsOfServiceKind}-{country}` (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -113,7 +113,7 @@ 

Method Details

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, }, - "name": "A String", # Identifier. The resource name of the terms of service version. Format: `accounts/{account}/termsOfServiceAgreementState/{identifier}` + "name": "A String", # Identifier. The resource name of the terms of service version. Format: `accounts/{account}/termsOfServiceAgreementState/{identifier}` The identifier format is: `{TermsOfServiceKind}-{country}` For example, an identifier could be: `MERCHANT_CENTER-US` "regionCode": "A String", # Region code as defined by https://cldr.unicode.org/. This is the country the current state applies to. "required": { # Describes the terms of service which are required to be accepted. # The required terms of service "termsOfService": "A String", # The [termsOfService](google.shopping.merchant.accounts.v1main.TermsOfService) that need to be accepted. @@ -147,7 +147,7 @@

Method Details

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, }, - "name": "A String", # Identifier. The resource name of the terms of service version. Format: `accounts/{account}/termsOfServiceAgreementState/{identifier}` + "name": "A String", # Identifier. The resource name of the terms of service version. Format: `accounts/{account}/termsOfServiceAgreementState/{identifier}` The identifier format is: `{TermsOfServiceKind}-{country}` For example, an identifier could be: `MERCHANT_CENTER-US` "regionCode": "A String", # Region code as defined by https://cldr.unicode.org/. This is the country the current state applies to. "required": { # Describes the terms of service which are required to be accepted. # The required terms of service "termsOfService": "A String", # The [termsOfService](google.shopping.merchant.accounts.v1main.TermsOfService) that need to be accepted. diff --git a/docs/dyn/merchantapi_products_v1beta.accounts.productInputs.html b/docs/dyn/merchantapi_products_v1beta.accounts.productInputs.html index 782e68c5f86..062bd051fde 100644 --- a/docs/dyn/merchantapi_products_v1beta.accounts.productInputs.html +++ b/docs/dyn/merchantapi_products_v1beta.accounts.productInputs.html @@ -237,6 +237,10 @@

Method Details

"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). }, "loyaltyPoints": "A String", # The amount of loyalty points earned on a purchase. + "memberPriceEffectiveDate": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # A date range during which the item is eligible for member price. If not specified, the member price is always applicable. The date range is represented by a pair of ISO 8601 dates separated by a space, comma, or slash. + "endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end. + "startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start. + }, "price": { # The price represented as a number and currency. # The price for members of the given tier, that is, the instant discount price. Must be smaller or equal to the regular price. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). @@ -532,6 +536,10 @@

Method Details

"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). }, "loyaltyPoints": "A String", # The amount of loyalty points earned on a purchase. + "memberPriceEffectiveDate": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # A date range during which the item is eligible for member price. If not specified, the member price is always applicable. The date range is represented by a pair of ISO 8601 dates separated by a space, comma, or slash. + "endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end. + "startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start. + }, "price": { # The price represented as a number and currency. # The price for members of the given tier, that is, the instant discount price. Must be smaller or equal to the regular price. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). diff --git a/docs/dyn/merchantapi_products_v1beta.accounts.products.html b/docs/dyn/merchantapi_products_v1beta.accounts.products.html index 0ef5c8a407e..e8cd960f477 100644 --- a/docs/dyn/merchantapi_products_v1beta.accounts.products.html +++ b/docs/dyn/merchantapi_products_v1beta.accounts.products.html @@ -226,6 +226,10 @@

Method Details

"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). }, "loyaltyPoints": "A String", # The amount of loyalty points earned on a purchase. + "memberPriceEffectiveDate": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # A date range during which the item is eligible for member price. If not specified, the member price is always applicable. The date range is represented by a pair of ISO 8601 dates separated by a space, comma, or slash. + "endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end. + "startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start. + }, "price": { # The price represented as a number and currency. # The price for members of the given tier, that is, the instant discount price. Must be smaller or equal to the regular price. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). @@ -566,6 +570,10 @@

Method Details

"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). }, "loyaltyPoints": "A String", # The amount of loyalty points earned on a purchase. + "memberPriceEffectiveDate": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # A date range during which the item is eligible for member price. If not specified, the member price is always applicable. The date range is represented by a pair of ISO 8601 dates separated by a space, comma, or slash. + "endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end. + "startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start. + }, "price": { # The price represented as a number and currency. # The price for members of the given tier, that is, the instant discount price. Must be smaller or equal to the regular price. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). diff --git a/docs/dyn/migrationcenter_v1alpha1.projects.locations.preferenceSets.html b/docs/dyn/migrationcenter_v1alpha1.projects.locations.preferenceSets.html index 4487d8d0463..b23239c5367 100644 --- a/docs/dyn/migrationcenter_v1alpha1.projects.locations.preferenceSets.html +++ b/docs/dyn/migrationcenter_v1alpha1.projects.locations.preferenceSets.html @@ -172,7 +172,7 @@

Method Details

}, ], }, - "multithreading": "A String", # Optional. Preferences for multithreading support. + "multithreading": "A String", # Optional. Preferences for multithreading support on Windows Server. "osPricingPreferences": { # Pricing options for OS images. # Optional. Pricing options for OS images. "rhel": { # Pricing options of an OS image. # Optional. Pricing options for RHEL images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). @@ -389,7 +389,7 @@

Method Details

}, ], }, - "multithreading": "A String", # Optional. Preferences for multithreading support. + "multithreading": "A String", # Optional. Preferences for multithreading support on Windows Server. "osPricingPreferences": { # Pricing options for OS images. # Optional. Pricing options for OS images. "rhel": { # Pricing options of an OS image. # Optional. Pricing options for RHEL images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). @@ -546,7 +546,7 @@

Method Details

}, ], }, - "multithreading": "A String", # Optional. Preferences for multithreading support. + "multithreading": "A String", # Optional. Preferences for multithreading support on Windows Server. "osPricingPreferences": { # Pricing options for OS images. # Optional. Pricing options for OS images. "rhel": { # Pricing options of an OS image. # Optional. Pricing options for RHEL images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). @@ -711,7 +711,7 @@

Method Details

}, ], }, - "multithreading": "A String", # Optional. Preferences for multithreading support. + "multithreading": "A String", # Optional. Preferences for multithreading support on Windows Server. "osPricingPreferences": { # Pricing options for OS images. # Optional. Pricing options for OS images. "rhel": { # Pricing options of an OS image. # Optional. Pricing options for RHEL images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). diff --git a/docs/dyn/migrationcenter_v1alpha1.projects.locations.reportConfigs.reports.html b/docs/dyn/migrationcenter_v1alpha1.projects.locations.reportConfigs.reports.html index c8f77e4d0a8..bb969be8896 100644 --- a/docs/dyn/migrationcenter_v1alpha1.projects.locations.reportConfigs.reports.html +++ b/docs/dyn/migrationcenter_v1alpha1.projects.locations.reportConfigs.reports.html @@ -401,7 +401,7 @@

Method Details

}, ], }, - "multithreading": "A String", # Optional. Preferences for multithreading support. + "multithreading": "A String", # Optional. Preferences for multithreading support on Windows Server. "osPricingPreferences": { # Pricing options for OS images. # Optional. Pricing options for OS images. "rhel": { # Pricing options of an OS image. # Optional. Pricing options for RHEL images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). @@ -473,7 +473,7 @@

Method Details

"storageDeduplicationCompressionRatio": 3.14, # The Deduplication and Compression ratio is based on the logical (Used Before) space required to store data before applying deduplication and compression, in relation to the physical (Used After) space required after applying deduplication and compression. Specifically, the ratio is the Used Before space divided by the Used After space. For example, if the Used Before space is 3 GB, but the physical Used After space is 1 GB, the deduplication and compression ratio is 3x. Acceptable values are between 1.0 and 4.0. }, }, - "monthlyCostCompute": { # Represents an amount of money with its currency type. # Compute monthly cost for this preference set. + "monthlyCostCompute": { # Represents an amount of money with its currency type. # Output only. Compute monthly cost for this preference set. "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. @@ -488,27 +488,27 @@

Method Details

"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. }, - "monthlyCostNetworkEgress": { # Represents an amount of money with its currency type. # Network Egress monthly cost for this preference set. Only present for virtual machines. + "monthlyCostNetworkEgress": { # Represents an amount of money with its currency type. # Output only. Network Egress monthly cost for this preference set. Only present for virtual machines. "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. }, - "monthlyCostOsLicense": { # Represents an amount of money with its currency type. # Operating system licensing monthly cost for this preference set. Only present for virtual machines. + "monthlyCostOsLicense": { # Represents an amount of money with its currency type. # Output only. Operating system licensing monthly cost for this preference set. Only present for virtual machines. "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. }, - "monthlyCostOther": { # Represents an amount of money with its currency type. # Miscellaneous monthly cost for this preference set. + "monthlyCostOther": { # Represents an amount of money with its currency type. # Output only. Miscellaneous monthly cost for this preference set. "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. }, - "monthlyCostStorage": { # Represents an amount of money with its currency type. # Storage monthly cost for this preference set. + "monthlyCostStorage": { # Represents an amount of money with its currency type. # Output only. Storage monthly cost for this preference set. "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. }, - "monthlyCostTotal": { # Represents an amount of money with its currency type. # Total monthly cost for this preference set. + "monthlyCostTotal": { # Represents an amount of money with its currency type. # Output only. Total monthly cost for this preference set. "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. @@ -575,7 +575,7 @@

Method Details

}, ], }, - "multithreading": "A String", # Optional. Preferences for multithreading support. + "multithreading": "A String", # Optional. Preferences for multithreading support on Windows Server. "osPricingPreferences": { # Pricing options for OS images. # Optional. Pricing options for OS images. "rhel": { # Pricing options of an OS image. # Optional. Pricing options for RHEL images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). @@ -1152,7 +1152,7 @@

Method Details

}, ], }, - "multithreading": "A String", # Optional. Preferences for multithreading support. + "multithreading": "A String", # Optional. Preferences for multithreading support on Windows Server. "osPricingPreferences": { # Pricing options for OS images. # Optional. Pricing options for OS images. "rhel": { # Pricing options of an OS image. # Optional. Pricing options for RHEL images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). @@ -1224,7 +1224,7 @@

Method Details

"storageDeduplicationCompressionRatio": 3.14, # The Deduplication and Compression ratio is based on the logical (Used Before) space required to store data before applying deduplication and compression, in relation to the physical (Used After) space required after applying deduplication and compression. Specifically, the ratio is the Used Before space divided by the Used After space. For example, if the Used Before space is 3 GB, but the physical Used After space is 1 GB, the deduplication and compression ratio is 3x. Acceptable values are between 1.0 and 4.0. }, }, - "monthlyCostCompute": { # Represents an amount of money with its currency type. # Compute monthly cost for this preference set. + "monthlyCostCompute": { # Represents an amount of money with its currency type. # Output only. Compute monthly cost for this preference set. "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. @@ -1239,27 +1239,27 @@

Method Details

"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. }, - "monthlyCostNetworkEgress": { # Represents an amount of money with its currency type. # Network Egress monthly cost for this preference set. Only present for virtual machines. + "monthlyCostNetworkEgress": { # Represents an amount of money with its currency type. # Output only. Network Egress monthly cost for this preference set. Only present for virtual machines. "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. }, - "monthlyCostOsLicense": { # Represents an amount of money with its currency type. # Operating system licensing monthly cost for this preference set. Only present for virtual machines. + "monthlyCostOsLicense": { # Represents an amount of money with its currency type. # Output only. Operating system licensing monthly cost for this preference set. Only present for virtual machines. "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. }, - "monthlyCostOther": { # Represents an amount of money with its currency type. # Miscellaneous monthly cost for this preference set. + "monthlyCostOther": { # Represents an amount of money with its currency type. # Output only. Miscellaneous monthly cost for this preference set. "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. }, - "monthlyCostStorage": { # Represents an amount of money with its currency type. # Storage monthly cost for this preference set. + "monthlyCostStorage": { # Represents an amount of money with its currency type. # Output only. Storage monthly cost for this preference set. "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. }, - "monthlyCostTotal": { # Represents an amount of money with its currency type. # Total monthly cost for this preference set. + "monthlyCostTotal": { # Represents an amount of money with its currency type. # Output only. Total monthly cost for this preference set. "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. @@ -1326,7 +1326,7 @@

Method Details

}, ], }, - "multithreading": "A String", # Optional. Preferences for multithreading support. + "multithreading": "A String", # Optional. Preferences for multithreading support on Windows Server. "osPricingPreferences": { # Pricing options for OS images. # Optional. Pricing options for OS images. "rhel": { # Pricing options of an OS image. # Optional. Pricing options for RHEL images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). @@ -1844,7 +1844,7 @@

Method Details

}, ], }, - "multithreading": "A String", # Optional. Preferences for multithreading support. + "multithreading": "A String", # Optional. Preferences for multithreading support on Windows Server. "osPricingPreferences": { # Pricing options for OS images. # Optional. Pricing options for OS images. "rhel": { # Pricing options of an OS image. # Optional. Pricing options for RHEL images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). @@ -1916,7 +1916,7 @@

Method Details

"storageDeduplicationCompressionRatio": 3.14, # The Deduplication and Compression ratio is based on the logical (Used Before) space required to store data before applying deduplication and compression, in relation to the physical (Used After) space required after applying deduplication and compression. Specifically, the ratio is the Used Before space divided by the Used After space. For example, if the Used Before space is 3 GB, but the physical Used After space is 1 GB, the deduplication and compression ratio is 3x. Acceptable values are between 1.0 and 4.0. }, }, - "monthlyCostCompute": { # Represents an amount of money with its currency type. # Compute monthly cost for this preference set. + "monthlyCostCompute": { # Represents an amount of money with its currency type. # Output only. Compute monthly cost for this preference set. "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. @@ -1931,27 +1931,27 @@

Method Details

"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. }, - "monthlyCostNetworkEgress": { # Represents an amount of money with its currency type. # Network Egress monthly cost for this preference set. Only present for virtual machines. + "monthlyCostNetworkEgress": { # Represents an amount of money with its currency type. # Output only. Network Egress monthly cost for this preference set. Only present for virtual machines. "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. }, - "monthlyCostOsLicense": { # Represents an amount of money with its currency type. # Operating system licensing monthly cost for this preference set. Only present for virtual machines. + "monthlyCostOsLicense": { # Represents an amount of money with its currency type. # Output only. Operating system licensing monthly cost for this preference set. Only present for virtual machines. "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. }, - "monthlyCostOther": { # Represents an amount of money with its currency type. # Miscellaneous monthly cost for this preference set. + "monthlyCostOther": { # Represents an amount of money with its currency type. # Output only. Miscellaneous monthly cost for this preference set. "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. }, - "monthlyCostStorage": { # Represents an amount of money with its currency type. # Storage monthly cost for this preference set. + "monthlyCostStorage": { # Represents an amount of money with its currency type. # Output only. Storage monthly cost for this preference set. "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. }, - "monthlyCostTotal": { # Represents an amount of money with its currency type. # Total monthly cost for this preference set. + "monthlyCostTotal": { # Represents an amount of money with its currency type. # Output only. Total monthly cost for this preference set. "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. @@ -2018,7 +2018,7 @@

Method Details

}, ], }, - "multithreading": "A String", # Optional. Preferences for multithreading support. + "multithreading": "A String", # Optional. Preferences for multithreading support on Windows Server. "osPricingPreferences": { # Pricing options for OS images. # Optional. Pricing options for OS images. "rhel": { # Pricing options of an OS image. # Optional. Pricing options for RHEL images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). diff --git a/docs/dyn/pollen_v1.forecast.html b/docs/dyn/pollen_v1.forecast.html index e7790a78e00..8276d34d008 100644 --- a/docs/dyn/pollen_v1.forecast.html +++ b/docs/dyn/pollen_v1.forecast.html @@ -95,12 +95,12 @@

Method Details

Args: days: integer, Required. A number that indicates how many forecast days to request (minimum value 1, maximum value is 5). - languageCode: string, Optional. Allows the client to choose the language for the response. If data cannot be provided for that language the API uses the closest match. Allowed values rely on the IETF BCP-47 standard. Default value is "en". + languageCode: string, Optional. Allows the client to choose the language for the response. If data cannot be provided for that language, the API uses the closest match. Allowed values rely on the IETF BCP-47 standard. The default value is "en". location_latitude: number, The latitude in degrees. It must be in the range [-90.0, +90.0]. location_longitude: number, The longitude in degrees. It must be in the range [-180.0, +180.0]. - pageSize: integer, Optional. The maximum number of daily info records to return per page. The default and max value is 5 (5 days of data). - pageToken: string, Optional. A page token received from a previous daily call. It is used to retrieve the subsequent page. Note that when providing a value for the page token all other request parameters provided must match the previous call that provided the page token. - plantsDescription: boolean, Optional. Contains general information about plants, including details on their seasonality, special shapes and colors, information about allergic cross-reactions, and plant photos. + pageSize: integer, Optional. The maximum number of daily info records to return per page. The default and max value is 5, indicating 5 days of data. + pageToken: string, Optional. A page token received from a previous daily call. It is used to retrieve the subsequent page. Note that when providing a value for the page token, all other request parameters provided must match the previous call that provided the page token. + plantsDescription: boolean, Optional. Contains general information about plants, including details on their seasonality, special shapes and colors, information about allergic cross-reactions, and plant photos. The default value is "true". x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -117,7 +117,7 @@

Method Details

"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. }, - "plantInfo": [ # This list will include (up to) 15 pollen species affecting the location specified in the request. + "plantInfo": [ # This list will include up to 15 pollen species affecting the location specified in the request. { # This object contains the daily information on specific plant. "code": "A String", # The plant code name. For example: "COTTONWOOD". A list of all available codes could be found here. "displayName": "A String", # A human readable representation of the plant name. Example: “Cottonwood". @@ -147,7 +147,7 @@

Method Details

}, }, ], - "pollenTypeInfo": [ # This list will include (up to) three pollen types (grass, weed, tree) affecting the location specified in the request. + "pollenTypeInfo": [ # This list will include up to three pollen types (GRASS, WEED, TREE) affecting the location specified in the request. { # This object contains the pollen type index and health recommendation information on specific pollen type. "code": "A String", # The pollen type's code name. For example: "GRASS" "displayName": "A String", # A human readable representation of the pollen type name. Example: "Grass" diff --git a/docs/dyn/pollen_v1.mapTypes.heatmapTiles.html b/docs/dyn/pollen_v1.mapTypes.heatmapTiles.html index 66a67e1a368..bf7a1632267 100644 --- a/docs/dyn/pollen_v1.mapTypes.heatmapTiles.html +++ b/docs/dyn/pollen_v1.mapTypes.heatmapTiles.html @@ -96,7 +96,7 @@

Method Details

MAP_TYPE_UNSPECIFIED - Unspecified map type. TREE_UPI - The heatmap type will represent a tree index graphical map. GRASS_UPI - The heatmap type will represent a grass index graphical map. - WEED_UPI - The heatmap type will represent a weed index graphically map. + WEED_UPI - The heatmap type will represent a weed index graphical map. zoom: integer, Required. The map's zoom level. Defines how large or small the contents of a map appear in a map view. * Zoom level 0 is the entire world in a single tile. * Zoom level 1 is the entire world in 4 tiles. * Zoom level 2 is the entire world in 16 tiles. * Zoom level 16 is the entire world in 65,536 tiles. Allowed values: 0-16 (required) x: integer, Required. Defines the east-west point in the requested tile. (required) y: integer, Required. Defines the north-south point in the requested tile. (required) diff --git a/docs/dyn/recaptchaenterprise_v1.projects.assessments.html b/docs/dyn/recaptchaenterprise_v1.projects.assessments.html index e0098b8a96c..f8fab87468a 100644 --- a/docs/dyn/recaptchaenterprise_v1.projects.assessments.html +++ b/docs/dyn/recaptchaenterprise_v1.projects.assessments.html @@ -155,7 +155,7 @@

Method Details

}, "event": { # The event being assessed. # Optional. The event being assessed. "expectedAction": "A String", # Optional. The expected action for this type of event. This should be the same action provided at token generation time on client-side platforms already integrated with recaptcha enterprise. - "express": True or False, # Optional. Flag for a reCAPTCHA express request for an assessment without a token. If enabled, `site_key` must reference a SCORE key with WAF feature set to EXPRESS. + "express": True or False, # Optional. Flag for a reCAPTCHA express request for an assessment without a token. If enabled, `site_key` must reference an Express site key. "firewallPolicyEvaluation": True or False, # Optional. Flag for enabling firewall policy config assessment. If this flag is enabled, the firewall policy will be evaluated and a suggested firewall action will be returned in the response. "fraudPrevention": "A String", # Optional. The Fraud Prevention setting for this assessment. "hashedAccountId": "A String", # Optional. Deprecated: use `user_info.account_id` instead. Unique stable hashed user identifier for the request. The identifier must be hashed using hmac-sha256 with stable secret. @@ -367,7 +367,7 @@

Method Details

}, "event": { # The event being assessed. # Optional. The event being assessed. "expectedAction": "A String", # Optional. The expected action for this type of event. This should be the same action provided at token generation time on client-side platforms already integrated with recaptcha enterprise. - "express": True or False, # Optional. Flag for a reCAPTCHA express request for an assessment without a token. If enabled, `site_key` must reference a SCORE key with WAF feature set to EXPRESS. + "express": True or False, # Optional. Flag for a reCAPTCHA express request for an assessment without a token. If enabled, `site_key` must reference an Express site key. "firewallPolicyEvaluation": True or False, # Optional. Flag for enabling firewall policy config assessment. If this flag is enabled, the firewall policy will be evaluated and a suggested firewall action will be returned in the response. "fraudPrevention": "A String", # Optional. The Fraud Prevention setting for this assessment. "hashedAccountId": "A String", # Optional. Deprecated: use `user_info.account_id` instead. Unique stable hashed user identifier for the request. The identifier must be hashed using hmac-sha256 with stable secret. diff --git a/docs/dyn/recaptchaenterprise_v1.projects.keys.html b/docs/dyn/recaptchaenterprise_v1.projects.keys.html index 2d9bc53dddc..c4935c6164b 100644 --- a/docs/dyn/recaptchaenterprise_v1.projects.keys.html +++ b/docs/dyn/recaptchaenterprise_v1.projects.keys.html @@ -129,6 +129,8 @@

Method Details

}, "createTime": "A String", # Output only. The timestamp corresponding to the creation of this key. "displayName": "A String", # Required. Human-readable display name of this key. Modifiable by user. + "expressSettings": { # Settings specific to keys that can be used for reCAPTCHA Express. # Settings for keys that can be used by reCAPTCHA Express. + }, "iosSettings": { # Settings specific to keys that can be used by iOS apps. # Settings for keys that can be used by iOS apps. "allowAllBundleIds": True or False, # Optional. If set to true, allowed_bundle_ids are not enforced. "allowedBundleIds": [ # Optional. iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.productname.appname' @@ -140,7 +142,7 @@

Method Details

"teamId": "A String", # Required. The Apple team ID (10-character string) owning the provisioning profile used to build your application. }, }, - "labels": { # Optional. See [Creating and managing labels] (https://cloud.google.com/recaptcha-enterprise/docs/labels). + "labels": { # Optional. See [Creating and managing labels] (https://cloud.google.com/recaptcha/docs/labels). "a_key": "A String", }, "name": "A String", # Identifier. The resource name for the Key in the format `projects/{project}/keys/{key}`. @@ -181,6 +183,8 @@

Method Details

}, "createTime": "A String", # Output only. The timestamp corresponding to the creation of this key. "displayName": "A String", # Required. Human-readable display name of this key. Modifiable by user. + "expressSettings": { # Settings specific to keys that can be used for reCAPTCHA Express. # Settings for keys that can be used by reCAPTCHA Express. + }, "iosSettings": { # Settings specific to keys that can be used by iOS apps. # Settings for keys that can be used by iOS apps. "allowAllBundleIds": True or False, # Optional. If set to true, allowed_bundle_ids are not enforced. "allowedBundleIds": [ # Optional. iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.productname.appname' @@ -192,7 +196,7 @@

Method Details

"teamId": "A String", # Required. The Apple team ID (10-character string) owning the provisioning profile used to build your application. }, }, - "labels": { # Optional. See [Creating and managing labels] (https://cloud.google.com/recaptcha-enterprise/docs/labels). + "labels": { # Optional. See [Creating and managing labels] (https://cloud.google.com/recaptcha/docs/labels). "a_key": "A String", }, "name": "A String", # Identifier. The resource name for the Key in the format `projects/{project}/keys/{key}`. @@ -258,6 +262,8 @@

Method Details

}, "createTime": "A String", # Output only. The timestamp corresponding to the creation of this key. "displayName": "A String", # Required. Human-readable display name of this key. Modifiable by user. + "expressSettings": { # Settings specific to keys that can be used for reCAPTCHA Express. # Settings for keys that can be used by reCAPTCHA Express. + }, "iosSettings": { # Settings specific to keys that can be used by iOS apps. # Settings for keys that can be used by iOS apps. "allowAllBundleIds": True or False, # Optional. If set to true, allowed_bundle_ids are not enforced. "allowedBundleIds": [ # Optional. iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.productname.appname' @@ -269,7 +275,7 @@

Method Details

"teamId": "A String", # Required. The Apple team ID (10-character string) owning the provisioning profile used to build your application. }, }, - "labels": { # Optional. See [Creating and managing labels] (https://cloud.google.com/recaptcha-enterprise/docs/labels). + "labels": { # Optional. See [Creating and managing labels] (https://cloud.google.com/recaptcha/docs/labels). "a_key": "A String", }, "name": "A String", # Identifier. The resource name for the Key in the format `projects/{project}/keys/{key}`. @@ -365,6 +371,8 @@

Method Details

}, "createTime": "A String", # Output only. The timestamp corresponding to the creation of this key. "displayName": "A String", # Required. Human-readable display name of this key. Modifiable by user. + "expressSettings": { # Settings specific to keys that can be used for reCAPTCHA Express. # Settings for keys that can be used by reCAPTCHA Express. + }, "iosSettings": { # Settings specific to keys that can be used by iOS apps. # Settings for keys that can be used by iOS apps. "allowAllBundleIds": True or False, # Optional. If set to true, allowed_bundle_ids are not enforced. "allowedBundleIds": [ # Optional. iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.productname.appname' @@ -376,7 +384,7 @@

Method Details

"teamId": "A String", # Required. The Apple team ID (10-character string) owning the provisioning profile used to build your application. }, }, - "labels": { # Optional. See [Creating and managing labels] (https://cloud.google.com/recaptcha-enterprise/docs/labels). + "labels": { # Optional. See [Creating and managing labels] (https://cloud.google.com/recaptcha/docs/labels). "a_key": "A String", }, "name": "A String", # Identifier. The resource name for the Key in the format `projects/{project}/keys/{key}`. @@ -427,7 +435,7 @@

Method Details

The object takes the form of: { # The migrate key request message. - "skipBillingCheck": True or False, # Optional. If true, skips the billing check. A reCAPTCHA Enterprise key or migrated key behaves differently than a reCAPTCHA (non-Enterprise version) key when you reach a quota limit (see https://cloud.google.com/recaptcha-enterprise/quotas#quota_limit). To avoid any disruption of your usage, we check that a billing account is present. If your usage of reCAPTCHA is under the free quota, you can safely skip the billing check and proceed with the migration. See https://cloud.google.com/recaptcha-enterprise/docs/billing-information. + "skipBillingCheck": True or False, # Optional. If true, skips the billing check. A reCAPTCHA Enterprise key or migrated key behaves differently than a reCAPTCHA (non-Enterprise version) key when you reach a quota limit (see https://cloud.google.com/recaptcha/quotas#quota_limit). To avoid any disruption of your usage, we check that a billing account is present. If your usage of reCAPTCHA is under the free quota, you can safely skip the billing check and proceed with the migration. See https://cloud.google.com/recaptcha/docs/billing-information. } x__xgafv: string, V1 error format. @@ -448,6 +456,8 @@

Method Details

}, "createTime": "A String", # Output only. The timestamp corresponding to the creation of this key. "displayName": "A String", # Required. Human-readable display name of this key. Modifiable by user. + "expressSettings": { # Settings specific to keys that can be used for reCAPTCHA Express. # Settings for keys that can be used by reCAPTCHA Express. + }, "iosSettings": { # Settings specific to keys that can be used by iOS apps. # Settings for keys that can be used by iOS apps. "allowAllBundleIds": True or False, # Optional. If set to true, allowed_bundle_ids are not enforced. "allowedBundleIds": [ # Optional. iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.productname.appname' @@ -459,7 +469,7 @@

Method Details

"teamId": "A String", # Required. The Apple team ID (10-character string) owning the provisioning profile used to build your application. }, }, - "labels": { # Optional. See [Creating and managing labels] (https://cloud.google.com/recaptcha-enterprise/docs/labels). + "labels": { # Optional. See [Creating and managing labels] (https://cloud.google.com/recaptcha/docs/labels). "a_key": "A String", }, "name": "A String", # Identifier. The resource name for the Key in the format `projects/{project}/keys/{key}`. @@ -502,6 +512,8 @@

Method Details

}, "createTime": "A String", # Output only. The timestamp corresponding to the creation of this key. "displayName": "A String", # Required. Human-readable display name of this key. Modifiable by user. + "expressSettings": { # Settings specific to keys that can be used for reCAPTCHA Express. # Settings for keys that can be used by reCAPTCHA Express. + }, "iosSettings": { # Settings specific to keys that can be used by iOS apps. # Settings for keys that can be used by iOS apps. "allowAllBundleIds": True or False, # Optional. If set to true, allowed_bundle_ids are not enforced. "allowedBundleIds": [ # Optional. iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.productname.appname' @@ -513,7 +525,7 @@

Method Details

"teamId": "A String", # Required. The Apple team ID (10-character string) owning the provisioning profile used to build your application. }, }, - "labels": { # Optional. See [Creating and managing labels] (https://cloud.google.com/recaptcha-enterprise/docs/labels). + "labels": { # Optional. See [Creating and managing labels] (https://cloud.google.com/recaptcha/docs/labels). "a_key": "A String", }, "name": "A String", # Identifier. The resource name for the Key in the format `projects/{project}/keys/{key}`. @@ -555,6 +567,8 @@

Method Details

}, "createTime": "A String", # Output only. The timestamp corresponding to the creation of this key. "displayName": "A String", # Required. Human-readable display name of this key. Modifiable by user. + "expressSettings": { # Settings specific to keys that can be used for reCAPTCHA Express. # Settings for keys that can be used by reCAPTCHA Express. + }, "iosSettings": { # Settings specific to keys that can be used by iOS apps. # Settings for keys that can be used by iOS apps. "allowAllBundleIds": True or False, # Optional. If set to true, allowed_bundle_ids are not enforced. "allowedBundleIds": [ # Optional. iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.productname.appname' @@ -566,7 +580,7 @@

Method Details

"teamId": "A String", # Required. The Apple team ID (10-character string) owning the provisioning profile used to build your application. }, }, - "labels": { # Optional. See [Creating and managing labels] (https://cloud.google.com/recaptcha-enterprise/docs/labels). + "labels": { # Optional. See [Creating and managing labels] (https://cloud.google.com/recaptcha/docs/labels). "a_key": "A String", }, "name": "A String", # Identifier. The resource name for the Key in the format `projects/{project}/keys/{key}`. diff --git a/docs/dyn/retail_v2alpha.projects.locations.catalogs.userEvents.html b/docs/dyn/retail_v2alpha.projects.locations.catalogs.userEvents.html index 0154f88c249..83c5280d19d 100644 --- a/docs/dyn/retail_v2alpha.projects.locations.catalogs.userEvents.html +++ b/docs/dyn/retail_v2alpha.projects.locations.catalogs.userEvents.html @@ -80,6 +80,9 @@

Instance Methods

collect(parent, ets=None, prebuiltRule=None, rawJson=None, uri=None, userEvent=None, x__xgafv=None)

Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a 3rd party domain. This method is used only by the Retail API JavaScript pixel and Google Tag Manager. Users should not call this method directly.

+

+ export(parent, body=None, x__xgafv=None)

+

Exports user events. `Operation.response` is of type `ExportResponse`. `Operation.metadata` is of type `ExportMetadata`.

import_(parent, body=None, x__xgafv=None)

Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. `Operation.response` is of type `ImportResponse`. Note that it is possible for a subset of the items to be successfully inserted. `Operation.metadata` is of type `ImportMetadata`.

@@ -128,6 +131,58 @@

Method Details

}
+
+ export(parent, body=None, x__xgafv=None) +
Exports user events. `Operation.response` is of type `ExportResponse`. `Operation.metadata` is of type `ExportMetadata`.
+
+Args:
+  parent: string, Required. Resource name of a Catalog. For example `projects/1234/locations/global/catalogs/default_catalog` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for the `ExportUserEvents` method.
+  "filter": "A String", # A filtering expression to specify restrictions on returned events. The expression is a sequence of terms. Each term applies a restriction to the returned user events. Use this expression to restrict results to a specific time range or to filter events by eventType. For example, `eventTime > "2012-04-23T18:25:43.511Z" eventsMissingCatalogItems eventTime<"2012-04-23T18:25:43.511Z" eventType=search` We expect only three types of fields: * `eventTime`: This can be specified twice, once with a less than operator and once with a greater than operator. The `eventTime` restriction should result in one, contiguous, valid, `eventTime` range. * `eventType`: Boolean operators `OR` and `NOT` are supported if the expression is enclosed in parentheses and the operators are separated from the tag values by a space. * `eventsMissingCatalogItems`: This restricts results to events for which catalog items were not found in the catalog. The default behavior is to return only those events for which catalog items were found. Some examples of valid filters expressions: * Example 1: `eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z"` * Example 2: `eventTime > "2012-04-23T18:25:43.511Z" eventType = detail-page-view` * Example 3: `eventsMissingCatalogItems eventType = (NOT search) eventTime < "2018-04-23T18:30:43.511Z"` * Example 4: `eventTime > "2012-04-23T18:25:43.511Z"` * Example 5: `eventType = (detail-page-view OR search)` * Example 6: `eventsMissingCatalogItems`
+  "outputConfig": { # The output configuration setting. # Required. The output location of the data.
+    "bigqueryDestination": { # The BigQuery output destination configuration. # The BigQuery location where the output is to be written to.
+      "datasetId": "A String", # Required. The ID of a BigQuery Dataset.
+      "tableIdPrefix": "A String", # Required. The prefix of exported BigQuery tables.
+      "tableType": "A String", # Required. Describes the table type. The following values are supported: * `table`: A BigQuery native table. * `view`: A virtual table defined by a SQL query.
+    },
+    "gcsDestination": { # The Google Cloud Storage output destination configuration. # The Google Cloud Storage location where the output is to be written to.
+      "outputUriPrefix": "A String", # Required. The output uri prefix for saving output data to json files. Some mapping examples are as follows: output_uri_prefix sample output(assuming the object is foo.json) ======================== ============================================= gs://bucket/ gs://bucket/foo.json gs://bucket/folder/ gs://bucket/folder/foo.json gs://bucket/folder/item_ gs://bucket/folder/item_foo.json
+    },
+  },
+}
+
+  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.
+  },
+}
+
+
import_(parent, body=None, x__xgafv=None)
Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. `Operation.response` is of type `ImportResponse`. Note that it is possible for a subset of the items to be successfully inserted. `Operation.metadata` is of type `ImportMetadata`.
diff --git a/docs/dyn/retail_v2beta.projects.locations.catalogs.userEvents.html b/docs/dyn/retail_v2beta.projects.locations.catalogs.userEvents.html
index ff43faa6812..b9a1903e4be 100644
--- a/docs/dyn/retail_v2beta.projects.locations.catalogs.userEvents.html
+++ b/docs/dyn/retail_v2beta.projects.locations.catalogs.userEvents.html
@@ -80,6 +80,9 @@ 

Instance Methods

collect(parent, ets=None, prebuiltRule=None, rawJson=None, uri=None, userEvent=None, x__xgafv=None)

Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a 3rd party domain. This method is used only by the Retail API JavaScript pixel and Google Tag Manager. Users should not call this method directly.

+

+ export(parent, body=None, x__xgafv=None)

+

Exports user events. `Operation.response` is of type `ExportResponse`. `Operation.metadata` is of type `ExportMetadata`.

import_(parent, body=None, x__xgafv=None)

Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. `Operation.response` is of type `ImportResponse`. Note that it is possible for a subset of the items to be successfully inserted. `Operation.metadata` is of type `ImportMetadata`.

@@ -128,6 +131,58 @@

Method Details

}
+
+ export(parent, body=None, x__xgafv=None) +
Exports user events. `Operation.response` is of type `ExportResponse`. `Operation.metadata` is of type `ExportMetadata`.
+
+Args:
+  parent: string, Required. Resource name of a Catalog. For example `projects/1234/locations/global/catalogs/default_catalog` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for the `ExportUserEvents` method.
+  "filter": "A String", # A filtering expression to specify restrictions on returned events. The expression is a sequence of terms. Each term applies a restriction to the returned user events. Use this expression to restrict results to a specific time range or to filter events by eventType. For example, `eventTime > "2012-04-23T18:25:43.511Z" eventsMissingCatalogItems eventTime<"2012-04-23T18:25:43.511Z" eventType=search` We expect only three types of fields: * `eventTime`: This can be specified twice, once with a less than operator and once with a greater than operator. The `eventTime` restriction should result in one, contiguous, valid, `eventTime` range. * `eventType`: Boolean operators `OR` and `NOT` are supported if the expression is enclosed in parentheses and the operators are separated from the tag values by a space. * `eventsMissingCatalogItems`: This restricts results to events for which catalog items were not found in the catalog. The default behavior is to return only those events for which catalog items were found. Some examples of valid filters expressions: * Example 1: `eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z"` * Example 2: `eventTime > "2012-04-23T18:25:43.511Z" eventType = detail-page-view` * Example 3: `eventsMissingCatalogItems eventType = (NOT search) eventTime < "2018-04-23T18:30:43.511Z"` * Example 4: `eventTime > "2012-04-23T18:25:43.511Z"` * Example 5: `eventType = (detail-page-view OR search)` * Example 6: `eventsMissingCatalogItems`
+  "outputConfig": { # The output configuration setting. # Required. The output location of the data.
+    "bigqueryDestination": { # The BigQuery output destination configuration. # The BigQuery location where the output is to be written to.
+      "datasetId": "A String", # Required. The ID of a BigQuery Dataset.
+      "tableIdPrefix": "A String", # Required. The prefix of exported BigQuery tables.
+      "tableType": "A String", # Required. Describes the table type. The following values are supported: * `table`: A BigQuery native table. * `view`: A virtual table defined by a SQL query.
+    },
+    "gcsDestination": { # The Google Cloud Storage output destination configuration. # The Google Cloud Storage location where the output is to be written to.
+      "outputUriPrefix": "A String", # Required. The output uri prefix for saving output data to json files. Some mapping examples are as follows: output_uri_prefix sample output(assuming the object is foo.json) ======================== ============================================= gs://bucket/ gs://bucket/foo.json gs://bucket/folder/ gs://bucket/folder/foo.json gs://bucket/folder/item_ gs://bucket/folder/item_foo.json
+    },
+  },
+}
+
+  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.
+  },
+}
+
+
import_(parent, body=None, x__xgafv=None)
Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. `Operation.response` is of type `ImportResponse`. Note that it is possible for a subset of the items to be successfully inserted. `Operation.metadata` is of type `ImportMetadata`.
diff --git a/docs/dyn/run_v1.namespaces.configurations.html b/docs/dyn/run_v1.namespaces.configurations.html
index e12d81eae40..40f7617950a 100644
--- a/docs/dyn/run_v1.namespaces.configurations.html
+++ b/docs/dyn/run_v1.namespaces.configurations.html
@@ -173,7 +173,7 @@ 

Method Details

"uid": "A String", # Unique, system-generated identifier for this resource. }, "spec": { # RevisionSpec holds the desired state of the Revision (from the client). # RevisionSpec holds the desired state of the Revision (from the client). - "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified, defaults to 80. + "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1. "containers": [ # Required. Containers holds the list which define the units of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle. { # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime. "args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references are not supported in Cloud Run. @@ -527,7 +527,7 @@

Method Details

"uid": "A String", # Unique, system-generated identifier for this resource. }, "spec": { # RevisionSpec holds the desired state of the Revision (from the client). # RevisionSpec holds the desired state of the Revision (from the client). - "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified, defaults to 80. + "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1. "containers": [ # Required. Containers holds the list which define the units of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle. { # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime. "args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references are not supported in Cloud Run. diff --git a/docs/dyn/run_v1.namespaces.revisions.html b/docs/dyn/run_v1.namespaces.revisions.html index af49f150918..097da119b2c 100644 --- a/docs/dyn/run_v1.namespaces.revisions.html +++ b/docs/dyn/run_v1.namespaces.revisions.html @@ -187,7 +187,7 @@

Method Details

"uid": "A String", # Unique, system-generated identifier for this resource. }, "spec": { # RevisionSpec holds the desired state of the Revision (from the client). # Spec holds the desired state of the Revision (from the client). - "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified, defaults to 80. + "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1. "containers": [ # Required. Containers holds the list which define the units of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle. { # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime. "args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references are not supported in Cloud Run. @@ -507,7 +507,7 @@

Method Details

"uid": "A String", # Unique, system-generated identifier for this resource. }, "spec": { # RevisionSpec holds the desired state of the Revision (from the client). # Spec holds the desired state of the Revision (from the client). - "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified, defaults to 80. + "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1. "containers": [ # Required. Containers holds the list which define the units of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle. { # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime. "args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references are not supported in Cloud Run. diff --git a/docs/dyn/run_v1.namespaces.services.html b/docs/dyn/run_v1.namespaces.services.html index 27b4dca0f17..e61f491c7f2 100644 --- a/docs/dyn/run_v1.namespaces.services.html +++ b/docs/dyn/run_v1.namespaces.services.html @@ -177,7 +177,7 @@

Method Details

"uid": "A String", # Unique, system-generated identifier for this resource. }, "spec": { # RevisionSpec holds the desired state of the Revision (from the client). # RevisionSpec holds the desired state of the Revision (from the client). - "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified, defaults to 80. + "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1. "containers": [ # Required. Containers holds the list which define the units of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle. { # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime. "args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references are not supported in Cloud Run. @@ -539,7 +539,7 @@

Method Details

"uid": "A String", # Unique, system-generated identifier for this resource. }, "spec": { # RevisionSpec holds the desired state of the Revision (from the client). # RevisionSpec holds the desired state of the Revision (from the client). - "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified, defaults to 80. + "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1. "containers": [ # Required. Containers holds the list which define the units of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle. { # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime. "args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references are not supported in Cloud Run. @@ -952,7 +952,7 @@

Method Details

"uid": "A String", # Unique, system-generated identifier for this resource. }, "spec": { # RevisionSpec holds the desired state of the Revision (from the client). # RevisionSpec holds the desired state of the Revision (from the client). - "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified, defaults to 80. + "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1. "containers": [ # Required. Containers holds the list which define the units of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle. { # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime. "args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references are not supported in Cloud Run. @@ -1330,7 +1330,7 @@

Method Details

"uid": "A String", # Unique, system-generated identifier for this resource. }, "spec": { # RevisionSpec holds the desired state of the Revision (from the client). # RevisionSpec holds the desired state of the Revision (from the client). - "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified, defaults to 80. + "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1. "containers": [ # Required. Containers holds the list which define the units of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle. { # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime. "args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references are not supported in Cloud Run. @@ -1704,7 +1704,7 @@

Method Details

"uid": "A String", # Unique, system-generated identifier for this resource. }, "spec": { # RevisionSpec holds the desired state of the Revision (from the client). # RevisionSpec holds the desired state of the Revision (from the client). - "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified, defaults to 80. + "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1. "containers": [ # Required. Containers holds the list which define the units of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle. { # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime. "args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references are not supported in Cloud Run. @@ -2066,7 +2066,7 @@

Method Details

"uid": "A String", # Unique, system-generated identifier for this resource. }, "spec": { # RevisionSpec holds the desired state of the Revision (from the client). # RevisionSpec holds the desired state of the Revision (from the client). - "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified, defaults to 80. + "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1. "containers": [ # Required. Containers holds the list which define the units of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle. { # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime. "args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references are not supported in Cloud Run. diff --git a/docs/dyn/run_v1.projects.locations.configurations.html b/docs/dyn/run_v1.projects.locations.configurations.html index 2ff940b53c9..205ebf0490a 100644 --- a/docs/dyn/run_v1.projects.locations.configurations.html +++ b/docs/dyn/run_v1.projects.locations.configurations.html @@ -173,7 +173,7 @@

Method Details

"uid": "A String", # Unique, system-generated identifier for this resource. }, "spec": { # RevisionSpec holds the desired state of the Revision (from the client). # RevisionSpec holds the desired state of the Revision (from the client). - "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified, defaults to 80. + "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1. "containers": [ # Required. Containers holds the list which define the units of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle. { # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime. "args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references are not supported in Cloud Run. @@ -527,7 +527,7 @@

Method Details

"uid": "A String", # Unique, system-generated identifier for this resource. }, "spec": { # RevisionSpec holds the desired state of the Revision (from the client). # RevisionSpec holds the desired state of the Revision (from the client). - "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified, defaults to 80. + "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1. "containers": [ # Required. Containers holds the list which define the units of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle. { # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime. "args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references are not supported in Cloud Run. diff --git a/docs/dyn/run_v1.projects.locations.revisions.html b/docs/dyn/run_v1.projects.locations.revisions.html index 9537539183c..fdd03828951 100644 --- a/docs/dyn/run_v1.projects.locations.revisions.html +++ b/docs/dyn/run_v1.projects.locations.revisions.html @@ -187,7 +187,7 @@

Method Details

"uid": "A String", # Unique, system-generated identifier for this resource. }, "spec": { # RevisionSpec holds the desired state of the Revision (from the client). # Spec holds the desired state of the Revision (from the client). - "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified, defaults to 80. + "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1. "containers": [ # Required. Containers holds the list which define the units of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle. { # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime. "args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references are not supported in Cloud Run. @@ -507,7 +507,7 @@

Method Details

"uid": "A String", # Unique, system-generated identifier for this resource. }, "spec": { # RevisionSpec holds the desired state of the Revision (from the client). # Spec holds the desired state of the Revision (from the client). - "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified, defaults to 80. + "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1. "containers": [ # Required. Containers holds the list which define the units of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle. { # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime. "args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references are not supported in Cloud Run. diff --git a/docs/dyn/run_v1.projects.locations.services.html b/docs/dyn/run_v1.projects.locations.services.html index 145d96a3876..5f86f7fda1b 100644 --- a/docs/dyn/run_v1.projects.locations.services.html +++ b/docs/dyn/run_v1.projects.locations.services.html @@ -186,7 +186,7 @@

Method Details

"uid": "A String", # Unique, system-generated identifier for this resource. }, "spec": { # RevisionSpec holds the desired state of the Revision (from the client). # RevisionSpec holds the desired state of the Revision (from the client). - "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified, defaults to 80. + "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1. "containers": [ # Required. Containers holds the list which define the units of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle. { # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime. "args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references are not supported in Cloud Run. @@ -548,7 +548,7 @@

Method Details

"uid": "A String", # Unique, system-generated identifier for this resource. }, "spec": { # RevisionSpec holds the desired state of the Revision (from the client). # RevisionSpec holds the desired state of the Revision (from the client). - "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified, defaults to 80. + "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1. "containers": [ # Required. Containers holds the list which define the units of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle. { # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime. "args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references are not supported in Cloud Run. @@ -961,7 +961,7 @@

Method Details

"uid": "A String", # Unique, system-generated identifier for this resource. }, "spec": { # RevisionSpec holds the desired state of the Revision (from the client). # RevisionSpec holds the desired state of the Revision (from the client). - "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified, defaults to 80. + "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1. "containers": [ # Required. Containers holds the list which define the units of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle. { # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime. "args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references are not supported in Cloud Run. @@ -1387,7 +1387,7 @@

Method Details

"uid": "A String", # Unique, system-generated identifier for this resource. }, "spec": { # RevisionSpec holds the desired state of the Revision (from the client). # RevisionSpec holds the desired state of the Revision (from the client). - "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified, defaults to 80. + "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1. "containers": [ # Required. Containers holds the list which define the units of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle. { # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime. "args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references are not supported in Cloud Run. @@ -1761,7 +1761,7 @@

Method Details

"uid": "A String", # Unique, system-generated identifier for this resource. }, "spec": { # RevisionSpec holds the desired state of the Revision (from the client). # RevisionSpec holds the desired state of the Revision (from the client). - "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified, defaults to 80. + "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1. "containers": [ # Required. Containers holds the list which define the units of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle. { # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime. "args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references are not supported in Cloud Run. @@ -2123,7 +2123,7 @@

Method Details

"uid": "A String", # Unique, system-generated identifier for this resource. }, "spec": { # RevisionSpec holds the desired state of the Revision (from the client). # RevisionSpec holds the desired state of the Revision (from the client). - "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified, defaults to 80. + "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1. "containers": [ # Required. Containers holds the list which define the units of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle. { # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime. "args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references are not supported in Cloud Run. diff --git a/docs/dyn/run_v2.projects.locations.services.html b/docs/dyn/run_v2.projects.locations.services.html index 1f0ad7dd322..af860d9eaaf 100644 --- a/docs/dyn/run_v2.projects.locations.services.html +++ b/docs/dyn/run_v2.projects.locations.services.html @@ -276,7 +276,7 @@

Method Details

"labels": { # Optional. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels. Cloud Run API v2 does not support labels with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 RevisionTemplate. "a_key": "A String", }, - "maxInstanceRequestConcurrency": 42, # Optional. Sets the maximum number of requests that each serving instance can receive. + "maxInstanceRequestConcurrency": 42, # Optional. Sets the maximum number of requests that each serving instance can receive. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1. "nodeSelector": { # Hardware constraints configuration. # Optional. The node selector for the revision template. "accelerator": "A String", # Required. GPU accelerator type to attach to an instance. }, @@ -602,7 +602,7 @@

Method Details

"labels": { # Optional. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels. Cloud Run API v2 does not support labels with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 RevisionTemplate. "a_key": "A String", }, - "maxInstanceRequestConcurrency": 42, # Optional. Sets the maximum number of requests that each serving instance can receive. + "maxInstanceRequestConcurrency": 42, # Optional. Sets the maximum number of requests that each serving instance can receive. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1. "nodeSelector": { # Hardware constraints configuration. # Optional. The node selector for the revision template. "accelerator": "A String", # Required. GPU accelerator type to attach to an instance. }, @@ -915,7 +915,7 @@

Method Details

"labels": { # Optional. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels. Cloud Run API v2 does not support labels with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 RevisionTemplate. "a_key": "A String", }, - "maxInstanceRequestConcurrency": 42, # Optional. Sets the maximum number of requests that each serving instance can receive. + "maxInstanceRequestConcurrency": 42, # Optional. Sets the maximum number of requests that each serving instance can receive. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1. "nodeSelector": { # Hardware constraints configuration. # Optional. The node selector for the revision template. "accelerator": "A String", # Required. GPU accelerator type to attach to an instance. }, @@ -1185,7 +1185,7 @@

Method Details

"labels": { # Optional. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels. Cloud Run API v2 does not support labels with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 RevisionTemplate. "a_key": "A String", }, - "maxInstanceRequestConcurrency": 42, # Optional. Sets the maximum number of requests that each serving instance can receive. + "maxInstanceRequestConcurrency": 42, # Optional. Sets the maximum number of requests that each serving instance can receive. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1. "nodeSelector": { # Hardware constraints configuration. # Optional. The node selector for the revision template. "accelerator": "A String", # Required. GPU accelerator type to attach to an instance. }, diff --git a/docs/dyn/securitycenter_v1.folders.eventThreatDetectionSettings.customModules.html b/docs/dyn/securitycenter_v1.folders.eventThreatDetectionSettings.customModules.html index 2fd43d8c96f..33ebdb4e56d 100644 --- a/docs/dyn/securitycenter_v1.folders.eventThreatDetectionSettings.customModules.html +++ b/docs/dyn/securitycenter_v1.folders.eventThreatDetectionSettings.customModules.html @@ -112,7 +112,7 @@

Method Details

Creates a resident Event Threat Detection custom module at the scope of the given Resource Manager parent, and also creates inherited custom modules for all descendants of the given parent. These modules are enabled by default.
 
 Args:
-  parent: string, Required. The new custom module's parent. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings". (required)
+  parent: string, Required. The new custom module's parent. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -158,7 +158,7 @@ 

Method Details

Deletes the specified Event Threat Detection custom module and all of its descendants in the Resource Manager hierarchy. This method is only supported for resident custom modules.
 
 Args:
-  name: string, Required. Name of the custom module to delete. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/customModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/customModules/{module}". * "projects/{project}/eventThreatDetectionSettings/customModules/{module}". (required)
+  name: string, Required. Name of the custom module to delete. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -176,7 +176,7 @@ 

Method Details

Gets an Event Threat Detection custom module.
 
 Args:
-  name: string, Required. Name of the custom module to get. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/customModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/customModules/{module}". * "projects/{project}/eventThreatDetectionSettings/customModules/{module}". (required)
+  name: string, Required. Name of the custom module to get. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -205,7 +205,7 @@ 

Method Details

Lists all Event Threat Detection custom modules for the given Resource Manager parent. This includes resident modules defined at the scope of the parent along with modules inherited from ancestors.
 
 Args:
-  parent: string, Required. Name of the parent to list custom modules under. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings". (required)
+  parent: string, Required. Name of the parent to list custom modules under. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`. (required)
   pageSize: integer, The maximum number of modules to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
   pageToken: string, A page token, received from a previous `ListEventThreatDetectionCustomModules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListEventThreatDetectionCustomModules` must match the call that provided the page token.
   x__xgafv: string, V1 error format.
@@ -241,7 +241,7 @@ 

Method Details

Lists all resident Event Threat Detection custom modules under the given Resource Manager parent and its descendants.
 
 Args:
-  parent: string, Required. Name of the parent to list custom modules under. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings". (required)
+  parent: string, Required. Name of the parent to list custom modules under. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`. (required)
   pageSize: integer, The maximum number of modules to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
   pageToken: string, A page token, received from a previous `ListDescendantEventThreatDetectionCustomModules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDescendantEventThreatDetectionCustomModules` must match the call that provided the page token.
   x__xgafv: string, V1 error format.
diff --git a/docs/dyn/securitycenter_v1.folders.eventThreatDetectionSettings.effectiveCustomModules.html b/docs/dyn/securitycenter_v1.folders.eventThreatDetectionSettings.effectiveCustomModules.html
index b5cf7ae4e3c..889959c7139 100644
--- a/docs/dyn/securitycenter_v1.folders.eventThreatDetectionSettings.effectiveCustomModules.html
+++ b/docs/dyn/securitycenter_v1.folders.eventThreatDetectionSettings.effectiveCustomModules.html
@@ -97,7 +97,7 @@ 

Method Details

Gets an effective Event Threat Detection custom module at the given level.
 
 Args:
-  name: string, Required. The resource name of the effective Event Threat Detection custom module. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}". * "projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}". (required)
+  name: string, Required. The resource name of the effective Event Threat Detection custom module. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -123,7 +123,7 @@ 

Method Details

Lists all effective Event Threat Detection custom modules for the given parent. This includes resident modules defined at the scope of the parent along with modules inherited from its ancestors.
 
 Args:
-  parent: string, Required. Name of the parent to list custom modules for. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings". (required)
+  parent: string, Required. Name of the parent to list custom modules for. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`. (required)
   pageSize: integer, The maximum number of modules to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
   pageToken: string, A page token, received from a previous `ListEffectiveEventThreatDetectionCustomModules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListEffectiveEventThreatDetectionCustomModules` must match the call that provided the page token.
   x__xgafv: string, V1 error format.
diff --git a/docs/dyn/securitycenter_v1.folders.eventThreatDetectionSettings.html b/docs/dyn/securitycenter_v1.folders.eventThreatDetectionSettings.html
index 84325a9b542..d08986119b7 100644
--- a/docs/dyn/securitycenter_v1.folders.eventThreatDetectionSettings.html
+++ b/docs/dyn/securitycenter_v1.folders.eventThreatDetectionSettings.html
@@ -101,7 +101,7 @@ 

Method Details

Validates the given Event Threat Detection custom module.
 
 Args:
-  parent: string, Required. Resource name of the parent to validate the Custom Module under. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings". (required)
+  parent: string, Required. Resource name of the parent to validate the Custom Module under. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`. (required)
   body: object, The request body.
     The object takes the form of:
 
diff --git a/docs/dyn/securitycenter_v1.folders.sources.findings.html b/docs/dyn/securitycenter_v1.folders.sources.findings.html
index 7a1b0057c10..9c9bd7551bb 100644
--- a/docs/dyn/securitycenter_v1.folders.sources.findings.html
+++ b/docs/dyn/securitycenter_v1.folders.sources.findings.html
@@ -782,7 +782,7 @@ 

Method Details

}, ], }, - "resourcePathString": "A String", # A string representation of the resource path. For Google Cloud, it has the format of org/{organization_id}/folder/{folder_id}/folder/{folder_id}/project/{project_id} where there can be any number of folders. For AWS, it has the format of org/{organization_id}/ou/{organizational_unit_id}/ou/{organizational_unit_id}/account/{account_id} where there can be any number of organizational units. For Azure, it has the format of mg/{management_group_id}/mg/{management_group_id}/subscription/{subscription_id}/rg/{resource_group_name} where there can be any number of management groups. + "resourcePathString": "A String", # A string representation of the resource path. For Google Cloud, it has the format of `org/{organization_id}/folder/{folder_id}/folder/{folder_id}/project/{project_id}` where there can be any number of folders. For AWS, it has the format of `org/{organization_id}/ou/{organizational_unit_id}/ou/{organizational_unit_id}/account/{account_id}` where there can be any number of organizational units. For Azure, it has the format of `mg/{management_group_id}/mg/{management_group_id}/subscription/{subscription_id}/rg/{resource_group_name}` where there can be any number of management groups. "service": "A String", # The service or resource provider associated with the resource. "type": "A String", # The full resource type of the resource. }, diff --git a/docs/dyn/securitycenter_v1.organizations.eventThreatDetectionSettings.customModules.html b/docs/dyn/securitycenter_v1.organizations.eventThreatDetectionSettings.customModules.html index 268f8a8a840..018e83d4e2b 100644 --- a/docs/dyn/securitycenter_v1.organizations.eventThreatDetectionSettings.customModules.html +++ b/docs/dyn/securitycenter_v1.organizations.eventThreatDetectionSettings.customModules.html @@ -112,7 +112,7 @@

Method Details

Creates a resident Event Threat Detection custom module at the scope of the given Resource Manager parent, and also creates inherited custom modules for all descendants of the given parent. These modules are enabled by default.
 
 Args:
-  parent: string, Required. The new custom module's parent. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings". (required)
+  parent: string, Required. The new custom module's parent. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -158,7 +158,7 @@ 

Method Details

Deletes the specified Event Threat Detection custom module and all of its descendants in the Resource Manager hierarchy. This method is only supported for resident custom modules.
 
 Args:
-  name: string, Required. Name of the custom module to delete. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/customModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/customModules/{module}". * "projects/{project}/eventThreatDetectionSettings/customModules/{module}". (required)
+  name: string, Required. Name of the custom module to delete. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -176,7 +176,7 @@ 

Method Details

Gets an Event Threat Detection custom module.
 
 Args:
-  name: string, Required. Name of the custom module to get. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/customModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/customModules/{module}". * "projects/{project}/eventThreatDetectionSettings/customModules/{module}". (required)
+  name: string, Required. Name of the custom module to get. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -205,7 +205,7 @@ 

Method Details

Lists all Event Threat Detection custom modules for the given Resource Manager parent. This includes resident modules defined at the scope of the parent along with modules inherited from ancestors.
 
 Args:
-  parent: string, Required. Name of the parent to list custom modules under. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings". (required)
+  parent: string, Required. Name of the parent to list custom modules under. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`. (required)
   pageSize: integer, The maximum number of modules to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
   pageToken: string, A page token, received from a previous `ListEventThreatDetectionCustomModules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListEventThreatDetectionCustomModules` must match the call that provided the page token.
   x__xgafv: string, V1 error format.
@@ -241,7 +241,7 @@ 

Method Details

Lists all resident Event Threat Detection custom modules under the given Resource Manager parent and its descendants.
 
 Args:
-  parent: string, Required. Name of the parent to list custom modules under. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings". (required)
+  parent: string, Required. Name of the parent to list custom modules under. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`. (required)
   pageSize: integer, The maximum number of modules to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
   pageToken: string, A page token, received from a previous `ListDescendantEventThreatDetectionCustomModules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDescendantEventThreatDetectionCustomModules` must match the call that provided the page token.
   x__xgafv: string, V1 error format.
diff --git a/docs/dyn/securitycenter_v1.organizations.eventThreatDetectionSettings.effectiveCustomModules.html b/docs/dyn/securitycenter_v1.organizations.eventThreatDetectionSettings.effectiveCustomModules.html
index 37e0b01b4c0..bfcde8e8fd5 100644
--- a/docs/dyn/securitycenter_v1.organizations.eventThreatDetectionSettings.effectiveCustomModules.html
+++ b/docs/dyn/securitycenter_v1.organizations.eventThreatDetectionSettings.effectiveCustomModules.html
@@ -97,7 +97,7 @@ 

Method Details

Gets an effective Event Threat Detection custom module at the given level.
 
 Args:
-  name: string, Required. The resource name of the effective Event Threat Detection custom module. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}". * "projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}". (required)
+  name: string, Required. The resource name of the effective Event Threat Detection custom module. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -123,7 +123,7 @@ 

Method Details

Lists all effective Event Threat Detection custom modules for the given parent. This includes resident modules defined at the scope of the parent along with modules inherited from its ancestors.
 
 Args:
-  parent: string, Required. Name of the parent to list custom modules for. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings". (required)
+  parent: string, Required. Name of the parent to list custom modules for. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`. (required)
   pageSize: integer, The maximum number of modules to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
   pageToken: string, A page token, received from a previous `ListEffectiveEventThreatDetectionCustomModules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListEffectiveEventThreatDetectionCustomModules` must match the call that provided the page token.
   x__xgafv: string, V1 error format.
diff --git a/docs/dyn/securitycenter_v1.organizations.eventThreatDetectionSettings.html b/docs/dyn/securitycenter_v1.organizations.eventThreatDetectionSettings.html
index 707f785b4ac..cb5d0851741 100644
--- a/docs/dyn/securitycenter_v1.organizations.eventThreatDetectionSettings.html
+++ b/docs/dyn/securitycenter_v1.organizations.eventThreatDetectionSettings.html
@@ -101,7 +101,7 @@ 

Method Details

Validates the given Event Threat Detection custom module.
 
 Args:
-  parent: string, Required. Resource name of the parent to validate the Custom Module under. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings". (required)
+  parent: string, Required. Resource name of the parent to validate the Custom Module under. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`. (required)
   body: object, The request body.
     The object takes the form of:
 
diff --git a/docs/dyn/securitycenter_v1.organizations.sources.findings.html b/docs/dyn/securitycenter_v1.organizations.sources.findings.html
index 15a69bd14dc..abe8029a7d9 100644
--- a/docs/dyn/securitycenter_v1.organizations.sources.findings.html
+++ b/docs/dyn/securitycenter_v1.organizations.sources.findings.html
@@ -1878,7 +1878,7 @@ 

Method Details

}, ], }, - "resourcePathString": "A String", # A string representation of the resource path. For Google Cloud, it has the format of org/{organization_id}/folder/{folder_id}/folder/{folder_id}/project/{project_id} where there can be any number of folders. For AWS, it has the format of org/{organization_id}/ou/{organizational_unit_id}/ou/{organizational_unit_id}/account/{account_id} where there can be any number of organizational units. For Azure, it has the format of mg/{management_group_id}/mg/{management_group_id}/subscription/{subscription_id}/rg/{resource_group_name} where there can be any number of management groups. + "resourcePathString": "A String", # A string representation of the resource path. For Google Cloud, it has the format of `org/{organization_id}/folder/{folder_id}/folder/{folder_id}/project/{project_id}` where there can be any number of folders. For AWS, it has the format of `org/{organization_id}/ou/{organizational_unit_id}/ou/{organizational_unit_id}/account/{account_id}` where there can be any number of organizational units. For Azure, it has the format of `mg/{management_group_id}/mg/{management_group_id}/subscription/{subscription_id}/rg/{resource_group_name}` where there can be any number of management groups. "service": "A String", # The service or resource provider associated with the resource. "type": "A String", # The full resource type of the resource. }, diff --git a/docs/dyn/securitycenter_v1.projects.eventThreatDetectionSettings.customModules.html b/docs/dyn/securitycenter_v1.projects.eventThreatDetectionSettings.customModules.html index a37a492a4da..3dbca62242d 100644 --- a/docs/dyn/securitycenter_v1.projects.eventThreatDetectionSettings.customModules.html +++ b/docs/dyn/securitycenter_v1.projects.eventThreatDetectionSettings.customModules.html @@ -112,7 +112,7 @@

Method Details

Creates a resident Event Threat Detection custom module at the scope of the given Resource Manager parent, and also creates inherited custom modules for all descendants of the given parent. These modules are enabled by default.
 
 Args:
-  parent: string, Required. The new custom module's parent. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings". (required)
+  parent: string, Required. The new custom module's parent. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -158,7 +158,7 @@ 

Method Details

Deletes the specified Event Threat Detection custom module and all of its descendants in the Resource Manager hierarchy. This method is only supported for resident custom modules.
 
 Args:
-  name: string, Required. Name of the custom module to delete. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/customModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/customModules/{module}". * "projects/{project}/eventThreatDetectionSettings/customModules/{module}". (required)
+  name: string, Required. Name of the custom module to delete. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -176,7 +176,7 @@ 

Method Details

Gets an Event Threat Detection custom module.
 
 Args:
-  name: string, Required. Name of the custom module to get. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/customModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/customModules/{module}". * "projects/{project}/eventThreatDetectionSettings/customModules/{module}". (required)
+  name: string, Required. Name of the custom module to get. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -205,7 +205,7 @@ 

Method Details

Lists all Event Threat Detection custom modules for the given Resource Manager parent. This includes resident modules defined at the scope of the parent along with modules inherited from ancestors.
 
 Args:
-  parent: string, Required. Name of the parent to list custom modules under. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings". (required)
+  parent: string, Required. Name of the parent to list custom modules under. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`. (required)
   pageSize: integer, The maximum number of modules to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
   pageToken: string, A page token, received from a previous `ListEventThreatDetectionCustomModules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListEventThreatDetectionCustomModules` must match the call that provided the page token.
   x__xgafv: string, V1 error format.
@@ -241,7 +241,7 @@ 

Method Details

Lists all resident Event Threat Detection custom modules under the given Resource Manager parent and its descendants.
 
 Args:
-  parent: string, Required. Name of the parent to list custom modules under. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings". (required)
+  parent: string, Required. Name of the parent to list custom modules under. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`. (required)
   pageSize: integer, The maximum number of modules to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
   pageToken: string, A page token, received from a previous `ListDescendantEventThreatDetectionCustomModules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDescendantEventThreatDetectionCustomModules` must match the call that provided the page token.
   x__xgafv: string, V1 error format.
diff --git a/docs/dyn/securitycenter_v1.projects.eventThreatDetectionSettings.effectiveCustomModules.html b/docs/dyn/securitycenter_v1.projects.eventThreatDetectionSettings.effectiveCustomModules.html
index 06f10162f6a..fd69bcfd4ce 100644
--- a/docs/dyn/securitycenter_v1.projects.eventThreatDetectionSettings.effectiveCustomModules.html
+++ b/docs/dyn/securitycenter_v1.projects.eventThreatDetectionSettings.effectiveCustomModules.html
@@ -97,7 +97,7 @@ 

Method Details

Gets an effective Event Threat Detection custom module at the given level.
 
 Args:
-  name: string, Required. The resource name of the effective Event Threat Detection custom module. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}". * "projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}". (required)
+  name: string, Required. The resource name of the effective Event Threat Detection custom module. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -123,7 +123,7 @@ 

Method Details

Lists all effective Event Threat Detection custom modules for the given parent. This includes resident modules defined at the scope of the parent along with modules inherited from its ancestors.
 
 Args:
-  parent: string, Required. Name of the parent to list custom modules for. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings". (required)
+  parent: string, Required. Name of the parent to list custom modules for. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`. (required)
   pageSize: integer, The maximum number of modules to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
   pageToken: string, A page token, received from a previous `ListEffectiveEventThreatDetectionCustomModules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListEffectiveEventThreatDetectionCustomModules` must match the call that provided the page token.
   x__xgafv: string, V1 error format.
diff --git a/docs/dyn/securitycenter_v1.projects.eventThreatDetectionSettings.html b/docs/dyn/securitycenter_v1.projects.eventThreatDetectionSettings.html
index 9f6a9590f0a..ff7cf07a47f 100644
--- a/docs/dyn/securitycenter_v1.projects.eventThreatDetectionSettings.html
+++ b/docs/dyn/securitycenter_v1.projects.eventThreatDetectionSettings.html
@@ -101,7 +101,7 @@ 

Method Details

Validates the given Event Threat Detection custom module.
 
 Args:
-  parent: string, Required. Resource name of the parent to validate the Custom Module under. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings". (required)
+  parent: string, Required. Resource name of the parent to validate the Custom Module under. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`. (required)
   body: object, The request body.
     The object takes the form of:
 
diff --git a/docs/dyn/securitycenter_v1.projects.sources.findings.html b/docs/dyn/securitycenter_v1.projects.sources.findings.html
index bf3c8b3e7e0..6b82eb44526 100644
--- a/docs/dyn/securitycenter_v1.projects.sources.findings.html
+++ b/docs/dyn/securitycenter_v1.projects.sources.findings.html
@@ -782,7 +782,7 @@ 

Method Details

}, ], }, - "resourcePathString": "A String", # A string representation of the resource path. For Google Cloud, it has the format of org/{organization_id}/folder/{folder_id}/folder/{folder_id}/project/{project_id} where there can be any number of folders. For AWS, it has the format of org/{organization_id}/ou/{organizational_unit_id}/ou/{organizational_unit_id}/account/{account_id} where there can be any number of organizational units. For Azure, it has the format of mg/{management_group_id}/mg/{management_group_id}/subscription/{subscription_id}/rg/{resource_group_name} where there can be any number of management groups. + "resourcePathString": "A String", # A string representation of the resource path. For Google Cloud, it has the format of `org/{organization_id}/folder/{folder_id}/folder/{folder_id}/project/{project_id}` where there can be any number of folders. For AWS, it has the format of `org/{organization_id}/ou/{organizational_unit_id}/ou/{organizational_unit_id}/account/{account_id}` where there can be any number of organizational units. For Azure, it has the format of `mg/{management_group_id}/mg/{management_group_id}/subscription/{subscription_id}/rg/{resource_group_name}` where there can be any number of management groups. "service": "A String", # The service or resource provider associated with the resource. "type": "A String", # The full resource type of the resource. }, diff --git a/docs/dyn/securitycenter_v1beta2.folders.containerThreatDetectionSettings.html b/docs/dyn/securitycenter_v1beta2.folders.containerThreatDetectionSettings.html index 0501be9241e..8d975ffa3e5 100644 --- a/docs/dyn/securitycenter_v1beta2.folders.containerThreatDetectionSettings.html +++ b/docs/dyn/securitycenter_v1beta2.folders.containerThreatDetectionSettings.html @@ -96,7 +96,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Container Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -104,7 +104,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings "serviceAccount": "A String", # Output only. The service account used by Container Threat Detection for scanning. Service accounts are scoped at the project level meaning this field will be empty at any level above a project. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. diff --git a/docs/dyn/securitycenter_v1beta2.folders.eventThreatDetectionSettings.html b/docs/dyn/securitycenter_v1beta2.folders.eventThreatDetectionSettings.html index fc38963c6cf..8d65eb4d694 100644 --- a/docs/dyn/securitycenter_v1beta2.folders.eventThreatDetectionSettings.html +++ b/docs/dyn/securitycenter_v1beta2.folders.eventThreatDetectionSettings.html @@ -96,7 +96,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Event Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -104,7 +104,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. }
diff --git a/docs/dyn/securitycenter_v1beta2.folders.html b/docs/dyn/securitycenter_v1beta2.folders.html index 57581759b8d..174575b6bb1 100644 --- a/docs/dyn/securitycenter_v1beta2.folders.html +++ b/docs/dyn/securitycenter_v1beta2.folders.html @@ -167,7 +167,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Container Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -175,7 +175,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings "serviceAccount": "A String", # Output only. The service account used by Container Threat Detection for scanning. Service accounts are scoped at the project level meaning this field will be empty at any level above a project. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. @@ -197,7 +197,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Event Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -205,7 +205,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. }
@@ -277,7 +277,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Security Health Analytics service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -285,7 +285,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings + "name": "A String", # Identifier. The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings "serviceAccount": "A String", # Output only. The service account used by Security Health Analytics detectors. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. @@ -307,7 +307,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Virtual Machine Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -315,7 +315,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings "serviceAccount": "A String", # Output only. The service account used by Virtual Machine Threat Detection detectors. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. @@ -337,7 +337,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Web Security Scanner service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -345,7 +345,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings + "name": "A String", # Identifier. The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. }
@@ -356,12 +356,12 @@

Method Details

Update the ContainerThreatDetectionSettings resource.
 
 Args:
-  name: string, The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings (required)
+  name: string, Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings (required)
   body: object, The request body.
     The object takes the form of:
 
 { # Resource capturing the settings for the Container Threat Detection service.
-  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's.
+  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration.
     "a_key": { # Configuration of a module.
       "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy.
       "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent.
@@ -369,7 +369,7 @@ 

Method Details

}, }, }, - "name": "A String", # The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings "serviceAccount": "A String", # Output only. The service account used by Container Threat Detection for scanning. Service accounts are scoped at the project level meaning this field will be empty at any level above a project. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. @@ -385,7 +385,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Container Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -393,7 +393,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings "serviceAccount": "A String", # Output only. The service account used by Container Threat Detection for scanning. Service accounts are scoped at the project level meaning this field will be empty at any level above a project. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. @@ -405,12 +405,12 @@

Method Details

Update the EventThreatDetectionSettings resource.
 
 Args:
-  name: string, The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings (required)
+  name: string, Identifier. The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings (required)
   body: object, The request body.
     The object takes the form of:
 
 { # Resource capturing the settings for the Event Threat Detection service.
-  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's.
+  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration.
     "a_key": { # Configuration of a module.
       "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy.
       "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent.
@@ -418,7 +418,7 @@ 

Method Details

}, }, }, - "name": "A String", # The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. } @@ -433,7 +433,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Event Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -441,7 +441,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. }
@@ -499,12 +499,12 @@

Method Details

Update the SecurityHealthAnalyticsSettings resource.
 
 Args:
-  name: string, The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings (required)
+  name: string, Identifier. The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings (required)
   body: object, The request body.
     The object takes the form of:
 
 { # Resource capturing the settings for the Security Health Analytics service.
-  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's.
+  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration.
     "a_key": { # Configuration of a module.
       "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy.
       "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent.
@@ -512,7 +512,7 @@ 

Method Details

}, }, }, - "name": "A String", # The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings + "name": "A String", # Identifier. The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings "serviceAccount": "A String", # Output only. The service account used by Security Health Analytics detectors. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. @@ -528,7 +528,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Security Health Analytics service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -536,7 +536,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings + "name": "A String", # Identifier. The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings "serviceAccount": "A String", # Output only. The service account used by Security Health Analytics detectors. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. @@ -548,12 +548,12 @@

Method Details

Update the VirtualMachineThreatDetectionSettings resource.
 
 Args:
-  name: string, The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings (required)
+  name: string, Identifier. The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings (required)
   body: object, The request body.
     The object takes the form of:
 
 { # Resource capturing the settings for the Virtual Machine Threat Detection service.
-  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's.
+  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration.
     "a_key": { # Configuration of a module.
       "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy.
       "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent.
@@ -561,7 +561,7 @@ 

Method Details

}, }, }, - "name": "A String", # The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings "serviceAccount": "A String", # Output only. The service account used by Virtual Machine Threat Detection detectors. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. @@ -577,7 +577,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Virtual Machine Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -585,7 +585,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings "serviceAccount": "A String", # Output only. The service account used by Virtual Machine Threat Detection detectors. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. @@ -597,12 +597,12 @@

Method Details

Update the WebSecurityScannerSettings resource.
 
 Args:
-  name: string, The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings (required)
+  name: string, Identifier. The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings (required)
   body: object, The request body.
     The object takes the form of:
 
 { # Resource capturing the settings for the Web Security Scanner service.
-  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's.
+  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration.
     "a_key": { # Configuration of a module.
       "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy.
       "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent.
@@ -610,7 +610,7 @@ 

Method Details

}, }, }, - "name": "A String", # The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings + "name": "A String", # Identifier. The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. } @@ -625,7 +625,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Web Security Scanner service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -633,7 +633,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings + "name": "A String", # Identifier. The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. }
diff --git a/docs/dyn/securitycenter_v1beta2.folders.securityHealthAnalyticsSettings.html b/docs/dyn/securitycenter_v1beta2.folders.securityHealthAnalyticsSettings.html index 114921cc15d..342685ed106 100644 --- a/docs/dyn/securitycenter_v1beta2.folders.securityHealthAnalyticsSettings.html +++ b/docs/dyn/securitycenter_v1beta2.folders.securityHealthAnalyticsSettings.html @@ -96,7 +96,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Security Health Analytics service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -104,7 +104,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings + "name": "A String", # Identifier. The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings "serviceAccount": "A String", # Output only. The service account used by Security Health Analytics detectors. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. diff --git a/docs/dyn/securitycenter_v1beta2.folders.virtualMachineThreatDetectionSettings.html b/docs/dyn/securitycenter_v1beta2.folders.virtualMachineThreatDetectionSettings.html index 7e1a5aab973..068cd199b00 100644 --- a/docs/dyn/securitycenter_v1beta2.folders.virtualMachineThreatDetectionSettings.html +++ b/docs/dyn/securitycenter_v1beta2.folders.virtualMachineThreatDetectionSettings.html @@ -96,7 +96,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Virtual Machine Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -104,7 +104,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings "serviceAccount": "A String", # Output only. The service account used by Virtual Machine Threat Detection detectors. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. diff --git a/docs/dyn/securitycenter_v1beta2.folders.webSecurityScannerSettings.html b/docs/dyn/securitycenter_v1beta2.folders.webSecurityScannerSettings.html index f8ad579263d..883b4cca8d8 100644 --- a/docs/dyn/securitycenter_v1beta2.folders.webSecurityScannerSettings.html +++ b/docs/dyn/securitycenter_v1beta2.folders.webSecurityScannerSettings.html @@ -96,7 +96,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Web Security Scanner service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -104,7 +104,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings + "name": "A String", # Identifier. The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. }
diff --git a/docs/dyn/securitycenter_v1beta2.organizations.containerThreatDetectionSettings.html b/docs/dyn/securitycenter_v1beta2.organizations.containerThreatDetectionSettings.html index 54e509390c2..8726521fbb4 100644 --- a/docs/dyn/securitycenter_v1beta2.organizations.containerThreatDetectionSettings.html +++ b/docs/dyn/securitycenter_v1beta2.organizations.containerThreatDetectionSettings.html @@ -96,7 +96,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Container Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -104,7 +104,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings "serviceAccount": "A String", # Output only. The service account used by Container Threat Detection for scanning. Service accounts are scoped at the project level meaning this field will be empty at any level above a project. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. diff --git a/docs/dyn/securitycenter_v1beta2.organizations.eventThreatDetectionSettings.html b/docs/dyn/securitycenter_v1beta2.organizations.eventThreatDetectionSettings.html index 52e9904c98e..5d775adfb91 100644 --- a/docs/dyn/securitycenter_v1beta2.organizations.eventThreatDetectionSettings.html +++ b/docs/dyn/securitycenter_v1beta2.organizations.eventThreatDetectionSettings.html @@ -96,7 +96,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Event Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -104,7 +104,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. }
diff --git a/docs/dyn/securitycenter_v1beta2.organizations.html b/docs/dyn/securitycenter_v1beta2.organizations.html index 6c2ae1b9fa9..ba9d962344e 100644 --- a/docs/dyn/securitycenter_v1beta2.organizations.html +++ b/docs/dyn/securitycenter_v1beta2.organizations.html @@ -170,7 +170,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Container Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -178,7 +178,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings "serviceAccount": "A String", # Output only. The service account used by Container Threat Detection for scanning. Service accounts are scoped at the project level meaning this field will be empty at any level above a project. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. @@ -200,7 +200,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Event Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -208,7 +208,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. }
@@ -280,7 +280,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Security Health Analytics service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -288,7 +288,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings + "name": "A String", # Identifier. The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings "serviceAccount": "A String", # Output only. The service account used by Security Health Analytics detectors. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. @@ -335,7 +335,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Virtual Machine Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -343,7 +343,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings "serviceAccount": "A String", # Output only. The service account used by Virtual Machine Threat Detection detectors. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. @@ -365,7 +365,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Web Security Scanner service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -373,7 +373,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings + "name": "A String", # Identifier. The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. }
@@ -384,12 +384,12 @@

Method Details

Update the ContainerThreatDetectionSettings resource.
 
 Args:
-  name: string, The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings (required)
+  name: string, Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings (required)
   body: object, The request body.
     The object takes the form of:
 
 { # Resource capturing the settings for the Container Threat Detection service.
-  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's.
+  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration.
     "a_key": { # Configuration of a module.
       "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy.
       "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent.
@@ -397,7 +397,7 @@ 

Method Details

}, }, }, - "name": "A String", # The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings "serviceAccount": "A String", # Output only. The service account used by Container Threat Detection for scanning. Service accounts are scoped at the project level meaning this field will be empty at any level above a project. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. @@ -413,7 +413,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Container Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -421,7 +421,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings "serviceAccount": "A String", # Output only. The service account used by Container Threat Detection for scanning. Service accounts are scoped at the project level meaning this field will be empty at any level above a project. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. @@ -433,12 +433,12 @@

Method Details

Update the EventThreatDetectionSettings resource.
 
 Args:
-  name: string, The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings (required)
+  name: string, Identifier. The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings (required)
   body: object, The request body.
     The object takes the form of:
 
 { # Resource capturing the settings for the Event Threat Detection service.
-  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's.
+  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration.
     "a_key": { # Configuration of a module.
       "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy.
       "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent.
@@ -446,7 +446,7 @@ 

Method Details

}, }, }, - "name": "A String", # The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. } @@ -461,7 +461,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Event Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -469,7 +469,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. }
@@ -527,12 +527,12 @@

Method Details

Update the SecurityHealthAnalyticsSettings resource.
 
 Args:
-  name: string, The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings (required)
+  name: string, Identifier. The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings (required)
   body: object, The request body.
     The object takes the form of:
 
 { # Resource capturing the settings for the Security Health Analytics service.
-  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's.
+  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration.
     "a_key": { # Configuration of a module.
       "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy.
       "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent.
@@ -540,7 +540,7 @@ 

Method Details

}, }, }, - "name": "A String", # The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings + "name": "A String", # Identifier. The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings "serviceAccount": "A String", # Output only. The service account used by Security Health Analytics detectors. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. @@ -556,7 +556,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Security Health Analytics service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -564,7 +564,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings + "name": "A String", # Identifier. The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings "serviceAccount": "A String", # Output only. The service account used by Security Health Analytics detectors. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. @@ -576,12 +576,12 @@

Method Details

Update the VirtualMachineThreatDetectionSettings resource.
 
 Args:
-  name: string, The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings (required)
+  name: string, Identifier. The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings (required)
   body: object, The request body.
     The object takes the form of:
 
 { # Resource capturing the settings for the Virtual Machine Threat Detection service.
-  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's.
+  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration.
     "a_key": { # Configuration of a module.
       "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy.
       "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent.
@@ -589,7 +589,7 @@ 

Method Details

}, }, }, - "name": "A String", # The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings "serviceAccount": "A String", # Output only. The service account used by Virtual Machine Threat Detection detectors. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. @@ -605,7 +605,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Virtual Machine Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -613,7 +613,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings "serviceAccount": "A String", # Output only. The service account used by Virtual Machine Threat Detection detectors. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. @@ -625,12 +625,12 @@

Method Details

Update the WebSecurityScannerSettings resource.
 
 Args:
-  name: string, The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings (required)
+  name: string, Identifier. The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings (required)
   body: object, The request body.
     The object takes the form of:
 
 { # Resource capturing the settings for the Web Security Scanner service.
-  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's.
+  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration.
     "a_key": { # Configuration of a module.
       "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy.
       "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent.
@@ -638,7 +638,7 @@ 

Method Details

}, }, }, - "name": "A String", # The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings + "name": "A String", # Identifier. The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. } @@ -653,7 +653,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Web Security Scanner service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -661,7 +661,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings + "name": "A String", # Identifier. The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. }
diff --git a/docs/dyn/securitycenter_v1beta2.organizations.securityHealthAnalyticsSettings.html b/docs/dyn/securitycenter_v1beta2.organizations.securityHealthAnalyticsSettings.html index 6d9306afc1a..9d3fee47828 100644 --- a/docs/dyn/securitycenter_v1beta2.organizations.securityHealthAnalyticsSettings.html +++ b/docs/dyn/securitycenter_v1beta2.organizations.securityHealthAnalyticsSettings.html @@ -96,7 +96,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Security Health Analytics service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -104,7 +104,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings + "name": "A String", # Identifier. The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings "serviceAccount": "A String", # Output only. The service account used by Security Health Analytics detectors. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. diff --git a/docs/dyn/securitycenter_v1beta2.organizations.virtualMachineThreatDetectionSettings.html b/docs/dyn/securitycenter_v1beta2.organizations.virtualMachineThreatDetectionSettings.html index c5cd2272199..8f14c8a7e6d 100644 --- a/docs/dyn/securitycenter_v1beta2.organizations.virtualMachineThreatDetectionSettings.html +++ b/docs/dyn/securitycenter_v1beta2.organizations.virtualMachineThreatDetectionSettings.html @@ -96,7 +96,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Virtual Machine Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -104,7 +104,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings "serviceAccount": "A String", # Output only. The service account used by Virtual Machine Threat Detection detectors. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. diff --git a/docs/dyn/securitycenter_v1beta2.organizations.webSecurityScannerSettings.html b/docs/dyn/securitycenter_v1beta2.organizations.webSecurityScannerSettings.html index 8e7295ffd66..a3ad71975de 100644 --- a/docs/dyn/securitycenter_v1beta2.organizations.webSecurityScannerSettings.html +++ b/docs/dyn/securitycenter_v1beta2.organizations.webSecurityScannerSettings.html @@ -96,7 +96,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Web Security Scanner service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -104,7 +104,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings + "name": "A String", # Identifier. The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. }
diff --git a/docs/dyn/securitycenter_v1beta2.projects.containerThreatDetectionSettings.html b/docs/dyn/securitycenter_v1beta2.projects.containerThreatDetectionSettings.html index 6c94c893522..b85e1e6e56f 100644 --- a/docs/dyn/securitycenter_v1beta2.projects.containerThreatDetectionSettings.html +++ b/docs/dyn/securitycenter_v1beta2.projects.containerThreatDetectionSettings.html @@ -96,7 +96,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Container Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -104,7 +104,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings "serviceAccount": "A String", # Output only. The service account used by Container Threat Detection for scanning. Service accounts are scoped at the project level meaning this field will be empty at any level above a project. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. diff --git a/docs/dyn/securitycenter_v1beta2.projects.eventThreatDetectionSettings.html b/docs/dyn/securitycenter_v1beta2.projects.eventThreatDetectionSettings.html index 710c3d5fc5c..88726cfb2a3 100644 --- a/docs/dyn/securitycenter_v1beta2.projects.eventThreatDetectionSettings.html +++ b/docs/dyn/securitycenter_v1beta2.projects.eventThreatDetectionSettings.html @@ -96,7 +96,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Event Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -104,7 +104,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. }
diff --git a/docs/dyn/securitycenter_v1beta2.projects.html b/docs/dyn/securitycenter_v1beta2.projects.html index 0253b640621..c4e2a627f9b 100644 --- a/docs/dyn/securitycenter_v1beta2.projects.html +++ b/docs/dyn/securitycenter_v1beta2.projects.html @@ -172,7 +172,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Container Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -180,7 +180,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings "serviceAccount": "A String", # Output only. The service account used by Container Threat Detection for scanning. Service accounts are scoped at the project level meaning this field will be empty at any level above a project. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. @@ -202,7 +202,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Event Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -210,7 +210,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. }
@@ -282,7 +282,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Security Health Analytics service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -290,7 +290,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings + "name": "A String", # Identifier. The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings "serviceAccount": "A String", # Output only. The service account used by Security Health Analytics detectors. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. @@ -312,7 +312,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Virtual Machine Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -320,7 +320,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings "serviceAccount": "A String", # Output only. The service account used by Virtual Machine Threat Detection detectors. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. @@ -342,7 +342,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Web Security Scanner service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -350,7 +350,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings + "name": "A String", # Identifier. The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. }
@@ -361,12 +361,12 @@

Method Details

Update the ContainerThreatDetectionSettings resource.
 
 Args:
-  name: string, The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings (required)
+  name: string, Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings (required)
   body: object, The request body.
     The object takes the form of:
 
 { # Resource capturing the settings for the Container Threat Detection service.
-  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's.
+  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration.
     "a_key": { # Configuration of a module.
       "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy.
       "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent.
@@ -374,7 +374,7 @@ 

Method Details

}, }, }, - "name": "A String", # The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings "serviceAccount": "A String", # Output only. The service account used by Container Threat Detection for scanning. Service accounts are scoped at the project level meaning this field will be empty at any level above a project. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. @@ -390,7 +390,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Container Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -398,7 +398,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings "serviceAccount": "A String", # Output only. The service account used by Container Threat Detection for scanning. Service accounts are scoped at the project level meaning this field will be empty at any level above a project. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. @@ -410,12 +410,12 @@

Method Details

Update the EventThreatDetectionSettings resource.
 
 Args:
-  name: string, The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings (required)
+  name: string, Identifier. The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings (required)
   body: object, The request body.
     The object takes the form of:
 
 { # Resource capturing the settings for the Event Threat Detection service.
-  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's.
+  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration.
     "a_key": { # Configuration of a module.
       "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy.
       "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent.
@@ -423,7 +423,7 @@ 

Method Details

}, }, }, - "name": "A String", # The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. } @@ -438,7 +438,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Event Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -446,7 +446,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. }
@@ -504,12 +504,12 @@

Method Details

Update the SecurityHealthAnalyticsSettings resource.
 
 Args:
-  name: string, The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings (required)
+  name: string, Identifier. The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings (required)
   body: object, The request body.
     The object takes the form of:
 
 { # Resource capturing the settings for the Security Health Analytics service.
-  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's.
+  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration.
     "a_key": { # Configuration of a module.
       "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy.
       "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent.
@@ -517,7 +517,7 @@ 

Method Details

}, }, }, - "name": "A String", # The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings + "name": "A String", # Identifier. The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings "serviceAccount": "A String", # Output only. The service account used by Security Health Analytics detectors. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. @@ -533,7 +533,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Security Health Analytics service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -541,7 +541,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings + "name": "A String", # Identifier. The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings "serviceAccount": "A String", # Output only. The service account used by Security Health Analytics detectors. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. @@ -553,12 +553,12 @@

Method Details

Update the VirtualMachineThreatDetectionSettings resource.
 
 Args:
-  name: string, The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings (required)
+  name: string, Identifier. The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings (required)
   body: object, The request body.
     The object takes the form of:
 
 { # Resource capturing the settings for the Virtual Machine Threat Detection service.
-  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's.
+  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration.
     "a_key": { # Configuration of a module.
       "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy.
       "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent.
@@ -566,7 +566,7 @@ 

Method Details

}, }, }, - "name": "A String", # The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings "serviceAccount": "A String", # Output only. The service account used by Virtual Machine Threat Detection detectors. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. @@ -582,7 +582,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Virtual Machine Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -590,7 +590,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings "serviceAccount": "A String", # Output only. The service account used by Virtual Machine Threat Detection detectors. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. @@ -602,12 +602,12 @@

Method Details

Update the WebSecurityScannerSettings resource.
 
 Args:
-  name: string, The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings (required)
+  name: string, Identifier. The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings (required)
   body: object, The request body.
     The object takes the form of:
 
 { # Resource capturing the settings for the Web Security Scanner service.
-  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's.
+  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration.
     "a_key": { # Configuration of a module.
       "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy.
       "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent.
@@ -615,7 +615,7 @@ 

Method Details

}, }, }, - "name": "A String", # The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings + "name": "A String", # Identifier. The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. } @@ -630,7 +630,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Web Security Scanner service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -638,7 +638,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings + "name": "A String", # Identifier. The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. }
diff --git a/docs/dyn/securitycenter_v1beta2.projects.locations.clusters.containerThreatDetectionSettings.html b/docs/dyn/securitycenter_v1beta2.projects.locations.clusters.containerThreatDetectionSettings.html index 9100d0dd95b..d066805ecfd 100644 --- a/docs/dyn/securitycenter_v1beta2.projects.locations.clusters.containerThreatDetectionSettings.html +++ b/docs/dyn/securitycenter_v1beta2.projects.locations.clusters.containerThreatDetectionSettings.html @@ -96,7 +96,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Container Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -104,7 +104,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings "serviceAccount": "A String", # Output only. The service account used by Container Threat Detection for scanning. Service accounts are scoped at the project level meaning this field will be empty at any level above a project. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. diff --git a/docs/dyn/securitycenter_v1beta2.projects.locations.clusters.html b/docs/dyn/securitycenter_v1beta2.projects.locations.clusters.html index f2d8674bbca..e0d0fe70113 100644 --- a/docs/dyn/securitycenter_v1beta2.projects.locations.clusters.html +++ b/docs/dyn/securitycenter_v1beta2.projects.locations.clusters.html @@ -109,7 +109,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Container Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -117,7 +117,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings "serviceAccount": "A String", # Output only. The service account used by Container Threat Detection for scanning. Service accounts are scoped at the project level meaning this field will be empty at any level above a project. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. @@ -129,12 +129,12 @@

Method Details

Update the ContainerThreatDetectionSettings resource.
 
 Args:
-  name: string, The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings (required)
+  name: string, Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings (required)
   body: object, The request body.
     The object takes the form of:
 
 { # Resource capturing the settings for the Container Threat Detection service.
-  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's.
+  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration.
     "a_key": { # Configuration of a module.
       "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy.
       "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent.
@@ -142,7 +142,7 @@ 

Method Details

}, }, }, - "name": "A String", # The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings "serviceAccount": "A String", # Output only. The service account used by Container Threat Detection for scanning. Service accounts are scoped at the project level meaning this field will be empty at any level above a project. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. @@ -158,7 +158,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Container Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -166,7 +166,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings "serviceAccount": "A String", # Output only. The service account used by Container Threat Detection for scanning. Service accounts are scoped at the project level meaning this field will be empty at any level above a project. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. diff --git a/docs/dyn/securitycenter_v1beta2.projects.securityHealthAnalyticsSettings.html b/docs/dyn/securitycenter_v1beta2.projects.securityHealthAnalyticsSettings.html index 2729ea1e1f0..680ddf55dc4 100644 --- a/docs/dyn/securitycenter_v1beta2.projects.securityHealthAnalyticsSettings.html +++ b/docs/dyn/securitycenter_v1beta2.projects.securityHealthAnalyticsSettings.html @@ -96,7 +96,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Security Health Analytics service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -104,7 +104,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings + "name": "A String", # Identifier. The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings "serviceAccount": "A String", # Output only. The service account used by Security Health Analytics detectors. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. diff --git a/docs/dyn/securitycenter_v1beta2.projects.virtualMachineThreatDetectionSettings.html b/docs/dyn/securitycenter_v1beta2.projects.virtualMachineThreatDetectionSettings.html index e1043329e89..42ad8c84ce4 100644 --- a/docs/dyn/securitycenter_v1beta2.projects.virtualMachineThreatDetectionSettings.html +++ b/docs/dyn/securitycenter_v1beta2.projects.virtualMachineThreatDetectionSettings.html @@ -96,7 +96,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Virtual Machine Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -104,7 +104,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings "serviceAccount": "A String", # Output only. The service account used by Virtual Machine Threat Detection detectors. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. diff --git a/docs/dyn/securitycenter_v1beta2.projects.webSecurityScannerSettings.html b/docs/dyn/securitycenter_v1beta2.projects.webSecurityScannerSettings.html index 82b7b3febaf..d0407bef087 100644 --- a/docs/dyn/securitycenter_v1beta2.projects.webSecurityScannerSettings.html +++ b/docs/dyn/securitycenter_v1beta2.projects.webSecurityScannerSettings.html @@ -96,7 +96,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Web Security Scanner service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -104,7 +104,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings + "name": "A String", # Identifier. The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. }
diff --git a/docs/dyn/servicemanagement_v1.services.configs.html b/docs/dyn/servicemanagement_v1.services.configs.html index 481340fb250..fb04454cfc5 100644 --- a/docs/dyn/servicemanagement_v1.services.configs.html +++ b/docs/dyn/servicemanagement_v1.services.configs.html @@ -222,10 +222,10 @@

Method Details

"allowedResponseExtensions": [ # A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client. "A String", ], - "provided": [ # A list of full type names of provided contexts. + "provided": [ # A list of full type names of provided contexts. It is used to support propagating HTTP headers and ETags from the response extension. "A String", ], - "requested": [ # A list of full type names of requested contexts. + "requested": [ # A list of full type names of requested contexts, only the requested context will be made available to the backend. "A String", ], "selector": "A String", # Selects the methods to which this rule applies. Refer to selector for syntax details. @@ -258,7 +258,7 @@

Method Details

"A String", ], }, - "documentation": { # `Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... code_snippet_rules: - selector: google.calendar.Calendar.Delete code_snippets: - includes: - github_include: region_tag: calendar_delete code_language: JAVA account: GoogleCloudPlatform project: java-docs-samples file: calendar/delete.java Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. # Additional API documentation. + "documentation": { # `Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. # Additional API documentation. "documentationRootUrl": "A String", # The URL to the root of documentation. "overview": "A String", # Declares a single overview page. For example: documentation: summary: ... overview: (== include overview.md ==) This is a shortcut for the following declaration (using pages style): documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) Note: you cannot specify both `overview` field and `pages` field. "pages": [ # The top level pages for the documentation set. @@ -335,7 +335,7 @@

Method Details

"http": { # Defines the HTTP configuration for an API service. It contains a list of HttpRule, each specifying the mapping of an RPC method to one or more HTTP REST API methods. # HTTP configuration. "fullyDecodeReservedExpansion": True or False, # When set to true, URL path parameters will be fully URI-decoded except in cases of single segment matches in reserved expansion, where "%2F" will be left encoded. The default behavior is to not decode RFC 6570 reserved characters in multi segment matches. "rules": [ # A list of HTTP configuration rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. - { # gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/{name=messages/*}" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: "messages/123456")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:"/v1/messages/{message_id}" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A&param=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "message" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" }` - gRPC: `UpdateMessage(message_id: "123456" message { text: "Hi!" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "*" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" }` - gRPC: `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/messages/{message_id}" additional_bindings { get: "/v1/users/{user_id}/messages/{message_id}" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: "123456")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: "me" message_id: "123456")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is "*", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = "/" Segments [ Verb ] ; Segments = Segment { "/" Segment } ; Segment = "*" | "**" | LITERAL | Variable ; Variable = "{" FieldPath [ "=" Segments ] "}" ; FieldPath = IDENT { "." IDENT } ; Verb = ":" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `"{var}"` or `"{var=*}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `"{var=foo/*}"` or `"{var=**}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except "%2F" and "%2f" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. Example below selects a gRPC method and applies HttpRule to it. http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading "/" character. The reason is that the most common use case "{var}" does not capture the leading "/" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature. + { # gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/{name=messages/*}" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: "messages/123456")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:"/v1/messages/{message_id}" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A&param=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "message" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" }` - gRPC: `UpdateMessage(message_id: "123456" message { text: "Hi!" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "*" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" }` - gRPC: `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/messages/{message_id}" additional_bindings { get: "/v1/users/{user_id}/messages/{message_id}" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: "123456")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: "me" message_id: "123456")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is "*", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = "/" Segments [ Verb ] ; Segments = Segment { "/" Segment } ; Segment = "*" | "**" | LITERAL | Variable ; Variable = "{" FieldPath [ "=" Segments ] "}" ; FieldPath = IDENT { "." IDENT } ; Verb = ":" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `"{var}"` or `"{var=*}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `"{var=foo/*}"` or `"{var=**}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except "%2F" and "%2f" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. The following example selects a gRPC method and applies an `HttpRule` to it: http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading "/" character. The reason is that the most common use case "{var}" does not capture the leading "/" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature. "additionalBindings": [ # Additional HTTP bindings for the selector. Nested bindings must not contain an `additional_bindings` field themselves (that is, the nesting may only be one level deep). # Object with schema name: HttpRule ], @@ -837,10 +837,10 @@

Method Details

"allowedResponseExtensions": [ # A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client. "A String", ], - "provided": [ # A list of full type names of provided contexts. + "provided": [ # A list of full type names of provided contexts. It is used to support propagating HTTP headers and ETags from the response extension. "A String", ], - "requested": [ # A list of full type names of requested contexts. + "requested": [ # A list of full type names of requested contexts, only the requested context will be made available to the backend. "A String", ], "selector": "A String", # Selects the methods to which this rule applies. Refer to selector for syntax details. @@ -873,7 +873,7 @@

Method Details

"A String", ], }, - "documentation": { # `Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... code_snippet_rules: - selector: google.calendar.Calendar.Delete code_snippets: - includes: - github_include: region_tag: calendar_delete code_language: JAVA account: GoogleCloudPlatform project: java-docs-samples file: calendar/delete.java Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. # Additional API documentation. + "documentation": { # `Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. # Additional API documentation. "documentationRootUrl": "A String", # The URL to the root of documentation. "overview": "A String", # Declares a single overview page. For example: documentation: summary: ... overview: (== include overview.md ==) This is a shortcut for the following declaration (using pages style): documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) Note: you cannot specify both `overview` field and `pages` field. "pages": [ # The top level pages for the documentation set. @@ -950,7 +950,7 @@

Method Details

"http": { # Defines the HTTP configuration for an API service. It contains a list of HttpRule, each specifying the mapping of an RPC method to one or more HTTP REST API methods. # HTTP configuration. "fullyDecodeReservedExpansion": True or False, # When set to true, URL path parameters will be fully URI-decoded except in cases of single segment matches in reserved expansion, where "%2F" will be left encoded. The default behavior is to not decode RFC 6570 reserved characters in multi segment matches. "rules": [ # A list of HTTP configuration rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. - { # gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/{name=messages/*}" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: "messages/123456")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:"/v1/messages/{message_id}" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A&param=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "message" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" }` - gRPC: `UpdateMessage(message_id: "123456" message { text: "Hi!" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "*" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" }` - gRPC: `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/messages/{message_id}" additional_bindings { get: "/v1/users/{user_id}/messages/{message_id}" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: "123456")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: "me" message_id: "123456")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is "*", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = "/" Segments [ Verb ] ; Segments = Segment { "/" Segment } ; Segment = "*" | "**" | LITERAL | Variable ; Variable = "{" FieldPath [ "=" Segments ] "}" ; FieldPath = IDENT { "." IDENT } ; Verb = ":" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `"{var}"` or `"{var=*}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `"{var=foo/*}"` or `"{var=**}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except "%2F" and "%2f" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. Example below selects a gRPC method and applies HttpRule to it. http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading "/" character. The reason is that the most common use case "{var}" does not capture the leading "/" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature. + { # gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/{name=messages/*}" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: "messages/123456")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:"/v1/messages/{message_id}" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A&param=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "message" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" }` - gRPC: `UpdateMessage(message_id: "123456" message { text: "Hi!" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "*" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" }` - gRPC: `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/messages/{message_id}" additional_bindings { get: "/v1/users/{user_id}/messages/{message_id}" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: "123456")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: "me" message_id: "123456")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is "*", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = "/" Segments [ Verb ] ; Segments = Segment { "/" Segment } ; Segment = "*" | "**" | LITERAL | Variable ; Variable = "{" FieldPath [ "=" Segments ] "}" ; FieldPath = IDENT { "." IDENT } ; Verb = ":" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `"{var}"` or `"{var=*}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `"{var=foo/*}"` or `"{var=**}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except "%2F" and "%2f" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. The following example selects a gRPC method and applies an `HttpRule` to it: http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading "/" character. The reason is that the most common use case "{var}" does not capture the leading "/" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature. "additionalBindings": [ # Additional HTTP bindings for the selector. Nested bindings must not contain an `additional_bindings` field themselves (that is, the nesting may only be one level deep). # Object with schema name: HttpRule ], @@ -1464,10 +1464,10 @@

Method Details

"allowedResponseExtensions": [ # A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client. "A String", ], - "provided": [ # A list of full type names of provided contexts. + "provided": [ # A list of full type names of provided contexts. It is used to support propagating HTTP headers and ETags from the response extension. "A String", ], - "requested": [ # A list of full type names of requested contexts. + "requested": [ # A list of full type names of requested contexts, only the requested context will be made available to the backend. "A String", ], "selector": "A String", # Selects the methods to which this rule applies. Refer to selector for syntax details. @@ -1500,7 +1500,7 @@

Method Details

"A String", ], }, - "documentation": { # `Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... code_snippet_rules: - selector: google.calendar.Calendar.Delete code_snippets: - includes: - github_include: region_tag: calendar_delete code_language: JAVA account: GoogleCloudPlatform project: java-docs-samples file: calendar/delete.java Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. # Additional API documentation. + "documentation": { # `Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. # Additional API documentation. "documentationRootUrl": "A String", # The URL to the root of documentation. "overview": "A String", # Declares a single overview page. For example: documentation: summary: ... overview: (== include overview.md ==) This is a shortcut for the following declaration (using pages style): documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) Note: you cannot specify both `overview` field and `pages` field. "pages": [ # The top level pages for the documentation set. @@ -1577,7 +1577,7 @@

Method Details

"http": { # Defines the HTTP configuration for an API service. It contains a list of HttpRule, each specifying the mapping of an RPC method to one or more HTTP REST API methods. # HTTP configuration. "fullyDecodeReservedExpansion": True or False, # When set to true, URL path parameters will be fully URI-decoded except in cases of single segment matches in reserved expansion, where "%2F" will be left encoded. The default behavior is to not decode RFC 6570 reserved characters in multi segment matches. "rules": [ # A list of HTTP configuration rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. - { # gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/{name=messages/*}" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: "messages/123456")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:"/v1/messages/{message_id}" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A&param=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "message" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" }` - gRPC: `UpdateMessage(message_id: "123456" message { text: "Hi!" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "*" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" }` - gRPC: `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/messages/{message_id}" additional_bindings { get: "/v1/users/{user_id}/messages/{message_id}" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: "123456")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: "me" message_id: "123456")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is "*", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = "/" Segments [ Verb ] ; Segments = Segment { "/" Segment } ; Segment = "*" | "**" | LITERAL | Variable ; Variable = "{" FieldPath [ "=" Segments ] "}" ; FieldPath = IDENT { "." IDENT } ; Verb = ":" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `"{var}"` or `"{var=*}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `"{var=foo/*}"` or `"{var=**}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except "%2F" and "%2f" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. Example below selects a gRPC method and applies HttpRule to it. http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading "/" character. The reason is that the most common use case "{var}" does not capture the leading "/" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature. + { # gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/{name=messages/*}" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: "messages/123456")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:"/v1/messages/{message_id}" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A&param=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "message" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" }` - gRPC: `UpdateMessage(message_id: "123456" message { text: "Hi!" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "*" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" }` - gRPC: `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/messages/{message_id}" additional_bindings { get: "/v1/users/{user_id}/messages/{message_id}" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: "123456")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: "me" message_id: "123456")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is "*", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = "/" Segments [ Verb ] ; Segments = Segment { "/" Segment } ; Segment = "*" | "**" | LITERAL | Variable ; Variable = "{" FieldPath [ "=" Segments ] "}" ; FieldPath = IDENT { "." IDENT } ; Verb = ":" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `"{var}"` or `"{var=*}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `"{var=foo/*}"` or `"{var=**}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except "%2F" and "%2f" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. The following example selects a gRPC method and applies an `HttpRule` to it: http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading "/" character. The reason is that the most common use case "{var}" does not capture the leading "/" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature. "additionalBindings": [ # Additional HTTP bindings for the selector. Nested bindings must not contain an `additional_bindings` field themselves (that is, the nesting may only be one level deep). # Object with schema name: HttpRule ], @@ -2091,10 +2091,10 @@

Method Details

"allowedResponseExtensions": [ # A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client. "A String", ], - "provided": [ # A list of full type names of provided contexts. + "provided": [ # A list of full type names of provided contexts. It is used to support propagating HTTP headers and ETags from the response extension. "A String", ], - "requested": [ # A list of full type names of requested contexts. + "requested": [ # A list of full type names of requested contexts, only the requested context will be made available to the backend. "A String", ], "selector": "A String", # Selects the methods to which this rule applies. Refer to selector for syntax details. @@ -2127,7 +2127,7 @@

Method Details

"A String", ], }, - "documentation": { # `Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... code_snippet_rules: - selector: google.calendar.Calendar.Delete code_snippets: - includes: - github_include: region_tag: calendar_delete code_language: JAVA account: GoogleCloudPlatform project: java-docs-samples file: calendar/delete.java Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. # Additional API documentation. + "documentation": { # `Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. # Additional API documentation. "documentationRootUrl": "A String", # The URL to the root of documentation. "overview": "A String", # Declares a single overview page. For example: documentation: summary: ... overview: (== include overview.md ==) This is a shortcut for the following declaration (using pages style): documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) Note: you cannot specify both `overview` field and `pages` field. "pages": [ # The top level pages for the documentation set. @@ -2204,7 +2204,7 @@

Method Details

"http": { # Defines the HTTP configuration for an API service. It contains a list of HttpRule, each specifying the mapping of an RPC method to one or more HTTP REST API methods. # HTTP configuration. "fullyDecodeReservedExpansion": True or False, # When set to true, URL path parameters will be fully URI-decoded except in cases of single segment matches in reserved expansion, where "%2F" will be left encoded. The default behavior is to not decode RFC 6570 reserved characters in multi segment matches. "rules": [ # A list of HTTP configuration rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. - { # gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/{name=messages/*}" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: "messages/123456")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:"/v1/messages/{message_id}" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A&param=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "message" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" }` - gRPC: `UpdateMessage(message_id: "123456" message { text: "Hi!" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "*" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" }` - gRPC: `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/messages/{message_id}" additional_bindings { get: "/v1/users/{user_id}/messages/{message_id}" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: "123456")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: "me" message_id: "123456")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is "*", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = "/" Segments [ Verb ] ; Segments = Segment { "/" Segment } ; Segment = "*" | "**" | LITERAL | Variable ; Variable = "{" FieldPath [ "=" Segments ] "}" ; FieldPath = IDENT { "." IDENT } ; Verb = ":" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `"{var}"` or `"{var=*}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `"{var=foo/*}"` or `"{var=**}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except "%2F" and "%2f" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. Example below selects a gRPC method and applies HttpRule to it. http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading "/" character. The reason is that the most common use case "{var}" does not capture the leading "/" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature. + { # gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/{name=messages/*}" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: "messages/123456")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:"/v1/messages/{message_id}" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A&param=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "message" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" }` - gRPC: `UpdateMessage(message_id: "123456" message { text: "Hi!" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "*" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" }` - gRPC: `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/messages/{message_id}" additional_bindings { get: "/v1/users/{user_id}/messages/{message_id}" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: "123456")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: "me" message_id: "123456")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is "*", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = "/" Segments [ Verb ] ; Segments = Segment { "/" Segment } ; Segment = "*" | "**" | LITERAL | Variable ; Variable = "{" FieldPath [ "=" Segments ] "}" ; FieldPath = IDENT { "." IDENT } ; Verb = ":" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `"{var}"` or `"{var=*}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `"{var=foo/*}"` or `"{var=**}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except "%2F" and "%2f" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. The following example selects a gRPC method and applies an `HttpRule` to it: http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading "/" character. The reason is that the most common use case "{var}" does not capture the leading "/" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature. "additionalBindings": [ # Additional HTTP bindings for the selector. Nested bindings must not contain an `additional_bindings` field themselves (that is, the nesting may only be one level deep). # Object with schema name: HttpRule ], diff --git a/docs/dyn/servicemanagement_v1.services.html b/docs/dyn/servicemanagement_v1.services.html index ca52972baf8..e4e35931ab5 100644 --- a/docs/dyn/servicemanagement_v1.services.html +++ b/docs/dyn/servicemanagement_v1.services.html @@ -417,10 +417,10 @@

Method Details

"allowedResponseExtensions": [ # A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client. "A String", ], - "provided": [ # A list of full type names of provided contexts. + "provided": [ # A list of full type names of provided contexts. It is used to support propagating HTTP headers and ETags from the response extension. "A String", ], - "requested": [ # A list of full type names of requested contexts. + "requested": [ # A list of full type names of requested contexts, only the requested context will be made available to the backend. "A String", ], "selector": "A String", # Selects the methods to which this rule applies. Refer to selector for syntax details. @@ -453,7 +453,7 @@

Method Details

"A String", ], }, - "documentation": { # `Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... code_snippet_rules: - selector: google.calendar.Calendar.Delete code_snippets: - includes: - github_include: region_tag: calendar_delete code_language: JAVA account: GoogleCloudPlatform project: java-docs-samples file: calendar/delete.java Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. # Additional API documentation. + "documentation": { # `Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. # Additional API documentation. "documentationRootUrl": "A String", # The URL to the root of documentation. "overview": "A String", # Declares a single overview page. For example: documentation: summary: ... overview: (== include overview.md ==) This is a shortcut for the following declaration (using pages style): documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) Note: you cannot specify both `overview` field and `pages` field. "pages": [ # The top level pages for the documentation set. @@ -530,7 +530,7 @@

Method Details

"http": { # Defines the HTTP configuration for an API service. It contains a list of HttpRule, each specifying the mapping of an RPC method to one or more HTTP REST API methods. # HTTP configuration. "fullyDecodeReservedExpansion": True or False, # When set to true, URL path parameters will be fully URI-decoded except in cases of single segment matches in reserved expansion, where "%2F" will be left encoded. The default behavior is to not decode RFC 6570 reserved characters in multi segment matches. "rules": [ # A list of HTTP configuration rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. - { # gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/{name=messages/*}" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: "messages/123456")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:"/v1/messages/{message_id}" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A&param=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "message" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" }` - gRPC: `UpdateMessage(message_id: "123456" message { text: "Hi!" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "*" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" }` - gRPC: `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/messages/{message_id}" additional_bindings { get: "/v1/users/{user_id}/messages/{message_id}" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: "123456")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: "me" message_id: "123456")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is "*", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = "/" Segments [ Verb ] ; Segments = Segment { "/" Segment } ; Segment = "*" | "**" | LITERAL | Variable ; Variable = "{" FieldPath [ "=" Segments ] "}" ; FieldPath = IDENT { "." IDENT } ; Verb = ":" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `"{var}"` or `"{var=*}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `"{var=foo/*}"` or `"{var=**}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except "%2F" and "%2f" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. Example below selects a gRPC method and applies HttpRule to it. http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading "/" character. The reason is that the most common use case "{var}" does not capture the leading "/" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature. + { # gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/{name=messages/*}" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: "messages/123456")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:"/v1/messages/{message_id}" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A&param=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "message" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" }` - gRPC: `UpdateMessage(message_id: "123456" message { text: "Hi!" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "*" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" }` - gRPC: `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/messages/{message_id}" additional_bindings { get: "/v1/users/{user_id}/messages/{message_id}" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: "123456")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: "me" message_id: "123456")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is "*", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = "/" Segments [ Verb ] ; Segments = Segment { "/" Segment } ; Segment = "*" | "**" | LITERAL | Variable ; Variable = "{" FieldPath [ "=" Segments ] "}" ; FieldPath = IDENT { "." IDENT } ; Verb = ":" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `"{var}"` or `"{var=*}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `"{var=foo/*}"` or `"{var=**}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except "%2F" and "%2f" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. The following example selects a gRPC method and applies an `HttpRule` to it: http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading "/" character. The reason is that the most common use case "{var}" does not capture the leading "/" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature. "additionalBindings": [ # Additional HTTP bindings for the selector. Nested bindings must not contain an `additional_bindings` field themselves (that is, the nesting may only be one level deep). # Object with schema name: HttpRule ], diff --git a/docs/dyn/serviceusage_v1.services.html b/docs/dyn/serviceusage_v1.services.html index 92c71f53320..800009e2442 100644 --- a/docs/dyn/serviceusage_v1.services.html +++ b/docs/dyn/serviceusage_v1.services.html @@ -238,7 +238,7 @@

Method Details

}, ], }, - "documentation": { # `Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... code_snippet_rules: - selector: google.calendar.Calendar.Delete code_snippets: - includes: - github_include: region_tag: calendar_delete code_language: JAVA account: GoogleCloudPlatform project: java-docs-samples file: calendar/delete.java Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. # Additional API documentation. Contains only the summary and the documentation URL. + "documentation": { # `Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. # Additional API documentation. Contains only the summary and the documentation URL. "documentationRootUrl": "A String", # The URL to the root of documentation. "overview": "A String", # Declares a single overview page. For example: documentation: summary: ... overview: (== include overview.md ==) This is a shortcut for the following declaration (using pages style): documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) Note: you cannot specify both `overview` field and `pages` field. "pages": [ # The top level pages for the documentation set. @@ -545,7 +545,7 @@

Method Details

}, ], }, - "documentation": { # `Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... code_snippet_rules: - selector: google.calendar.Calendar.Delete code_snippets: - includes: - github_include: region_tag: calendar_delete code_language: JAVA account: GoogleCloudPlatform project: java-docs-samples file: calendar/delete.java Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. # Additional API documentation. Contains only the summary and the documentation URL. + "documentation": { # `Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. # Additional API documentation. Contains only the summary and the documentation URL. "documentationRootUrl": "A String", # The URL to the root of documentation. "overview": "A String", # Declares a single overview page. For example: documentation: summary: ... overview: (== include overview.md ==) This is a shortcut for the following declaration (using pages style): documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) Note: you cannot specify both `overview` field and `pages` field. "pages": [ # The top level pages for the documentation set. @@ -767,7 +767,7 @@

Method Details

}, ], }, - "documentation": { # `Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... code_snippet_rules: - selector: google.calendar.Calendar.Delete code_snippets: - includes: - github_include: region_tag: calendar_delete code_language: JAVA account: GoogleCloudPlatform project: java-docs-samples file: calendar/delete.java Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. # Additional API documentation. Contains only the summary and the documentation URL. + "documentation": { # `Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. # Additional API documentation. Contains only the summary and the documentation URL. "documentationRootUrl": "A String", # The URL to the root of documentation. "overview": "A String", # Declares a single overview page. For example: documentation: summary: ... overview: (== include overview.md ==) This is a shortcut for the following declaration (using pages style): documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) Note: you cannot specify both `overview` field and `pages` field. "pages": [ # The top level pages for the documentation set. diff --git a/docs/dyn/serviceusage_v1beta1.services.html b/docs/dyn/serviceusage_v1beta1.services.html index 4fcdc845e6d..a1e199964e9 100644 --- a/docs/dyn/serviceusage_v1beta1.services.html +++ b/docs/dyn/serviceusage_v1beta1.services.html @@ -362,7 +362,7 @@

Method Details

}, ], }, - "documentation": { # `Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... code_snippet_rules: - selector: google.calendar.Calendar.Delete code_snippets: - includes: - github_include: region_tag: calendar_delete code_language: JAVA account: GoogleCloudPlatform project: java-docs-samples file: calendar/delete.java Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. # Additional API documentation. Contains only the summary and the documentation URL. + "documentation": { # `Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. # Additional API documentation. Contains only the summary and the documentation URL. "documentationRootUrl": "A String", # The URL to the root of documentation. "overview": "A String", # Declares a single overview page. For example: documentation: summary: ... overview: (== include overview.md ==) This is a shortcut for the following declaration (using pages style): documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) Note: you cannot specify both `overview` field and `pages` field. "pages": [ # The top level pages for the documentation set. @@ -584,7 +584,7 @@

Method Details

}, ], }, - "documentation": { # `Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... code_snippet_rules: - selector: google.calendar.Calendar.Delete code_snippets: - includes: - github_include: region_tag: calendar_delete code_language: JAVA account: GoogleCloudPlatform project: java-docs-samples file: calendar/delete.java Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. # Additional API documentation. Contains only the summary and the documentation URL. + "documentation": { # `Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. # Additional API documentation. Contains only the summary and the documentation URL. "documentationRootUrl": "A String", # The URL to the root of documentation. "overview": "A String", # Declares a single overview page. For example: documentation: summary: ... overview: (== include overview.md ==) This is a shortcut for the following declaration (using pages style): documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) Note: you cannot specify both `overview` field and `pages` field. "pages": [ # The top level pages for the documentation set. diff --git a/docs/dyn/sheets_v4.spreadsheets.html b/docs/dyn/sheets_v4.spreadsheets.html index 1ee99e8e782..7a547765002 100644 --- a/docs/dyn/sheets_v4.spreadsheets.html +++ b/docs/dyn/sheets_v4.spreadsheets.html @@ -2176,6 +2176,11 @@

Method Details

"tableProjectId": "A String", # The ID of a BigQuery project the table belongs to. If not specified, the project_id is assumed. }, }, + "looker": { # The specification of a Looker data source. # A LookerDatasourceSpec. + "explore": "A String", # Name of a LookerML model explore. + "instanceUri": "A String", # A Looker instance URL. + "model": "A String", # Name of a LookerML model. + }, "parameters": [ # The parameters of the data source, used when querying the data source. { # A parameter in a data source's query. The parameter allows the user to pass in values from the spreadsheet into a query. "name": "A String", # Named parameter. Must be a legitimate identifier for the DataSource that supports it. For example, [BigQuery identifier](https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical#identifiers). @@ -7450,6 +7455,11 @@

Method Details

"tableProjectId": "A String", # The ID of a BigQuery project the table belongs to. If not specified, the project_id is assumed. }, }, + "looker": { # The specification of a Looker data source. # A LookerDatasourceSpec. + "explore": "A String", # Name of a LookerML model explore. + "instanceUri": "A String", # A Looker instance URL. + "model": "A String", # Name of a LookerML model. + }, "parameters": [ # The parameters of the data source, used when querying the data source. { # A parameter in a data source's query. The parameter allows the user to pass in values from the spreadsheet into a query. "name": "A String", # Named parameter. Must be a legitimate identifier for the DataSource that supports it. For example, [BigQuery identifier](https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical#identifiers). @@ -10000,6 +10010,11 @@

Method Details

"tableProjectId": "A String", # The ID of a BigQuery project the table belongs to. If not specified, the project_id is assumed. }, }, + "looker": { # The specification of a Looker data source. # A LookerDatasourceSpec. + "explore": "A String", # Name of a LookerML model explore. + "instanceUri": "A String", # A Looker instance URL. + "model": "A String", # Name of a LookerML model. + }, "parameters": [ # The parameters of the data source, used when querying the data source. { # A parameter in a data source's query. The parameter allows the user to pass in values from the spreadsheet into a query. "name": "A String", # Named parameter. Must be a legitimate identifier for the DataSource that supports it. For example, [BigQuery identifier](https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical#identifiers). @@ -11425,6 +11440,11 @@

Method Details

"tableProjectId": "A String", # The ID of a BigQuery project the table belongs to. If not specified, the project_id is assumed. }, }, + "looker": { # The specification of a Looker data source. # A LookerDatasourceSpec. + "explore": "A String", # Name of a LookerML model explore. + "instanceUri": "A String", # A Looker instance URL. + "model": "A String", # Name of a LookerML model. + }, "parameters": [ # The parameters of the data source, used when querying the data source. { # A parameter in a data source's query. The parameter allows the user to pass in values from the spreadsheet into a query. "name": "A String", # Named parameter. Must be a legitimate identifier for the DataSource that supports it. For example, [BigQuery identifier](https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical#identifiers). @@ -11547,6 +11567,11 @@

Method Details

"tableProjectId": "A String", # The ID of a BigQuery project the table belongs to. If not specified, the project_id is assumed. }, }, + "looker": { # The specification of a Looker data source. # A LookerDatasourceSpec. + "explore": "A String", # Name of a LookerML model explore. + "instanceUri": "A String", # A Looker instance URL. + "model": "A String", # Name of a LookerML model. + }, "parameters": [ # The parameters of the data source, used when querying the data source. { # A parameter in a data source's query. The parameter allows the user to pass in values from the spreadsheet into a query. "name": "A String", # Named parameter. Must be a legitimate identifier for the DataSource that supports it. For example, [BigQuery identifier](https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical#identifiers). @@ -15207,6 +15232,11 @@

Method Details

"tableProjectId": "A String", # The ID of a BigQuery project the table belongs to. If not specified, the project_id is assumed. }, }, + "looker": { # The specification of a Looker data source. # A LookerDatasourceSpec. + "explore": "A String", # Name of a LookerML model explore. + "instanceUri": "A String", # A Looker instance URL. + "model": "A String", # Name of a LookerML model. + }, "parameters": [ # The parameters of the data source, used when querying the data source. { # A parameter in a data source's query. The parameter allows the user to pass in values from the spreadsheet into a query. "name": "A String", # Named parameter. Must be a legitimate identifier for the DataSource that supports it. For example, [BigQuery identifier](https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical#identifiers). @@ -18860,6 +18890,11 @@

Method Details

"tableProjectId": "A String", # The ID of a BigQuery project the table belongs to. If not specified, the project_id is assumed. }, }, + "looker": { # The specification of a Looker data source. # A LookerDatasourceSpec. + "explore": "A String", # Name of a LookerML model explore. + "instanceUri": "A String", # A Looker instance URL. + "model": "A String", # Name of a LookerML model. + }, "parameters": [ # The parameters of the data source, used when querying the data source. { # A parameter in a data source's query. The parameter allows the user to pass in values from the spreadsheet into a query. "name": "A String", # Named parameter. Must be a legitimate identifier for the DataSource that supports it. For example, [BigQuery identifier](https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical#identifiers). @@ -22522,6 +22557,11 @@

Method Details

"tableProjectId": "A String", # The ID of a BigQuery project the table belongs to. If not specified, the project_id is assumed. }, }, + "looker": { # The specification of a Looker data source. # A LookerDatasourceSpec. + "explore": "A String", # Name of a LookerML model explore. + "instanceUri": "A String", # A Looker instance URL. + "model": "A String", # Name of a LookerML model. + }, "parameters": [ # The parameters of the data source, used when querying the data source. { # A parameter in a data source's query. The parameter allows the user to pass in values from the spreadsheet into a query. "name": "A String", # Named parameter. Must be a legitimate identifier for the DataSource that supports it. For example, [BigQuery identifier](https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical#identifiers). @@ -26220,6 +26260,11 @@

Method Details

"tableProjectId": "A String", # The ID of a BigQuery project the table belongs to. If not specified, the project_id is assumed. }, }, + "looker": { # The specification of a Looker data source. # A LookerDatasourceSpec. + "explore": "A String", # Name of a LookerML model explore. + "instanceUri": "A String", # A Looker instance URL. + "model": "A String", # Name of a LookerML model. + }, "parameters": [ # The parameters of the data source, used when querying the data source. { # A parameter in a data source's query. The parameter allows the user to pass in values from the spreadsheet into a query. "name": "A String", # Named parameter. Must be a legitimate identifier for the DataSource that supports it. For example, [BigQuery identifier](https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical#identifiers). diff --git a/docs/dyn/spanner_v1.projects.instances.backups.html b/docs/dyn/spanner_v1.projects.instances.backups.html index 7151539183c..c1fcaf72b53 100644 --- a/docs/dyn/spanner_v1.projects.instances.backups.html +++ b/docs/dyn/spanner_v1.projects.instances.backups.html @@ -179,6 +179,9 @@

Method Details

The object takes the form of: { # A backup of a Cloud Spanner database. + "backupSchedules": [ # Output only. List of backup schedule URIs that are associated with creating this backup. This is only applicable for scheduled backups, and is empty for on-demand backups. To optimize for storage, whenever possible, multiple schedules are collapsed together to create one backup. In such cases, this field captures the list of all backup schedule URIs that are associated with creating this backup. If collapsing is not done, then this field captures the single backup schedule URI associated with creating this backup. + "A String", + ], "createTime": "A String", # Output only. The time the CreateBackup request is received. If the request does not specify `version_time`, the `version_time` of the backup will be equivalent to the `create_time`. "database": "A String", # Required for the CreateBackup operation. Name of the database from which this backup was created. This needs to be in the same instance as the backup. Values are of the form `projects//instances//databases/`. "databaseDialect": "A String", # Output only. The database dialect information for the backup. @@ -295,6 +298,9 @@

Method Details

An object of the form: { # A backup of a Cloud Spanner database. + "backupSchedules": [ # Output only. List of backup schedule URIs that are associated with creating this backup. This is only applicable for scheduled backups, and is empty for on-demand backups. To optimize for storage, whenever possible, multiple schedules are collapsed together to create one backup. In such cases, this field captures the list of all backup schedule URIs that are associated with creating this backup. If collapsing is not done, then this field captures the single backup schedule URI associated with creating this backup. + "A String", + ], "createTime": "A String", # Output only. The time the CreateBackup request is received. If the request does not specify `version_time`, the `version_time` of the backup will be equivalent to the `create_time`. "database": "A String", # Required for the CreateBackup operation. Name of the database from which this backup was created. This needs to be in the same instance as the backup. Values are of the form `projects//instances//databases/`. "databaseDialect": "A String", # Output only. The database dialect information for the backup. @@ -404,6 +410,9 @@

Method Details

{ # The response for ListBackups. "backups": [ # The list of matching backups. Backups returned are ordered by `create_time` in descending order, starting from the most recent `create_time`. { # A backup of a Cloud Spanner database. + "backupSchedules": [ # Output only. List of backup schedule URIs that are associated with creating this backup. This is only applicable for scheduled backups, and is empty for on-demand backups. To optimize for storage, whenever possible, multiple schedules are collapsed together to create one backup. In such cases, this field captures the list of all backup schedule URIs that are associated with creating this backup. If collapsing is not done, then this field captures the single backup schedule URI associated with creating this backup. + "A String", + ], "createTime": "A String", # Output only. The time the CreateBackup request is received. If the request does not specify `version_time`, the `version_time` of the backup will be equivalent to the `create_time`. "database": "A String", # Required for the CreateBackup operation. Name of the database from which this backup was created. This needs to be in the same instance as the backup. Values are of the form `projects//instances//databases/`. "databaseDialect": "A String", # Output only. The database dialect information for the backup. @@ -477,6 +486,9 @@

Method Details

The object takes the form of: { # A backup of a Cloud Spanner database. + "backupSchedules": [ # Output only. List of backup schedule URIs that are associated with creating this backup. This is only applicable for scheduled backups, and is empty for on-demand backups. To optimize for storage, whenever possible, multiple schedules are collapsed together to create one backup. In such cases, this field captures the list of all backup schedule URIs that are associated with creating this backup. If collapsing is not done, then this field captures the single backup schedule URI associated with creating this backup. + "A String", + ], "createTime": "A String", # Output only. The time the CreateBackup request is received. If the request does not specify `version_time`, the `version_time` of the backup will be equivalent to the `create_time`. "database": "A String", # Required for the CreateBackup operation. Name of the database from which this backup was created. This needs to be in the same instance as the backup. Values are of the form `projects//instances//databases/`. "databaseDialect": "A String", # Output only. The database dialect information for the backup. @@ -532,6 +544,9 @@

Method Details

An object of the form: { # A backup of a Cloud Spanner database. + "backupSchedules": [ # Output only. List of backup schedule URIs that are associated with creating this backup. This is only applicable for scheduled backups, and is empty for on-demand backups. To optimize for storage, whenever possible, multiple schedules are collapsed together to create one backup. In such cases, this field captures the list of all backup schedule URIs that are associated with creating this backup. If collapsing is not done, then this field captures the single backup schedule URI associated with creating this backup. + "A String", + ], "createTime": "A String", # Output only. The time the CreateBackup request is received. If the request does not specify `version_time`, the `version_time` of the backup will be equivalent to the `create_time`. "database": "A String", # Required for the CreateBackup operation. Name of the database from which this backup was created. This needs to be in the same instance as the backup. Values are of the form `projects//instances//databases/`. "databaseDialect": "A String", # Output only. The database dialect information for the backup. diff --git a/docs/dyn/spanner_v1.projects.instances.databases.backupSchedules.html b/docs/dyn/spanner_v1.projects.instances.databases.backupSchedules.html index 076f6e0e5af..dca1fc93521 100644 --- a/docs/dyn/spanner_v1.projects.instances.databases.backupSchedules.html +++ b/docs/dyn/spanner_v1.projects.instances.databases.backupSchedules.html @@ -77,9 +77,27 @@

Instance Methods

close()

Close httplib2 connections.

+

+ create(parent, backupScheduleId=None, body=None, x__xgafv=None)

+

Creates a new backup schedule.

+

+ delete(name, x__xgafv=None)

+

Deletes a backup schedule.

+

+ get(name, x__xgafv=None)

+

Gets backup schedule for the input schedule name.

getIamPolicy(resource, body=None, x__xgafv=None)

Gets the access control policy for a database or backup resource. Returns an empty policy if a database or backup exists but does not have a policy set. Authorization requires `spanner.databases.getIamPolicy` permission on resource. For backups, authorization requires `spanner.backups.getIamPolicy` permission on resource.

+

+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists all the backup schedules for the database.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(name, body=None, updateMask=None, x__xgafv=None)

+

Updates a backup schedule.

setIamPolicy(resource, body=None, x__xgafv=None)

Sets the access control policy on a database or backup resource. Replaces any existing policy. Authorization requires `spanner.databases.setIamPolicy` permission on resource. For backups, authorization requires `spanner.backups.setIamPolicy` permission on resource.

@@ -92,6 +110,124 @@

Method Details

Close httplib2 connections.
+
+ create(parent, backupScheduleId=None, body=None, x__xgafv=None) +
Creates a new backup schedule.
+
+Args:
+  parent: string, Required. The name of the database that this backup schedule applies to. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # BackupSchedule expresses the automated backup creation specification for a Spanner database. Next ID: 10
+  "encryptionConfig": { # Encryption configuration for the backup to create. # Optional. The encryption configuration that will be used to encrypt the backup. If this field is not specified, the backup will use the same encryption configuration as the database.
+    "encryptionType": "A String", # Required. The encryption type of the backup.
+    "kmsKeyName": "A String", # Optional. The Cloud KMS key that will be used to protect the backup. This field should be set only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`.
+    "kmsKeyNames": [ # Optional. Specifies the KMS configuration for the one or more keys used to protect the backup. Values are of the form `projects//locations//keyRings//cryptoKeys/`. The keys referenced by kms_key_names must fully cover all regions of the backup's instance configuration. Some examples: * For single region instance configs, specify a single regional location KMS key. * For multi-regional instance configs of type GOOGLE_MANAGED, either specify a multi-regional location KMS key or multiple regional location KMS keys that cover all regions in the instance config. * For an instance config of type USER_MANAGED, please specify only regional location KMS keys to cover each region in the instance config. Multi-regional location KMS keys are not supported for USER_MANAGED instance configs.
+      "A String",
+    ],
+  },
+  "fullBackupSpec": { # The specification for full backups. A full backup stores the entire contents of the database at a given version time. # The schedule creates only full backups.
+  },
+  "name": "A String", # Identifier. Output only for the CreateBackupSchedule operation. Required for the UpdateBackupSchedule operation. A globally unique identifier for the backup schedule which cannot be changed. Values are of the form `projects//instances//databases//backupSchedules/a-z*[a-z0-9]` The final segment of the name must be between 2 and 60 characters in length.
+  "retentionDuration": "A String", # Optional. The retention duration of a backup that must be at least 6 hours and at most 366 days. The backup is eligible to be automatically deleted once the retention period has elapsed.
+  "spec": { # Defines specifications of the backup schedule. # Optional. The schedule specification based on which the backup creations are triggered.
+    "cronSpec": { # CrontabSpec can be used to specify the version time and frequency at which the backup should be created. # Cron style schedule specification.
+      "creationWindow": "A String", # Output only. Schedule backups will contain an externally consistent copy of the database at the version time specified in `schedule_spec.cron_spec`. However, Spanner may not initiate the creation of the scheduled backups at that version time. Spanner will initiate the creation of scheduled backups within the time window bounded by the version_time specified in `schedule_spec.cron_spec` and version_time + `creation_window`.
+      "text": "A String", # Required. Textual representation of the crontab. User can customize the backup frequency and the backup version time using the cron expression. The version time must be in UTC timzeone. The backup will contain an externally consistent copy of the database at the version time. Allowed frequencies are 12 hour, 1 day, 1 week and 1 month. Examples of valid cron specifications: * `0 2/12 * * * ` : every 12 hours at (2, 14) hours past midnight in UTC. * `0 2,14 * * * ` : every 12 hours at (2,14) hours past midnight in UTC. * `0 2 * * * ` : once a day at 2 past midnight in UTC. * `0 2 * * 0 ` : once a week every Sunday at 2 past midnight in UTC. * `0 2 8 * * ` : once a month on 8th day at 2 past midnight in UTC.
+      "timeZone": "A String", # Output only. The time zone of the times in `CrontabSpec.text`. Currently only UTC is supported.
+    },
+  },
+  "updateTime": "A String", # Output only. The timestamp at which the schedule was last updated. If the schedule has never been updated, this field contains the timestamp when the schedule was first created.
+}
+
+  backupScheduleId: string, Required. The Id to use for the backup schedule. The `backup_schedule_id` appended to `parent` forms the full backup schedule name of the form `projects//instances//databases//backupSchedules/`.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # BackupSchedule expresses the automated backup creation specification for a Spanner database. Next ID: 10
+  "encryptionConfig": { # Encryption configuration for the backup to create. # Optional. The encryption configuration that will be used to encrypt the backup. If this field is not specified, the backup will use the same encryption configuration as the database.
+    "encryptionType": "A String", # Required. The encryption type of the backup.
+    "kmsKeyName": "A String", # Optional. The Cloud KMS key that will be used to protect the backup. This field should be set only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`.
+    "kmsKeyNames": [ # Optional. Specifies the KMS configuration for the one or more keys used to protect the backup. Values are of the form `projects//locations//keyRings//cryptoKeys/`. The keys referenced by kms_key_names must fully cover all regions of the backup's instance configuration. Some examples: * For single region instance configs, specify a single regional location KMS key. * For multi-regional instance configs of type GOOGLE_MANAGED, either specify a multi-regional location KMS key or multiple regional location KMS keys that cover all regions in the instance config. * For an instance config of type USER_MANAGED, please specify only regional location KMS keys to cover each region in the instance config. Multi-regional location KMS keys are not supported for USER_MANAGED instance configs.
+      "A String",
+    ],
+  },
+  "fullBackupSpec": { # The specification for full backups. A full backup stores the entire contents of the database at a given version time. # The schedule creates only full backups.
+  },
+  "name": "A String", # Identifier. Output only for the CreateBackupSchedule operation. Required for the UpdateBackupSchedule operation. A globally unique identifier for the backup schedule which cannot be changed. Values are of the form `projects//instances//databases//backupSchedules/a-z*[a-z0-9]` The final segment of the name must be between 2 and 60 characters in length.
+  "retentionDuration": "A String", # Optional. The retention duration of a backup that must be at least 6 hours and at most 366 days. The backup is eligible to be automatically deleted once the retention period has elapsed.
+  "spec": { # Defines specifications of the backup schedule. # Optional. The schedule specification based on which the backup creations are triggered.
+    "cronSpec": { # CrontabSpec can be used to specify the version time and frequency at which the backup should be created. # Cron style schedule specification.
+      "creationWindow": "A String", # Output only. Schedule backups will contain an externally consistent copy of the database at the version time specified in `schedule_spec.cron_spec`. However, Spanner may not initiate the creation of the scheduled backups at that version time. Spanner will initiate the creation of scheduled backups within the time window bounded by the version_time specified in `schedule_spec.cron_spec` and version_time + `creation_window`.
+      "text": "A String", # Required. Textual representation of the crontab. User can customize the backup frequency and the backup version time using the cron expression. The version time must be in UTC timzeone. The backup will contain an externally consistent copy of the database at the version time. Allowed frequencies are 12 hour, 1 day, 1 week and 1 month. Examples of valid cron specifications: * `0 2/12 * * * ` : every 12 hours at (2, 14) hours past midnight in UTC. * `0 2,14 * * * ` : every 12 hours at (2,14) hours past midnight in UTC. * `0 2 * * * ` : once a day at 2 past midnight in UTC. * `0 2 * * 0 ` : once a week every Sunday at 2 past midnight in UTC. * `0 2 8 * * ` : once a month on 8th day at 2 past midnight in UTC.
+      "timeZone": "A String", # Output only. The time zone of the times in `CrontabSpec.text`. Currently only UTC is supported.
+    },
+  },
+  "updateTime": "A String", # Output only. The timestamp at which the schedule was last updated. If the schedule has never been updated, this field contains the timestamp when the schedule was first created.
+}
+
+ +
+ delete(name, x__xgafv=None) +
Deletes a backup schedule.
+
+Args:
+  name: string, Required. The name of the schedule to delete. Values are of the form `projects//instances//databases//backupSchedules/`. (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 backup schedule for the input schedule name.
+
+Args:
+  name: string, Required. The name of the schedule to retrieve. Values are of the form `projects//instances//databases//backupSchedules/`. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # BackupSchedule expresses the automated backup creation specification for a Spanner database. Next ID: 10
+  "encryptionConfig": { # Encryption configuration for the backup to create. # Optional. The encryption configuration that will be used to encrypt the backup. If this field is not specified, the backup will use the same encryption configuration as the database.
+    "encryptionType": "A String", # Required. The encryption type of the backup.
+    "kmsKeyName": "A String", # Optional. The Cloud KMS key that will be used to protect the backup. This field should be set only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`.
+    "kmsKeyNames": [ # Optional. Specifies the KMS configuration for the one or more keys used to protect the backup. Values are of the form `projects//locations//keyRings//cryptoKeys/`. The keys referenced by kms_key_names must fully cover all regions of the backup's instance configuration. Some examples: * For single region instance configs, specify a single regional location KMS key. * For multi-regional instance configs of type GOOGLE_MANAGED, either specify a multi-regional location KMS key or multiple regional location KMS keys that cover all regions in the instance config. * For an instance config of type USER_MANAGED, please specify only regional location KMS keys to cover each region in the instance config. Multi-regional location KMS keys are not supported for USER_MANAGED instance configs.
+      "A String",
+    ],
+  },
+  "fullBackupSpec": { # The specification for full backups. A full backup stores the entire contents of the database at a given version time. # The schedule creates only full backups.
+  },
+  "name": "A String", # Identifier. Output only for the CreateBackupSchedule operation. Required for the UpdateBackupSchedule operation. A globally unique identifier for the backup schedule which cannot be changed. Values are of the form `projects//instances//databases//backupSchedules/a-z*[a-z0-9]` The final segment of the name must be between 2 and 60 characters in length.
+  "retentionDuration": "A String", # Optional. The retention duration of a backup that must be at least 6 hours and at most 366 days. The backup is eligible to be automatically deleted once the retention period has elapsed.
+  "spec": { # Defines specifications of the backup schedule. # Optional. The schedule specification based on which the backup creations are triggered.
+    "cronSpec": { # CrontabSpec can be used to specify the version time and frequency at which the backup should be created. # Cron style schedule specification.
+      "creationWindow": "A String", # Output only. Schedule backups will contain an externally consistent copy of the database at the version time specified in `schedule_spec.cron_spec`. However, Spanner may not initiate the creation of the scheduled backups at that version time. Spanner will initiate the creation of scheduled backups within the time window bounded by the version_time specified in `schedule_spec.cron_spec` and version_time + `creation_window`.
+      "text": "A String", # Required. Textual representation of the crontab. User can customize the backup frequency and the backup version time using the cron expression. The version time must be in UTC timzeone. The backup will contain an externally consistent copy of the database at the version time. Allowed frequencies are 12 hour, 1 day, 1 week and 1 month. Examples of valid cron specifications: * `0 2/12 * * * ` : every 12 hours at (2, 14) hours past midnight in UTC. * `0 2,14 * * * ` : every 12 hours at (2,14) hours past midnight in UTC. * `0 2 * * * ` : once a day at 2 past midnight in UTC. * `0 2 * * 0 ` : once a week every Sunday at 2 past midnight in UTC. * `0 2 8 * * ` : once a month on 8th day at 2 past midnight in UTC.
+      "timeZone": "A String", # Output only. The time zone of the times in `CrontabSpec.text`. Currently only UTC is supported.
+    },
+  },
+  "updateTime": "A String", # Output only. The timestamp at which the schedule was last updated. If the schedule has never been updated, this field contains the timestamp when the schedule was first created.
+}
+
+
getIamPolicy(resource, body=None, x__xgafv=None)
Gets the access control policy for a database or backup resource. Returns an empty policy if a database or backup exists but does not have a policy set. Authorization requires `spanner.databases.getIamPolicy` permission on resource. For backups, authorization requires `spanner.backups.getIamPolicy` permission on resource.
@@ -135,6 +271,127 @@ 

Method Details

}
+
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Lists all the backup schedules for the database.
+
+Args:
+  parent: string, Required. Database is the parent resource whose backup schedules should be listed. Values are of the form projects//instances//databases/ (required)
+  pageSize: integer, Optional. Number of backup schedules to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
+  pageToken: string, Optional. If non-empty, `page_token` should contain a next_page_token from a previous ListBackupSchedulesResponse to the same `parent`.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response for ListBackupSchedules.
+  "backupSchedules": [ # The list of backup schedules for a database.
+    { # BackupSchedule expresses the automated backup creation specification for a Spanner database. Next ID: 10
+      "encryptionConfig": { # Encryption configuration for the backup to create. # Optional. The encryption configuration that will be used to encrypt the backup. If this field is not specified, the backup will use the same encryption configuration as the database.
+        "encryptionType": "A String", # Required. The encryption type of the backup.
+        "kmsKeyName": "A String", # Optional. The Cloud KMS key that will be used to protect the backup. This field should be set only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`.
+        "kmsKeyNames": [ # Optional. Specifies the KMS configuration for the one or more keys used to protect the backup. Values are of the form `projects//locations//keyRings//cryptoKeys/`. The keys referenced by kms_key_names must fully cover all regions of the backup's instance configuration. Some examples: * For single region instance configs, specify a single regional location KMS key. * For multi-regional instance configs of type GOOGLE_MANAGED, either specify a multi-regional location KMS key or multiple regional location KMS keys that cover all regions in the instance config. * For an instance config of type USER_MANAGED, please specify only regional location KMS keys to cover each region in the instance config. Multi-regional location KMS keys are not supported for USER_MANAGED instance configs.
+          "A String",
+        ],
+      },
+      "fullBackupSpec": { # The specification for full backups. A full backup stores the entire contents of the database at a given version time. # The schedule creates only full backups.
+      },
+      "name": "A String", # Identifier. Output only for the CreateBackupSchedule operation. Required for the UpdateBackupSchedule operation. A globally unique identifier for the backup schedule which cannot be changed. Values are of the form `projects//instances//databases//backupSchedules/a-z*[a-z0-9]` The final segment of the name must be between 2 and 60 characters in length.
+      "retentionDuration": "A String", # Optional. The retention duration of a backup that must be at least 6 hours and at most 366 days. The backup is eligible to be automatically deleted once the retention period has elapsed.
+      "spec": { # Defines specifications of the backup schedule. # Optional. The schedule specification based on which the backup creations are triggered.
+        "cronSpec": { # CrontabSpec can be used to specify the version time and frequency at which the backup should be created. # Cron style schedule specification.
+          "creationWindow": "A String", # Output only. Schedule backups will contain an externally consistent copy of the database at the version time specified in `schedule_spec.cron_spec`. However, Spanner may not initiate the creation of the scheduled backups at that version time. Spanner will initiate the creation of scheduled backups within the time window bounded by the version_time specified in `schedule_spec.cron_spec` and version_time + `creation_window`.
+          "text": "A String", # Required. Textual representation of the crontab. User can customize the backup frequency and the backup version time using the cron expression. The version time must be in UTC timzeone. The backup will contain an externally consistent copy of the database at the version time. Allowed frequencies are 12 hour, 1 day, 1 week and 1 month. Examples of valid cron specifications: * `0 2/12 * * * ` : every 12 hours at (2, 14) hours past midnight in UTC. * `0 2,14 * * * ` : every 12 hours at (2,14) hours past midnight in UTC. * `0 2 * * * ` : once a day at 2 past midnight in UTC. * `0 2 * * 0 ` : once a week every Sunday at 2 past midnight in UTC. * `0 2 8 * * ` : once a month on 8th day at 2 past midnight in UTC.
+          "timeZone": "A String", # Output only. The time zone of the times in `CrontabSpec.text`. Currently only UTC is supported.
+        },
+      },
+      "updateTime": "A String", # Output only. The timestamp at which the schedule was last updated. If the schedule has never been updated, this field contains the timestamp when the schedule was first created.
+    },
+  ],
+  "nextPageToken": "A String", # `next_page_token` can be sent in a subsequent ListBackupSchedules call to fetch more of the schedules.
+}
+
+ +
+ 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, body=None, updateMask=None, x__xgafv=None) +
Updates a backup schedule.
+
+Args:
+  name: string, Identifier. Output only for the CreateBackupSchedule operation. Required for the UpdateBackupSchedule operation. A globally unique identifier for the backup schedule which cannot be changed. Values are of the form `projects//instances//databases//backupSchedules/a-z*[a-z0-9]` The final segment of the name must be between 2 and 60 characters in length. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # BackupSchedule expresses the automated backup creation specification for a Spanner database. Next ID: 10
+  "encryptionConfig": { # Encryption configuration for the backup to create. # Optional. The encryption configuration that will be used to encrypt the backup. If this field is not specified, the backup will use the same encryption configuration as the database.
+    "encryptionType": "A String", # Required. The encryption type of the backup.
+    "kmsKeyName": "A String", # Optional. The Cloud KMS key that will be used to protect the backup. This field should be set only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`.
+    "kmsKeyNames": [ # Optional. Specifies the KMS configuration for the one or more keys used to protect the backup. Values are of the form `projects//locations//keyRings//cryptoKeys/`. The keys referenced by kms_key_names must fully cover all regions of the backup's instance configuration. Some examples: * For single region instance configs, specify a single regional location KMS key. * For multi-regional instance configs of type GOOGLE_MANAGED, either specify a multi-regional location KMS key or multiple regional location KMS keys that cover all regions in the instance config. * For an instance config of type USER_MANAGED, please specify only regional location KMS keys to cover each region in the instance config. Multi-regional location KMS keys are not supported for USER_MANAGED instance configs.
+      "A String",
+    ],
+  },
+  "fullBackupSpec": { # The specification for full backups. A full backup stores the entire contents of the database at a given version time. # The schedule creates only full backups.
+  },
+  "name": "A String", # Identifier. Output only for the CreateBackupSchedule operation. Required for the UpdateBackupSchedule operation. A globally unique identifier for the backup schedule which cannot be changed. Values are of the form `projects//instances//databases//backupSchedules/a-z*[a-z0-9]` The final segment of the name must be between 2 and 60 characters in length.
+  "retentionDuration": "A String", # Optional. The retention duration of a backup that must be at least 6 hours and at most 366 days. The backup is eligible to be automatically deleted once the retention period has elapsed.
+  "spec": { # Defines specifications of the backup schedule. # Optional. The schedule specification based on which the backup creations are triggered.
+    "cronSpec": { # CrontabSpec can be used to specify the version time and frequency at which the backup should be created. # Cron style schedule specification.
+      "creationWindow": "A String", # Output only. Schedule backups will contain an externally consistent copy of the database at the version time specified in `schedule_spec.cron_spec`. However, Spanner may not initiate the creation of the scheduled backups at that version time. Spanner will initiate the creation of scheduled backups within the time window bounded by the version_time specified in `schedule_spec.cron_spec` and version_time + `creation_window`.
+      "text": "A String", # Required. Textual representation of the crontab. User can customize the backup frequency and the backup version time using the cron expression. The version time must be in UTC timzeone. The backup will contain an externally consistent copy of the database at the version time. Allowed frequencies are 12 hour, 1 day, 1 week and 1 month. Examples of valid cron specifications: * `0 2/12 * * * ` : every 12 hours at (2, 14) hours past midnight in UTC. * `0 2,14 * * * ` : every 12 hours at (2,14) hours past midnight in UTC. * `0 2 * * * ` : once a day at 2 past midnight in UTC. * `0 2 * * 0 ` : once a week every Sunday at 2 past midnight in UTC. * `0 2 8 * * ` : once a month on 8th day at 2 past midnight in UTC.
+      "timeZone": "A String", # Output only. The time zone of the times in `CrontabSpec.text`. Currently only UTC is supported.
+    },
+  },
+  "updateTime": "A String", # Output only. The timestamp at which the schedule was last updated. If the schedule has never been updated, this field contains the timestamp when the schedule was first created.
+}
+
+  updateMask: string, Required. A mask specifying which fields in the BackupSchedule resource should be updated. This mask is relative to the BackupSchedule resource, not to the request message. The field mask must always be specified; this prevents any future fields from being erased accidentally.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # BackupSchedule expresses the automated backup creation specification for a Spanner database. Next ID: 10
+  "encryptionConfig": { # Encryption configuration for the backup to create. # Optional. The encryption configuration that will be used to encrypt the backup. If this field is not specified, the backup will use the same encryption configuration as the database.
+    "encryptionType": "A String", # Required. The encryption type of the backup.
+    "kmsKeyName": "A String", # Optional. The Cloud KMS key that will be used to protect the backup. This field should be set only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`.
+    "kmsKeyNames": [ # Optional. Specifies the KMS configuration for the one or more keys used to protect the backup. Values are of the form `projects//locations//keyRings//cryptoKeys/`. The keys referenced by kms_key_names must fully cover all regions of the backup's instance configuration. Some examples: * For single region instance configs, specify a single regional location KMS key. * For multi-regional instance configs of type GOOGLE_MANAGED, either specify a multi-regional location KMS key or multiple regional location KMS keys that cover all regions in the instance config. * For an instance config of type USER_MANAGED, please specify only regional location KMS keys to cover each region in the instance config. Multi-regional location KMS keys are not supported for USER_MANAGED instance configs.
+      "A String",
+    ],
+  },
+  "fullBackupSpec": { # The specification for full backups. A full backup stores the entire contents of the database at a given version time. # The schedule creates only full backups.
+  },
+  "name": "A String", # Identifier. Output only for the CreateBackupSchedule operation. Required for the UpdateBackupSchedule operation. A globally unique identifier for the backup schedule which cannot be changed. Values are of the form `projects//instances//databases//backupSchedules/a-z*[a-z0-9]` The final segment of the name must be between 2 and 60 characters in length.
+  "retentionDuration": "A String", # Optional. The retention duration of a backup that must be at least 6 hours and at most 366 days. The backup is eligible to be automatically deleted once the retention period has elapsed.
+  "spec": { # Defines specifications of the backup schedule. # Optional. The schedule specification based on which the backup creations are triggered.
+    "cronSpec": { # CrontabSpec can be used to specify the version time and frequency at which the backup should be created. # Cron style schedule specification.
+      "creationWindow": "A String", # Output only. Schedule backups will contain an externally consistent copy of the database at the version time specified in `schedule_spec.cron_spec`. However, Spanner may not initiate the creation of the scheduled backups at that version time. Spanner will initiate the creation of scheduled backups within the time window bounded by the version_time specified in `schedule_spec.cron_spec` and version_time + `creation_window`.
+      "text": "A String", # Required. Textual representation of the crontab. User can customize the backup frequency and the backup version time using the cron expression. The version time must be in UTC timzeone. The backup will contain an externally consistent copy of the database at the version time. Allowed frequencies are 12 hour, 1 day, 1 week and 1 month. Examples of valid cron specifications: * `0 2/12 * * * ` : every 12 hours at (2, 14) hours past midnight in UTC. * `0 2,14 * * * ` : every 12 hours at (2,14) hours past midnight in UTC. * `0 2 * * * ` : once a day at 2 past midnight in UTC. * `0 2 * * 0 ` : once a week every Sunday at 2 past midnight in UTC. * `0 2 8 * * ` : once a month on 8th day at 2 past midnight in UTC.
+      "timeZone": "A String", # Output only. The time zone of the times in `CrontabSpec.text`. Currently only UTC is supported.
+    },
+  },
+  "updateTime": "A String", # Output only. The timestamp at which the schedule was last updated. If the schedule has never been updated, this field contains the timestamp when the schedule was first created.
+}
+
+
setIamPolicy(resource, body=None, x__xgafv=None)
Sets the access control policy on a database or backup resource. Replaces any existing policy. Authorization requires `spanner.databases.setIamPolicy` permission on resource. For backups, authorization requires `spanner.backups.setIamPolicy` permission on resource.
diff --git a/docs/dyn/sqladmin_v1.connect.html b/docs/dyn/sqladmin_v1.connect.html
index 8389132b0d2..8f31c2a469d 100644
--- a/docs/dyn/sqladmin_v1.connect.html
+++ b/docs/dyn/sqladmin_v1.connect.html
@@ -170,6 +170,7 @@ 

Method Details

"selfLink": "A String", # The URI of this resource. "sha1Fingerprint": "A String", # Sha1 Fingerprint. }, + "serverCaMode": "A String", # Specify what type of CA is used for the server certificate. }
diff --git a/docs/dyn/sqladmin_v1.instances.html b/docs/dyn/sqladmin_v1.instances.html index 87a30d36af2..c1d5691082f 100644 --- a/docs/dyn/sqladmin_v1.instances.html +++ b/docs/dyn/sqladmin_v1.instances.html @@ -79,7 +79,7 @@

Instance Methods

Acquire a lease for the setup of SQL Server Reporting Services (SSRS).

addServerCa(project, instance, x__xgafv=None)

-

Adds a new trusted Certificate Authority (CA) version for the specified instance. Required to prepare for a certificate rotation. If a CA version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one CA version waiting to be rotated in.

+

Adds a new trusted Certificate Authority (CA) version for the specified instance. Required to prepare for a certificate rotation. If a CA version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one CA version waiting to be rotated in. For instances that have enabled Certificate Authority Service (CAS) based server CA, please use AddServerCertificate to add a new server certificate.

clone(project, instance, body=None, x__xgafv=None)

Creates a Cloud SQL instance as a clone of the source instance. Using this operation might cause your instance to restart.

@@ -142,7 +142,7 @@

Instance Methods

Restores a backup of a Cloud SQL instance. Using this operation might cause your instance to restart.

rotateServerCa(project, instance, body=None, x__xgafv=None)

-

Rotates the server certificate to one signed by the Certificate Authority (CA) version previously added with the addServerCA method.

+

Rotates the server certificate to one signed by the Certificate Authority (CA) version previously added with the addServerCA method. For instances that have enabled Certificate Authority Service (CAS) based server CA, please use RotateServerCertificate to rotate the server certificate.

startReplica(project, instance, x__xgafv=None)

Starts the replication in the read replica instance.

@@ -193,7 +193,7 @@

Method Details

addServerCa(project, instance, x__xgafv=None) -
Adds a new trusted Certificate Authority (CA) version for the specified instance. Required to prepare for a certificate rotation. If a CA version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one CA version waiting to be rotated in.
+  
Adds a new trusted Certificate Authority (CA) version for the specified instance. Required to prepare for a certificate rotation. If a CA version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one CA version waiting to be rotated in. For instances that have enabled Certificate Authority Service (CAS) based server CA, please use AddServerCertificate to add a new server certificate.
 
 Args:
   project: string, Project ID of the project that contains the instance. (required)
@@ -1443,6 +1443,7 @@ 

Method Details

"pscEnabled": True or False, # Whether PSC connectivity is enabled for this instance. }, "requireSsl": True or False, # Use `ssl_mode` instead. Whether SSL/TLS connections over IP are enforced. If set to false, then allow both non-SSL/non-TLS and SSL/TLS connections. For SSL/TLS connections, the client certificate won't be verified. If set to true, then only allow connections encrypted with SSL/TLS and with valid client certificates. If you want to enforce SSL/TLS without enforcing the requirement for valid client certificates, then use the `ssl_mode` flag instead of the `require_ssl` flag. + "serverCaMode": "A String", # Specify what type of CA is used for the server certificate. "sslMode": "A String", # Specify how SSL/TLS is enforced in database connections. If you must use the `require_ssl` flag for backward compatibility, then only the following value pairs are valid: For PostgreSQL and MySQL: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false` * `ssl_mode=TRUSTED_CLIENT_CERTIFICATE_REQUIRED` and `require_ssl=true` For SQL Server: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=true` The value of `ssl_mode` has priority over the value of `require_ssl`. For example, for the pair `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false`, `ssl_mode=ENCRYPTED_ONLY` means accept only SSL connections, while `require_ssl=false` means accept both non-SSL and SSL connections. In this case, MySQL and PostgreSQL databases respect `ssl_mode` and accepts only SSL connections. }, "kind": "A String", # This is always `sql#settings`. @@ -1489,6 +1490,7 @@

Method Details

"suspensionReason": [ # If the instance state is SUSPENDED, the reason for the suspension. "A String", ], + "switchTransactionLogsToCloudStorageEnabled": True or False, # Input only. Whether Cloud SQL is enabled to switch storing point-in-time recovery log files from a data disk to Cloud Storage. "upgradableDatabaseVersions": [ # Output only. All database versions that are available for upgrade. { # An available database version. It can be a major or a minor version. "displayName": "A String", # The database version's display name. @@ -1884,6 +1886,7 @@

Method Details

"pscEnabled": True or False, # Whether PSC connectivity is enabled for this instance. }, "requireSsl": True or False, # Use `ssl_mode` instead. Whether SSL/TLS connections over IP are enforced. If set to false, then allow both non-SSL/non-TLS and SSL/TLS connections. For SSL/TLS connections, the client certificate won't be verified. If set to true, then only allow connections encrypted with SSL/TLS and with valid client certificates. If you want to enforce SSL/TLS without enforcing the requirement for valid client certificates, then use the `ssl_mode` flag instead of the `require_ssl` flag. + "serverCaMode": "A String", # Specify what type of CA is used for the server certificate. "sslMode": "A String", # Specify how SSL/TLS is enforced in database connections. If you must use the `require_ssl` flag for backward compatibility, then only the following value pairs are valid: For PostgreSQL and MySQL: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false` * `ssl_mode=TRUSTED_CLIENT_CERTIFICATE_REQUIRED` and `require_ssl=true` For SQL Server: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=true` The value of `ssl_mode` has priority over the value of `require_ssl`. For example, for the pair `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false`, `ssl_mode=ENCRYPTED_ONLY` means accept only SSL connections, while `require_ssl=false` means accept both non-SSL and SSL connections. In this case, MySQL and PostgreSQL databases respect `ssl_mode` and accepts only SSL connections. }, "kind": "A String", # This is always `sql#settings`. @@ -1930,6 +1933,7 @@

Method Details

"suspensionReason": [ # If the instance state is SUSPENDED, the reason for the suspension. "A String", ], + "switchTransactionLogsToCloudStorageEnabled": True or False, # Input only. Whether Cloud SQL is enabled to switch storing point-in-time recovery log files from a data disk to Cloud Storage. "upgradableDatabaseVersions": [ # Output only. All database versions that are available for upgrade. { # An available database version. It can be a major or a minor version. "displayName": "A String", # The database version's display name. @@ -2283,6 +2287,7 @@

Method Details

"pscEnabled": True or False, # Whether PSC connectivity is enabled for this instance. }, "requireSsl": True or False, # Use `ssl_mode` instead. Whether SSL/TLS connections over IP are enforced. If set to false, then allow both non-SSL/non-TLS and SSL/TLS connections. For SSL/TLS connections, the client certificate won't be verified. If set to true, then only allow connections encrypted with SSL/TLS and with valid client certificates. If you want to enforce SSL/TLS without enforcing the requirement for valid client certificates, then use the `ssl_mode` flag instead of the `require_ssl` flag. + "serverCaMode": "A String", # Specify what type of CA is used for the server certificate. "sslMode": "A String", # Specify how SSL/TLS is enforced in database connections. If you must use the `require_ssl` flag for backward compatibility, then only the following value pairs are valid: For PostgreSQL and MySQL: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false` * `ssl_mode=TRUSTED_CLIENT_CERTIFICATE_REQUIRED` and `require_ssl=true` For SQL Server: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=true` The value of `ssl_mode` has priority over the value of `require_ssl`. For example, for the pair `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false`, `ssl_mode=ENCRYPTED_ONLY` means accept only SSL connections, while `require_ssl=false` means accept both non-SSL and SSL connections. In this case, MySQL and PostgreSQL databases respect `ssl_mode` and accepts only SSL connections. }, "kind": "A String", # This is always `sql#settings`. @@ -2329,6 +2334,7 @@

Method Details

"suspensionReason": [ # If the instance state is SUSPENDED, the reason for the suspension. "A String", ], + "switchTransactionLogsToCloudStorageEnabled": True or False, # Input only. Whether Cloud SQL is enabled to switch storing point-in-time recovery log files from a data disk to Cloud Storage. "upgradableDatabaseVersions": [ # Output only. All database versions that are available for upgrade. { # An available database version. It can be a major or a minor version. "displayName": "A String", # The database version's display name. @@ -2608,6 +2614,7 @@

Method Details

"pscEnabled": True or False, # Whether PSC connectivity is enabled for this instance. }, "requireSsl": True or False, # Use `ssl_mode` instead. Whether SSL/TLS connections over IP are enforced. If set to false, then allow both non-SSL/non-TLS and SSL/TLS connections. For SSL/TLS connections, the client certificate won't be verified. If set to true, then only allow connections encrypted with SSL/TLS and with valid client certificates. If you want to enforce SSL/TLS without enforcing the requirement for valid client certificates, then use the `ssl_mode` flag instead of the `require_ssl` flag. + "serverCaMode": "A String", # Specify what type of CA is used for the server certificate. "sslMode": "A String", # Specify how SSL/TLS is enforced in database connections. If you must use the `require_ssl` flag for backward compatibility, then only the following value pairs are valid: For PostgreSQL and MySQL: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false` * `ssl_mode=TRUSTED_CLIENT_CERTIFICATE_REQUIRED` and `require_ssl=true` For SQL Server: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=true` The value of `ssl_mode` has priority over the value of `require_ssl`. For example, for the pair `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false`, `ssl_mode=ENCRYPTED_ONLY` means accept only SSL connections, while `require_ssl=false` means accept both non-SSL and SSL connections. In this case, MySQL and PostgreSQL databases respect `ssl_mode` and accepts only SSL connections. }, "kind": "A String", # This is always `sql#settings`. @@ -2654,6 +2661,7 @@

Method Details

"suspensionReason": [ # If the instance state is SUSPENDED, the reason for the suspension. "A String", ], + "switchTransactionLogsToCloudStorageEnabled": True or False, # Input only. Whether Cloud SQL is enabled to switch storing point-in-time recovery log files from a data disk to Cloud Storage. "upgradableDatabaseVersions": [ # Output only. All database versions that are available for upgrade. { # An available database version. It can be a major or a minor version. "displayName": "A String", # The database version's display name. @@ -3494,7 +3502,7 @@

Method Details

rotateServerCa(project, instance, body=None, x__xgafv=None) -
Rotates the server certificate to one signed by the Certificate Authority (CA) version previously added with the addServerCA method.
+  
Rotates the server certificate to one signed by the Certificate Authority (CA) version previously added with the addServerCA method. For instances that have enabled Certificate Authority Service (CAS) based server CA, please use RotateServerCertificate to rotate the server certificate.
 
 Args:
   project: string, Project ID of the project that contains the instance. (required)
@@ -4382,6 +4390,7 @@ 

Method Details

"pscEnabled": True or False, # Whether PSC connectivity is enabled for this instance. }, "requireSsl": True or False, # Use `ssl_mode` instead. Whether SSL/TLS connections over IP are enforced. If set to false, then allow both non-SSL/non-TLS and SSL/TLS connections. For SSL/TLS connections, the client certificate won't be verified. If set to true, then only allow connections encrypted with SSL/TLS and with valid client certificates. If you want to enforce SSL/TLS without enforcing the requirement for valid client certificates, then use the `ssl_mode` flag instead of the `require_ssl` flag. + "serverCaMode": "A String", # Specify what type of CA is used for the server certificate. "sslMode": "A String", # Specify how SSL/TLS is enforced in database connections. If you must use the `require_ssl` flag for backward compatibility, then only the following value pairs are valid: For PostgreSQL and MySQL: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false` * `ssl_mode=TRUSTED_CLIENT_CERTIFICATE_REQUIRED` and `require_ssl=true` For SQL Server: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=true` The value of `ssl_mode` has priority over the value of `require_ssl`. For example, for the pair `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false`, `ssl_mode=ENCRYPTED_ONLY` means accept only SSL connections, while `require_ssl=false` means accept both non-SSL and SSL connections. In this case, MySQL and PostgreSQL databases respect `ssl_mode` and accepts only SSL connections. }, "kind": "A String", # This is always `sql#settings`. @@ -4428,6 +4437,7 @@

Method Details

"suspensionReason": [ # If the instance state is SUSPENDED, the reason for the suspension. "A String", ], + "switchTransactionLogsToCloudStorageEnabled": True or False, # Input only. Whether Cloud SQL is enabled to switch storing point-in-time recovery log files from a data disk to Cloud Storage. "upgradableDatabaseVersions": [ # Output only. All database versions that are available for upgrade. { # An available database version. It can be a major or a minor version. "displayName": "A String", # The database version's display name. diff --git a/docs/dyn/sqladmin_v1beta4.connect.html b/docs/dyn/sqladmin_v1beta4.connect.html index 02ff6136d38..c56b9f5ea14 100644 --- a/docs/dyn/sqladmin_v1beta4.connect.html +++ b/docs/dyn/sqladmin_v1beta4.connect.html @@ -170,6 +170,7 @@

Method Details

"selfLink": "A String", # The URI of this resource. "sha1Fingerprint": "A String", # Sha1 Fingerprint. }, + "serverCaMode": "A String", # Specify what type of CA is used for the server certificate. }
diff --git a/docs/dyn/sqladmin_v1beta4.instances.html b/docs/dyn/sqladmin_v1beta4.instances.html index 7ade086e208..0abf5d5b90c 100644 --- a/docs/dyn/sqladmin_v1beta4.instances.html +++ b/docs/dyn/sqladmin_v1beta4.instances.html @@ -79,7 +79,7 @@

Instance Methods

Acquire a lease for the setup of SQL Server Reporting Services (SSRS).

addServerCa(project, instance, x__xgafv=None)

-

Add a new trusted Certificate Authority (CA) version for the specified instance. Required to prepare for a certificate rotation. If a CA version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one CA version waiting to be rotated in.

+

Add a new trusted Certificate Authority (CA) version for the specified instance. Required to prepare for a certificate rotation. If a CA version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one CA version waiting to be rotated in. For instances that have enabled Certificate Authority Service (CAS) based server CA, please use AddServerCertificate to add a new server certificate.

clone(project, instance, body=None, x__xgafv=None)

Creates a Cloud SQL instance as a clone of the source instance. Using this operation might cause your instance to restart.

@@ -142,7 +142,7 @@

Instance Methods

Restores a backup of a Cloud SQL instance. Using this operation might cause your instance to restart.

rotateServerCa(project, instance, body=None, x__xgafv=None)

-

Rotates the server certificate to one signed by the Certificate Authority (CA) version previously added with the addServerCA method.

+

Rotates the server certificate to one signed by the Certificate Authority (CA) version previously added with the addServerCA method. For instances that have enabled Certificate Authority Service (CAS) based server CA, please use RotateServerCertificate to rotate the server certificate.

startReplica(project, instance, x__xgafv=None)

Starts the replication in the read replica instance.

@@ -193,7 +193,7 @@

Method Details

addServerCa(project, instance, x__xgafv=None) -
Add a new trusted Certificate Authority (CA) version for the specified instance. Required to prepare for a certificate rotation. If a CA version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one CA version waiting to be rotated in.
+  
Add a new trusted Certificate Authority (CA) version for the specified instance. Required to prepare for a certificate rotation. If a CA version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one CA version waiting to be rotated in. For instances that have enabled Certificate Authority Service (CAS) based server CA, please use AddServerCertificate to add a new server certificate.
 
 Args:
   project: string, Project ID of the project that contains the instance. (required)
@@ -1443,6 +1443,7 @@ 

Method Details

"pscEnabled": True or False, # Whether PSC connectivity is enabled for this instance. }, "requireSsl": True or False, # Use `ssl_mode` instead. Whether SSL/TLS connections over IP are enforced. If set to false, then allow both non-SSL/non-TLS and SSL/TLS connections. For SSL/TLS connections, the client certificate won't be verified. If set to true, then only allow connections encrypted with SSL/TLS and with valid client certificates. If you want to enforce SSL/TLS without enforcing the requirement for valid client certificates, then use the `ssl_mode` flag instead of the legacy `require_ssl` flag. + "serverCaMode": "A String", # Specify what type of CA is used for the server certificate. "sslMode": "A String", # Specify how SSL/TLS is enforced in database connections. If you must use the `require_ssl` flag for backward compatibility, then only the following value pairs are valid: For PostgreSQL and MySQL: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false` * `ssl_mode=TRUSTED_CLIENT_CERTIFICATE_REQUIRED` and `require_ssl=true` For SQL Server: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=true` The value of `ssl_mode` has priority over the value of `require_ssl`. For example, for the pair `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false`, `ssl_mode=ENCRYPTED_ONLY` means accept only SSL connections, while `require_ssl=false` means accept both non-SSL and SSL connections. In this case, MySQL and PostgreSQL databases respect `ssl_mode` and accepts only SSL connections. }, "kind": "A String", # This is always `sql#settings`. @@ -1489,6 +1490,7 @@

Method Details

"suspensionReason": [ # If the instance state is SUSPENDED, the reason for the suspension. "A String", ], + "switchTransactionLogsToCloudStorageEnabled": True or False, # Input only. Whether Cloud SQL is enabled to switch storing point-in-time recovery log files from a data disk to Cloud Storage. "upgradableDatabaseVersions": [ # Output only. All database versions that are available for upgrade. { # An available database version. It can be a major or a minor version. "displayName": "A String", # The database version's display name. @@ -1884,6 +1886,7 @@

Method Details

"pscEnabled": True or False, # Whether PSC connectivity is enabled for this instance. }, "requireSsl": True or False, # Use `ssl_mode` instead. Whether SSL/TLS connections over IP are enforced. If set to false, then allow both non-SSL/non-TLS and SSL/TLS connections. For SSL/TLS connections, the client certificate won't be verified. If set to true, then only allow connections encrypted with SSL/TLS and with valid client certificates. If you want to enforce SSL/TLS without enforcing the requirement for valid client certificates, then use the `ssl_mode` flag instead of the legacy `require_ssl` flag. + "serverCaMode": "A String", # Specify what type of CA is used for the server certificate. "sslMode": "A String", # Specify how SSL/TLS is enforced in database connections. If you must use the `require_ssl` flag for backward compatibility, then only the following value pairs are valid: For PostgreSQL and MySQL: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false` * `ssl_mode=TRUSTED_CLIENT_CERTIFICATE_REQUIRED` and `require_ssl=true` For SQL Server: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=true` The value of `ssl_mode` has priority over the value of `require_ssl`. For example, for the pair `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false`, `ssl_mode=ENCRYPTED_ONLY` means accept only SSL connections, while `require_ssl=false` means accept both non-SSL and SSL connections. In this case, MySQL and PostgreSQL databases respect `ssl_mode` and accepts only SSL connections. }, "kind": "A String", # This is always `sql#settings`. @@ -1930,6 +1933,7 @@

Method Details

"suspensionReason": [ # If the instance state is SUSPENDED, the reason for the suspension. "A String", ], + "switchTransactionLogsToCloudStorageEnabled": True or False, # Input only. Whether Cloud SQL is enabled to switch storing point-in-time recovery log files from a data disk to Cloud Storage. "upgradableDatabaseVersions": [ # Output only. All database versions that are available for upgrade. { # An available database version. It can be a major or a minor version. "displayName": "A String", # The database version's display name. @@ -2283,6 +2287,7 @@

Method Details

"pscEnabled": True or False, # Whether PSC connectivity is enabled for this instance. }, "requireSsl": True or False, # Use `ssl_mode` instead. Whether SSL/TLS connections over IP are enforced. If set to false, then allow both non-SSL/non-TLS and SSL/TLS connections. For SSL/TLS connections, the client certificate won't be verified. If set to true, then only allow connections encrypted with SSL/TLS and with valid client certificates. If you want to enforce SSL/TLS without enforcing the requirement for valid client certificates, then use the `ssl_mode` flag instead of the legacy `require_ssl` flag. + "serverCaMode": "A String", # Specify what type of CA is used for the server certificate. "sslMode": "A String", # Specify how SSL/TLS is enforced in database connections. If you must use the `require_ssl` flag for backward compatibility, then only the following value pairs are valid: For PostgreSQL and MySQL: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false` * `ssl_mode=TRUSTED_CLIENT_CERTIFICATE_REQUIRED` and `require_ssl=true` For SQL Server: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=true` The value of `ssl_mode` has priority over the value of `require_ssl`. For example, for the pair `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false`, `ssl_mode=ENCRYPTED_ONLY` means accept only SSL connections, while `require_ssl=false` means accept both non-SSL and SSL connections. In this case, MySQL and PostgreSQL databases respect `ssl_mode` and accepts only SSL connections. }, "kind": "A String", # This is always `sql#settings`. @@ -2329,6 +2334,7 @@

Method Details

"suspensionReason": [ # If the instance state is SUSPENDED, the reason for the suspension. "A String", ], + "switchTransactionLogsToCloudStorageEnabled": True or False, # Input only. Whether Cloud SQL is enabled to switch storing point-in-time recovery log files from a data disk to Cloud Storage. "upgradableDatabaseVersions": [ # Output only. All database versions that are available for upgrade. { # An available database version. It can be a major or a minor version. "displayName": "A String", # The database version's display name. @@ -2608,6 +2614,7 @@

Method Details

"pscEnabled": True or False, # Whether PSC connectivity is enabled for this instance. }, "requireSsl": True or False, # Use `ssl_mode` instead. Whether SSL/TLS connections over IP are enforced. If set to false, then allow both non-SSL/non-TLS and SSL/TLS connections. For SSL/TLS connections, the client certificate won't be verified. If set to true, then only allow connections encrypted with SSL/TLS and with valid client certificates. If you want to enforce SSL/TLS without enforcing the requirement for valid client certificates, then use the `ssl_mode` flag instead of the legacy `require_ssl` flag. + "serverCaMode": "A String", # Specify what type of CA is used for the server certificate. "sslMode": "A String", # Specify how SSL/TLS is enforced in database connections. If you must use the `require_ssl` flag for backward compatibility, then only the following value pairs are valid: For PostgreSQL and MySQL: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false` * `ssl_mode=TRUSTED_CLIENT_CERTIFICATE_REQUIRED` and `require_ssl=true` For SQL Server: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=true` The value of `ssl_mode` has priority over the value of `require_ssl`. For example, for the pair `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false`, `ssl_mode=ENCRYPTED_ONLY` means accept only SSL connections, while `require_ssl=false` means accept both non-SSL and SSL connections. In this case, MySQL and PostgreSQL databases respect `ssl_mode` and accepts only SSL connections. }, "kind": "A String", # This is always `sql#settings`. @@ -2654,6 +2661,7 @@

Method Details

"suspensionReason": [ # If the instance state is SUSPENDED, the reason for the suspension. "A String", ], + "switchTransactionLogsToCloudStorageEnabled": True or False, # Input only. Whether Cloud SQL is enabled to switch storing point-in-time recovery log files from a data disk to Cloud Storage. "upgradableDatabaseVersions": [ # Output only. All database versions that are available for upgrade. { # An available database version. It can be a major or a minor version. "displayName": "A String", # The database version's display name. @@ -3494,7 +3502,7 @@

Method Details

rotateServerCa(project, instance, body=None, x__xgafv=None) -
Rotates the server certificate to one signed by the Certificate Authority (CA) version previously added with the addServerCA method.
+  
Rotates the server certificate to one signed by the Certificate Authority (CA) version previously added with the addServerCA method. For instances that have enabled Certificate Authority Service (CAS) based server CA, please use RotateServerCertificate to rotate the server certificate.
 
 Args:
   project: string, Project ID of the project that contains the instance. (required)
@@ -4382,6 +4390,7 @@ 

Method Details

"pscEnabled": True or False, # Whether PSC connectivity is enabled for this instance. }, "requireSsl": True or False, # Use `ssl_mode` instead. Whether SSL/TLS connections over IP are enforced. If set to false, then allow both non-SSL/non-TLS and SSL/TLS connections. For SSL/TLS connections, the client certificate won't be verified. If set to true, then only allow connections encrypted with SSL/TLS and with valid client certificates. If you want to enforce SSL/TLS without enforcing the requirement for valid client certificates, then use the `ssl_mode` flag instead of the legacy `require_ssl` flag. + "serverCaMode": "A String", # Specify what type of CA is used for the server certificate. "sslMode": "A String", # Specify how SSL/TLS is enforced in database connections. If you must use the `require_ssl` flag for backward compatibility, then only the following value pairs are valid: For PostgreSQL and MySQL: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false` * `ssl_mode=TRUSTED_CLIENT_CERTIFICATE_REQUIRED` and `require_ssl=true` For SQL Server: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=true` The value of `ssl_mode` has priority over the value of `require_ssl`. For example, for the pair `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false`, `ssl_mode=ENCRYPTED_ONLY` means accept only SSL connections, while `require_ssl=false` means accept both non-SSL and SSL connections. In this case, MySQL and PostgreSQL databases respect `ssl_mode` and accepts only SSL connections. }, "kind": "A String", # This is always `sql#settings`. @@ -4428,6 +4437,7 @@

Method Details

"suspensionReason": [ # If the instance state is SUSPENDED, the reason for the suspension. "A String", ], + "switchTransactionLogsToCloudStorageEnabled": True or False, # Input only. Whether Cloud SQL is enabled to switch storing point-in-time recovery log files from a data disk to Cloud Storage. "upgradableDatabaseVersions": [ # Output only. All database versions that are available for upgrade. { # An available database version. It can be a major or a minor version. "displayName": "A String", # The database version's display name. diff --git a/docs/dyn/translate_v3.projects.html b/docs/dyn/translate_v3.projects.html index e2c4e416a77..0af0592cb67 100644 --- a/docs/dyn/translate_v3.projects.html +++ b/docs/dyn/translate_v3.projects.html @@ -219,7 +219,7 @@

Method Details

"a_key": "A String", }, "mimeType": "A String", # Optional. The format of the source text, for example, "text/html", "text/plain". If left blank, the MIME type defaults to "text/html". - "model": "A String", # Optional. The `model` type requested for this translation. The format depends on model type: - AutoML Translation models: `projects/{project-number-or-id}/locations/{location-id}/models/{model-id}` - General (built-in) models: `projects/{project-number-or-id}/locations/{location-id}/models/general/nmt`, For global (non-regionalized) requests, use `location-id` `global`. For example, `projects/{project-number-or-id}/locations/global/models/general/nmt`. If not provided, the default Google model (NMT) will be used + "model": "A String", # Optional. The `model` type requested for this translation. The format depends on model type: - AutoML Translation models: `projects/{project-number-or-id}/locations/{location-id}/models/{model-id}` - General (built-in) models: `projects/{project-number-or-id}/locations/{location-id}/models/general/nmt`, - Translation LLM models: `projects/{project-number-or-id}/locations/{location-id}/models/general/translation-llm`, For global (non-regionalized) requests, use `location-id` `global`. For example, `projects/{project-number-or-id}/locations/global/models/general/nmt`. If not provided, the default Google model (NMT) will be used "sourceLanguageCode": "A String", # Optional. The ISO-639 language code of the input text if known, for example, "en-US" or "sr-Latn". Supported language codes are listed in Language Support. If the source language isn't specified, the API attempts to identify the source language automatically and returns the source language within the response. "targetLanguageCode": "A String", # Required. The ISO-639 language code to use for translation of the input text, set to one of the language codes listed in Language Support. "transliterationConfig": { # Configures transliteration feature on top of translation. # Optional. Transliteration to be applied. diff --git a/docs/dyn/translate_v3.projects.locations.glossaries.glossaryEntries.html b/docs/dyn/translate_v3.projects.locations.glossaries.glossaryEntries.html index f7b6f084f83..30d26501d18 100644 --- a/docs/dyn/translate_v3.projects.locations.glossaries.glossaryEntries.html +++ b/docs/dyn/translate_v3.projects.locations.glossaries.glossaryEntries.html @@ -112,7 +112,7 @@

Method Details

{ # Represents a single entry in a glossary. "description": "A String", # Describes the glossary entry. - "name": "A String", # Required. The resource name of the entry. Format: "projects/*/locations/*/glossaries/*/glossaryEntries/*" + "name": "A String", # Identifier. The resource name of the entry. Format: "projects/*/locations/*/glossaries/*/glossaryEntries/*" "termsPair": { # Represents a single entry for an unidirectional glossary. # Used for an unidirectional glossary. "sourceTerm": { # Represents a single glossary term # The source term is the term that will get match in the text, "languageCode": "A String", # The language for this glossary term. @@ -143,7 +143,7 @@

Method Details

{ # Represents a single entry in a glossary. "description": "A String", # Describes the glossary entry. - "name": "A String", # Required. The resource name of the entry. Format: "projects/*/locations/*/glossaries/*/glossaryEntries/*" + "name": "A String", # Identifier. The resource name of the entry. Format: "projects/*/locations/*/glossaries/*/glossaryEntries/*" "termsPair": { # Represents a single entry for an unidirectional glossary. # Used for an unidirectional glossary. "sourceTerm": { # Represents a single glossary term # The source term is the term that will get match in the text, "languageCode": "A String", # The language for this glossary term. @@ -199,7 +199,7 @@

Method Details

{ # Represents a single entry in a glossary. "description": "A String", # Describes the glossary entry. - "name": "A String", # Required. The resource name of the entry. Format: "projects/*/locations/*/glossaries/*/glossaryEntries/*" + "name": "A String", # Identifier. The resource name of the entry. Format: "projects/*/locations/*/glossaries/*/glossaryEntries/*" "termsPair": { # Represents a single entry for an unidirectional glossary. # Used for an unidirectional glossary. "sourceTerm": { # Represents a single glossary term # The source term is the term that will get match in the text, "languageCode": "A String", # The language for this glossary term. @@ -241,7 +241,7 @@

Method Details

"glossaryEntries": [ # Optional. The Glossary Entries { # Represents a single entry in a glossary. "description": "A String", # Describes the glossary entry. - "name": "A String", # Required. The resource name of the entry. Format: "projects/*/locations/*/glossaries/*/glossaryEntries/*" + "name": "A String", # Identifier. The resource name of the entry. Format: "projects/*/locations/*/glossaries/*/glossaryEntries/*" "termsPair": { # Represents a single entry for an unidirectional glossary. # Used for an unidirectional glossary. "sourceTerm": { # Represents a single glossary term # The source term is the term that will get match in the text, "languageCode": "A String", # The language for this glossary term. @@ -285,13 +285,13 @@

Method Details

Updates a glossary entry.
 
 Args:
-  name: string, Required. The resource name of the entry. Format: "projects/*/locations/*/glossaries/*/glossaryEntries/*" (required)
+  name: string, Identifier. The resource name of the entry. Format: "projects/*/locations/*/glossaries/*/glossaryEntries/*" (required)
   body: object, The request body.
     The object takes the form of:
 
 { # Represents a single entry in a glossary.
   "description": "A String", # Describes the glossary entry.
-  "name": "A String", # Required. The resource name of the entry. Format: "projects/*/locations/*/glossaries/*/glossaryEntries/*"
+  "name": "A String", # Identifier. The resource name of the entry. Format: "projects/*/locations/*/glossaries/*/glossaryEntries/*"
   "termsPair": { # Represents a single entry for an unidirectional glossary. # Used for an unidirectional glossary.
     "sourceTerm": { # Represents a single glossary term # The source term is the term that will get match in the text,
       "languageCode": "A String", # The language for this glossary term.
@@ -322,7 +322,7 @@ 

Method Details

{ # Represents a single entry in a glossary. "description": "A String", # Describes the glossary entry. - "name": "A String", # Required. The resource name of the entry. Format: "projects/*/locations/*/glossaries/*/glossaryEntries/*" + "name": "A String", # Identifier. The resource name of the entry. Format: "projects/*/locations/*/glossaries/*/glossaryEntries/*" "termsPair": { # Represents a single entry for an unidirectional glossary. # Used for an unidirectional glossary. "sourceTerm": { # Represents a single glossary term # The source term is the term that will get match in the text, "languageCode": "A String", # The language for this glossary term. diff --git a/docs/dyn/translate_v3.projects.locations.html b/docs/dyn/translate_v3.projects.locations.html index 4a96446f5af..7fd25f4d269 100644 --- a/docs/dyn/translate_v3.projects.locations.html +++ b/docs/dyn/translate_v3.projects.locations.html @@ -146,10 +146,28 @@

Method Details

The object takes the form of: { # The request for sending an AdaptiveMt translation query. - "content": [ # Required. The content of the input in string format. For now only one sentence per request is supported. + "content": [ # Required. The content of the input in string format. "A String", ], "dataset": "A String", # Required. The resource name for the dataset to use for adaptive MT. `projects/{project}/locations/{location-id}/adaptiveMtDatasets/{dataset}` + "glossaryConfig": { # Configures which glossary is used for a specific target language and defines options for applying that glossary. # Optional. Glossary to be applied. The glossary must be within the same region (have the same location-id) as the model, otherwise an INVALID_ARGUMENT (400) error is returned. + "glossary": "A String", # Required. The `glossary` to be applied for this translation. The format depends on the glossary: - User-provided custom glossary: `projects/{project-number-or-id}/locations/{location-id}/glossaries/{glossary-id}` + "ignoreCase": True or False, # Optional. Indicates match is case insensitive. The default value is `false` if missing. + }, + "referenceSentenceConfig": { # Message of caller-provided reference configuration. # Configuration for caller provided reference sentences. + "referenceSentencePairLists": [ # Reference sentences pair lists. Each list will be used as the references to translate the sentence under "content" field at the corresponding index. Length of the list is required to be equal to the length of "content" field. + { # A list of reference sentence pairs. + "referenceSentencePairs": [ # Reference sentence pairs. + { # A pair of sentences used as reference in source and target languages. + "sourceSentence": "A String", # Source sentence in the sentence pair. + "targetSentence": "A String", # Target sentence in the sentence pair. + }, + ], + }, + ], + "sourceLanguageCode": "A String", # Source language code. + "targetLanguageCode": "A String", # Target language code. + }, } x__xgafv: string, V1 error format. @@ -161,6 +179,11 @@

Method Details

An object of the form: { # An AdaptiveMtTranslate response. + "glossaryTranslations": [ # Text translation response if a glossary is provided in the request. This could be the same as 'translation' above if no terms apply. + { # An AdaptiveMt translation. + "translatedText": "A String", # Output only. The translated text. + }, + ], "languageCode": "A String", # Output only. The translation's language code. "translations": [ # Output only. The translation. { # An AdaptiveMt translation. @@ -582,7 +605,7 @@

Method Details

"a_key": "A String", }, "mimeType": "A String", # Optional. The format of the source text, for example, "text/html", "text/plain". If left blank, the MIME type defaults to "text/html". - "model": "A String", # Optional. The `model` type requested for this translation. The format depends on model type: - AutoML Translation models: `projects/{project-number-or-id}/locations/{location-id}/models/{model-id}` - General (built-in) models: `projects/{project-number-or-id}/locations/{location-id}/models/general/nmt`, For global (non-regionalized) requests, use `location-id` `global`. For example, `projects/{project-number-or-id}/locations/global/models/general/nmt`. If not provided, the default Google model (NMT) will be used + "model": "A String", # Optional. The `model` type requested for this translation. The format depends on model type: - AutoML Translation models: `projects/{project-number-or-id}/locations/{location-id}/models/{model-id}` - General (built-in) models: `projects/{project-number-or-id}/locations/{location-id}/models/general/nmt`, - Translation LLM models: `projects/{project-number-or-id}/locations/{location-id}/models/general/translation-llm`, For global (non-regionalized) requests, use `location-id` `global`. For example, `projects/{project-number-or-id}/locations/global/models/general/nmt`. If not provided, the default Google model (NMT) will be used "sourceLanguageCode": "A String", # Optional. The ISO-639 language code of the input text if known, for example, "en-US" or "sr-Latn". Supported language codes are listed in Language Support. If the source language isn't specified, the API attempts to identify the source language automatically and returns the source language within the response. "targetLanguageCode": "A String", # Required. The ISO-639 language code to use for translation of the input text, set to one of the language codes listed in Language Support. "transliterationConfig": { # Configures transliteration feature on top of translation. # Optional. Transliteration to be applied. diff --git a/docs/dyn/vmmigration_v1.projects.locations.imageImports.html b/docs/dyn/vmmigration_v1.projects.locations.imageImports.html index 13b820abe65..ffcc45a4ee5 100644 --- a/docs/dyn/vmmigration_v1.projects.locations.imageImports.html +++ b/docs/dyn/vmmigration_v1.projects.locations.imageImports.html @@ -140,6 +140,53 @@

Method Details

"encryption": { # Encryption message describes the details of the applied encryption. # Immutable. The encryption details used by the image import process during the image adaptation for Compute Engine. "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. }, + "machineImageTargetDefaults": { # The target details of the machine image resource that will be created by the image import job. # Immutable. Target details for importing a machine image, will be used by ImageImportJob. + "additionalLicenses": [ # Optional. Additional licenses to assign to the instance created by the machine image. Format: https://www.googleapis.com/compute/v1/projects/PROJECT_ID/global/licenses/LICENSE_NAME Or https://www.googleapis.com/compute/beta/projects/PROJECT_ID/global/licenses/LICENSE_NAME + "A String", + ], + "description": "A String", # Optional. An optional description of the machine image. + "encryption": { # Encryption message describes the details of the applied encryption. # Immutable. The encryption to apply to the machine image. + "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. + }, + "labels": { # Optional. The labels to apply to the instance created by the machine image. + "a_key": "A String", + }, + "machineImageName": "A String", # Required. The name of the machine image to be created. + "machineImageParametersOverrides": { # Parameters overriding decisions based on the source machine image configurations. # Optional. Parameters overriding decisions based on the source machine image configurations. + "machineType": "A String", # Optional. The machine type to create the MachineImage with. If empty, the service will choose a relevant machine type based on the information from the source image. For more information about machine types, please refer to https://cloud.google.com/compute/docs/machine-resource. + }, + "networkInterfaces": [ # Optional. The network interfaces to create with the instance created by the machine image. Internal and external IP addresses are ignored for machine image import. + { # NetworkInterface represents a NIC of a VM. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + }, + ], + "osAdaptationParameters": { # Parameters affecting the OS adaptation process. # Optional. Use to set the parameters relevant for the OS adaptation process. + "generalize": True or False, # Optional. Set to true in order to generalize the imported image. The generalization process enables co-existence of multiple VMs created from the same image. For Windows, generalizing the image removes computer-specific information such as installed drivers and the computer security identifier (SID). + "licenseType": "A String", # Optional. Choose which type of license to apply to the imported image. + }, + "serviceAccount": { # Service account to assign to the instance created by the machine image. # Optional. The service account to assign to the instance created by the machine image. + "email": "A String", # Required. The email address of the service account. + "scopes": [ # Optional. The list of scopes to be made available for this service account. + "A String", + ], + }, + "shieldedInstanceConfig": { # Shielded instance configuration. # Optional. Shielded instance configuration. + "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance created by the machine image has integrity monitoring enabled. This can be set to true only if the image boot option is EFI, and vTPM is enabled. + "enableVtpm": True or False, # Optional. Defines whether the instance created by the machine image has vTPM enabled. This can be set to true only if the image boot option is EFI. + "secureBoot": "A String", # Optional. Defines whether the instance created by the machine image has Secure Boot enabled. This can be set to true only if the image boot option is EFI. + }, + "singleRegionStorage": True or False, # Optional. Set to true to set the machine image storageLocations to the single region of the import job. When false, the closest multi-region is selected. + "skipOsAdaptation": { # Mentions that the machine image import is not using OS adaptation process. # Optional. Use to skip OS adaptation process. + }, + "tags": [ # Optional. The tags to apply to the instance created by the machine image. + "A String", + ], + "targetProject": "A String", # Required. Reference to the TargetProject resource that represents the target project in which the imported machine image will be created. + }, "name": "A String", # Output only. The resource path of the ImageImport. "recentImageImportJobs": [ # Output only. The result of the most recent runs for this ImageImport. All jobs for this ImageImport can be listed via ListImageImportJobs. { # ImageImportJob describes the progress and result of an image import. @@ -182,6 +229,53 @@

Method Details

"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. }, ], + "machineImageTargetDetails": { # The target details of the machine image resource that will be created by the image import job. # Output only. Target details used to import a machine image. + "additionalLicenses": [ # Optional. Additional licenses to assign to the instance created by the machine image. Format: https://www.googleapis.com/compute/v1/projects/PROJECT_ID/global/licenses/LICENSE_NAME Or https://www.googleapis.com/compute/beta/projects/PROJECT_ID/global/licenses/LICENSE_NAME + "A String", + ], + "description": "A String", # Optional. An optional description of the machine image. + "encryption": { # Encryption message describes the details of the applied encryption. # Immutable. The encryption to apply to the machine image. + "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. + }, + "labels": { # Optional. The labels to apply to the instance created by the machine image. + "a_key": "A String", + }, + "machineImageName": "A String", # Required. The name of the machine image to be created. + "machineImageParametersOverrides": { # Parameters overriding decisions based on the source machine image configurations. # Optional. Parameters overriding decisions based on the source machine image configurations. + "machineType": "A String", # Optional. The machine type to create the MachineImage with. If empty, the service will choose a relevant machine type based on the information from the source image. For more information about machine types, please refer to https://cloud.google.com/compute/docs/machine-resource. + }, + "networkInterfaces": [ # Optional. The network interfaces to create with the instance created by the machine image. Internal and external IP addresses are ignored for machine image import. + { # NetworkInterface represents a NIC of a VM. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + }, + ], + "osAdaptationParameters": { # Parameters affecting the OS adaptation process. # Optional. Use to set the parameters relevant for the OS adaptation process. + "generalize": True or False, # Optional. Set to true in order to generalize the imported image. The generalization process enables co-existence of multiple VMs created from the same image. For Windows, generalizing the image removes computer-specific information such as installed drivers and the computer security identifier (SID). + "licenseType": "A String", # Optional. Choose which type of license to apply to the imported image. + }, + "serviceAccount": { # Service account to assign to the instance created by the machine image. # Optional. The service account to assign to the instance created by the machine image. + "email": "A String", # Required. The email address of the service account. + "scopes": [ # Optional. The list of scopes to be made available for this service account. + "A String", + ], + }, + "shieldedInstanceConfig": { # Shielded instance configuration. # Optional. Shielded instance configuration. + "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance created by the machine image has integrity monitoring enabled. This can be set to true only if the image boot option is EFI, and vTPM is enabled. + "enableVtpm": True or False, # Optional. Defines whether the instance created by the machine image has vTPM enabled. This can be set to true only if the image boot option is EFI. + "secureBoot": "A String", # Optional. Defines whether the instance created by the machine image has Secure Boot enabled. This can be set to true only if the image boot option is EFI. + }, + "singleRegionStorage": True or False, # Optional. Set to true to set the machine image storageLocations to the single region of the import job. When false, the closest multi-region is selected. + "skipOsAdaptation": { # Mentions that the machine image import is not using OS adaptation process. # Optional. Use to skip OS adaptation process. + }, + "tags": [ # Optional. The tags to apply to the instance created by the machine image. + "A String", + ], + "targetProject": "A String", # Required. Reference to the TargetProject resource that represents the target project in which the imported machine image will be created. + }, "name": "A String", # Output only. The resource path of the ImageImportJob. "state": "A String", # Output only. The state of the image import. "steps": [ # Output only. The image import steps list representing its progress. @@ -331,6 +425,53 @@

Method Details

"encryption": { # Encryption message describes the details of the applied encryption. # Immutable. The encryption details used by the image import process during the image adaptation for Compute Engine. "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. }, + "machineImageTargetDefaults": { # The target details of the machine image resource that will be created by the image import job. # Immutable. Target details for importing a machine image, will be used by ImageImportJob. + "additionalLicenses": [ # Optional. Additional licenses to assign to the instance created by the machine image. Format: https://www.googleapis.com/compute/v1/projects/PROJECT_ID/global/licenses/LICENSE_NAME Or https://www.googleapis.com/compute/beta/projects/PROJECT_ID/global/licenses/LICENSE_NAME + "A String", + ], + "description": "A String", # Optional. An optional description of the machine image. + "encryption": { # Encryption message describes the details of the applied encryption. # Immutable. The encryption to apply to the machine image. + "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. + }, + "labels": { # Optional. The labels to apply to the instance created by the machine image. + "a_key": "A String", + }, + "machineImageName": "A String", # Required. The name of the machine image to be created. + "machineImageParametersOverrides": { # Parameters overriding decisions based on the source machine image configurations. # Optional. Parameters overriding decisions based on the source machine image configurations. + "machineType": "A String", # Optional. The machine type to create the MachineImage with. If empty, the service will choose a relevant machine type based on the information from the source image. For more information about machine types, please refer to https://cloud.google.com/compute/docs/machine-resource. + }, + "networkInterfaces": [ # Optional. The network interfaces to create with the instance created by the machine image. Internal and external IP addresses are ignored for machine image import. + { # NetworkInterface represents a NIC of a VM. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + }, + ], + "osAdaptationParameters": { # Parameters affecting the OS adaptation process. # Optional. Use to set the parameters relevant for the OS adaptation process. + "generalize": True or False, # Optional. Set to true in order to generalize the imported image. The generalization process enables co-existence of multiple VMs created from the same image. For Windows, generalizing the image removes computer-specific information such as installed drivers and the computer security identifier (SID). + "licenseType": "A String", # Optional. Choose which type of license to apply to the imported image. + }, + "serviceAccount": { # Service account to assign to the instance created by the machine image. # Optional. The service account to assign to the instance created by the machine image. + "email": "A String", # Required. The email address of the service account. + "scopes": [ # Optional. The list of scopes to be made available for this service account. + "A String", + ], + }, + "shieldedInstanceConfig": { # Shielded instance configuration. # Optional. Shielded instance configuration. + "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance created by the machine image has integrity monitoring enabled. This can be set to true only if the image boot option is EFI, and vTPM is enabled. + "enableVtpm": True or False, # Optional. Defines whether the instance created by the machine image has vTPM enabled. This can be set to true only if the image boot option is EFI. + "secureBoot": "A String", # Optional. Defines whether the instance created by the machine image has Secure Boot enabled. This can be set to true only if the image boot option is EFI. + }, + "singleRegionStorage": True or False, # Optional. Set to true to set the machine image storageLocations to the single region of the import job. When false, the closest multi-region is selected. + "skipOsAdaptation": { # Mentions that the machine image import is not using OS adaptation process. # Optional. Use to skip OS adaptation process. + }, + "tags": [ # Optional. The tags to apply to the instance created by the machine image. + "A String", + ], + "targetProject": "A String", # Required. Reference to the TargetProject resource that represents the target project in which the imported machine image will be created. + }, "name": "A String", # Output only. The resource path of the ImageImport. "recentImageImportJobs": [ # Output only. The result of the most recent runs for this ImageImport. All jobs for this ImageImport can be listed via ListImageImportJobs. { # ImageImportJob describes the progress and result of an image import. @@ -373,6 +514,53 @@

Method Details

"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. }, ], + "machineImageTargetDetails": { # The target details of the machine image resource that will be created by the image import job. # Output only. Target details used to import a machine image. + "additionalLicenses": [ # Optional. Additional licenses to assign to the instance created by the machine image. Format: https://www.googleapis.com/compute/v1/projects/PROJECT_ID/global/licenses/LICENSE_NAME Or https://www.googleapis.com/compute/beta/projects/PROJECT_ID/global/licenses/LICENSE_NAME + "A String", + ], + "description": "A String", # Optional. An optional description of the machine image. + "encryption": { # Encryption message describes the details of the applied encryption. # Immutable. The encryption to apply to the machine image. + "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. + }, + "labels": { # Optional. The labels to apply to the instance created by the machine image. + "a_key": "A String", + }, + "machineImageName": "A String", # Required. The name of the machine image to be created. + "machineImageParametersOverrides": { # Parameters overriding decisions based on the source machine image configurations. # Optional. Parameters overriding decisions based on the source machine image configurations. + "machineType": "A String", # Optional. The machine type to create the MachineImage with. If empty, the service will choose a relevant machine type based on the information from the source image. For more information about machine types, please refer to https://cloud.google.com/compute/docs/machine-resource. + }, + "networkInterfaces": [ # Optional. The network interfaces to create with the instance created by the machine image. Internal and external IP addresses are ignored for machine image import. + { # NetworkInterface represents a NIC of a VM. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + }, + ], + "osAdaptationParameters": { # Parameters affecting the OS adaptation process. # Optional. Use to set the parameters relevant for the OS adaptation process. + "generalize": True or False, # Optional. Set to true in order to generalize the imported image. The generalization process enables co-existence of multiple VMs created from the same image. For Windows, generalizing the image removes computer-specific information such as installed drivers and the computer security identifier (SID). + "licenseType": "A String", # Optional. Choose which type of license to apply to the imported image. + }, + "serviceAccount": { # Service account to assign to the instance created by the machine image. # Optional. The service account to assign to the instance created by the machine image. + "email": "A String", # Required. The email address of the service account. + "scopes": [ # Optional. The list of scopes to be made available for this service account. + "A String", + ], + }, + "shieldedInstanceConfig": { # Shielded instance configuration. # Optional. Shielded instance configuration. + "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance created by the machine image has integrity monitoring enabled. This can be set to true only if the image boot option is EFI, and vTPM is enabled. + "enableVtpm": True or False, # Optional. Defines whether the instance created by the machine image has vTPM enabled. This can be set to true only if the image boot option is EFI. + "secureBoot": "A String", # Optional. Defines whether the instance created by the machine image has Secure Boot enabled. This can be set to true only if the image boot option is EFI. + }, + "singleRegionStorage": True or False, # Optional. Set to true to set the machine image storageLocations to the single region of the import job. When false, the closest multi-region is selected. + "skipOsAdaptation": { # Mentions that the machine image import is not using OS adaptation process. # Optional. Use to skip OS adaptation process. + }, + "tags": [ # Optional. The tags to apply to the instance created by the machine image. + "A String", + ], + "targetProject": "A String", # Required. Reference to the TargetProject resource that represents the target project in which the imported machine image will be created. + }, "name": "A String", # Output only. The resource path of the ImageImportJob. "state": "A String", # Output only. The state of the image import. "steps": [ # Output only. The image import steps list representing its progress. @@ -462,6 +650,53 @@

Method Details

"encryption": { # Encryption message describes the details of the applied encryption. # Immutable. The encryption details used by the image import process during the image adaptation for Compute Engine. "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. }, + "machineImageTargetDefaults": { # The target details of the machine image resource that will be created by the image import job. # Immutable. Target details for importing a machine image, will be used by ImageImportJob. + "additionalLicenses": [ # Optional. Additional licenses to assign to the instance created by the machine image. Format: https://www.googleapis.com/compute/v1/projects/PROJECT_ID/global/licenses/LICENSE_NAME Or https://www.googleapis.com/compute/beta/projects/PROJECT_ID/global/licenses/LICENSE_NAME + "A String", + ], + "description": "A String", # Optional. An optional description of the machine image. + "encryption": { # Encryption message describes the details of the applied encryption. # Immutable. The encryption to apply to the machine image. + "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. + }, + "labels": { # Optional. The labels to apply to the instance created by the machine image. + "a_key": "A String", + }, + "machineImageName": "A String", # Required. The name of the machine image to be created. + "machineImageParametersOverrides": { # Parameters overriding decisions based on the source machine image configurations. # Optional. Parameters overriding decisions based on the source machine image configurations. + "machineType": "A String", # Optional. The machine type to create the MachineImage with. If empty, the service will choose a relevant machine type based on the information from the source image. For more information about machine types, please refer to https://cloud.google.com/compute/docs/machine-resource. + }, + "networkInterfaces": [ # Optional. The network interfaces to create with the instance created by the machine image. Internal and external IP addresses are ignored for machine image import. + { # NetworkInterface represents a NIC of a VM. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + }, + ], + "osAdaptationParameters": { # Parameters affecting the OS adaptation process. # Optional. Use to set the parameters relevant for the OS adaptation process. + "generalize": True or False, # Optional. Set to true in order to generalize the imported image. The generalization process enables co-existence of multiple VMs created from the same image. For Windows, generalizing the image removes computer-specific information such as installed drivers and the computer security identifier (SID). + "licenseType": "A String", # Optional. Choose which type of license to apply to the imported image. + }, + "serviceAccount": { # Service account to assign to the instance created by the machine image. # Optional. The service account to assign to the instance created by the machine image. + "email": "A String", # Required. The email address of the service account. + "scopes": [ # Optional. The list of scopes to be made available for this service account. + "A String", + ], + }, + "shieldedInstanceConfig": { # Shielded instance configuration. # Optional. Shielded instance configuration. + "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance created by the machine image has integrity monitoring enabled. This can be set to true only if the image boot option is EFI, and vTPM is enabled. + "enableVtpm": True or False, # Optional. Defines whether the instance created by the machine image has vTPM enabled. This can be set to true only if the image boot option is EFI. + "secureBoot": "A String", # Optional. Defines whether the instance created by the machine image has Secure Boot enabled. This can be set to true only if the image boot option is EFI. + }, + "singleRegionStorage": True or False, # Optional. Set to true to set the machine image storageLocations to the single region of the import job. When false, the closest multi-region is selected. + "skipOsAdaptation": { # Mentions that the machine image import is not using OS adaptation process. # Optional. Use to skip OS adaptation process. + }, + "tags": [ # Optional. The tags to apply to the instance created by the machine image. + "A String", + ], + "targetProject": "A String", # Required. Reference to the TargetProject resource that represents the target project in which the imported machine image will be created. + }, "name": "A String", # Output only. The resource path of the ImageImport. "recentImageImportJobs": [ # Output only. The result of the most recent runs for this ImageImport. All jobs for this ImageImport can be listed via ListImageImportJobs. { # ImageImportJob describes the progress and result of an image import. @@ -504,6 +739,53 @@

Method Details

"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. }, ], + "machineImageTargetDetails": { # The target details of the machine image resource that will be created by the image import job. # Output only. Target details used to import a machine image. + "additionalLicenses": [ # Optional. Additional licenses to assign to the instance created by the machine image. Format: https://www.googleapis.com/compute/v1/projects/PROJECT_ID/global/licenses/LICENSE_NAME Or https://www.googleapis.com/compute/beta/projects/PROJECT_ID/global/licenses/LICENSE_NAME + "A String", + ], + "description": "A String", # Optional. An optional description of the machine image. + "encryption": { # Encryption message describes the details of the applied encryption. # Immutable. The encryption to apply to the machine image. + "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. + }, + "labels": { # Optional. The labels to apply to the instance created by the machine image. + "a_key": "A String", + }, + "machineImageName": "A String", # Required. The name of the machine image to be created. + "machineImageParametersOverrides": { # Parameters overriding decisions based on the source machine image configurations. # Optional. Parameters overriding decisions based on the source machine image configurations. + "machineType": "A String", # Optional. The machine type to create the MachineImage with. If empty, the service will choose a relevant machine type based on the information from the source image. For more information about machine types, please refer to https://cloud.google.com/compute/docs/machine-resource. + }, + "networkInterfaces": [ # Optional. The network interfaces to create with the instance created by the machine image. Internal and external IP addresses are ignored for machine image import. + { # NetworkInterface represents a NIC of a VM. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + }, + ], + "osAdaptationParameters": { # Parameters affecting the OS adaptation process. # Optional. Use to set the parameters relevant for the OS adaptation process. + "generalize": True or False, # Optional. Set to true in order to generalize the imported image. The generalization process enables co-existence of multiple VMs created from the same image. For Windows, generalizing the image removes computer-specific information such as installed drivers and the computer security identifier (SID). + "licenseType": "A String", # Optional. Choose which type of license to apply to the imported image. + }, + "serviceAccount": { # Service account to assign to the instance created by the machine image. # Optional. The service account to assign to the instance created by the machine image. + "email": "A String", # Required. The email address of the service account. + "scopes": [ # Optional. The list of scopes to be made available for this service account. + "A String", + ], + }, + "shieldedInstanceConfig": { # Shielded instance configuration. # Optional. Shielded instance configuration. + "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance created by the machine image has integrity monitoring enabled. This can be set to true only if the image boot option is EFI, and vTPM is enabled. + "enableVtpm": True or False, # Optional. Defines whether the instance created by the machine image has vTPM enabled. This can be set to true only if the image boot option is EFI. + "secureBoot": "A String", # Optional. Defines whether the instance created by the machine image has Secure Boot enabled. This can be set to true only if the image boot option is EFI. + }, + "singleRegionStorage": True or False, # Optional. Set to true to set the machine image storageLocations to the single region of the import job. When false, the closest multi-region is selected. + "skipOsAdaptation": { # Mentions that the machine image import is not using OS adaptation process. # Optional. Use to skip OS adaptation process. + }, + "tags": [ # Optional. The tags to apply to the instance created by the machine image. + "A String", + ], + "targetProject": "A String", # Required. Reference to the TargetProject resource that represents the target project in which the imported machine image will be created. + }, "name": "A String", # Output only. The resource path of the ImageImportJob. "state": "A String", # Output only. The state of the image import. "steps": [ # Output only. The image import steps list representing its progress. diff --git a/docs/dyn/vmmigration_v1.projects.locations.imageImports.imageImportJobs.html b/docs/dyn/vmmigration_v1.projects.locations.imageImports.imageImportJobs.html index f230dd4115e..329074ac357 100644 --- a/docs/dyn/vmmigration_v1.projects.locations.imageImports.imageImportJobs.html +++ b/docs/dyn/vmmigration_v1.projects.locations.imageImports.imageImportJobs.html @@ -190,6 +190,53 @@

Method Details

"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. }, ], + "machineImageTargetDetails": { # The target details of the machine image resource that will be created by the image import job. # Output only. Target details used to import a machine image. + "additionalLicenses": [ # Optional. Additional licenses to assign to the instance created by the machine image. Format: https://www.googleapis.com/compute/v1/projects/PROJECT_ID/global/licenses/LICENSE_NAME Or https://www.googleapis.com/compute/beta/projects/PROJECT_ID/global/licenses/LICENSE_NAME + "A String", + ], + "description": "A String", # Optional. An optional description of the machine image. + "encryption": { # Encryption message describes the details of the applied encryption. # Immutable. The encryption to apply to the machine image. + "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. + }, + "labels": { # Optional. The labels to apply to the instance created by the machine image. + "a_key": "A String", + }, + "machineImageName": "A String", # Required. The name of the machine image to be created. + "machineImageParametersOverrides": { # Parameters overriding decisions based on the source machine image configurations. # Optional. Parameters overriding decisions based on the source machine image configurations. + "machineType": "A String", # Optional. The machine type to create the MachineImage with. If empty, the service will choose a relevant machine type based on the information from the source image. For more information about machine types, please refer to https://cloud.google.com/compute/docs/machine-resource. + }, + "networkInterfaces": [ # Optional. The network interfaces to create with the instance created by the machine image. Internal and external IP addresses are ignored for machine image import. + { # NetworkInterface represents a NIC of a VM. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + }, + ], + "osAdaptationParameters": { # Parameters affecting the OS adaptation process. # Optional. Use to set the parameters relevant for the OS adaptation process. + "generalize": True or False, # Optional. Set to true in order to generalize the imported image. The generalization process enables co-existence of multiple VMs created from the same image. For Windows, generalizing the image removes computer-specific information such as installed drivers and the computer security identifier (SID). + "licenseType": "A String", # Optional. Choose which type of license to apply to the imported image. + }, + "serviceAccount": { # Service account to assign to the instance created by the machine image. # Optional. The service account to assign to the instance created by the machine image. + "email": "A String", # Required. The email address of the service account. + "scopes": [ # Optional. The list of scopes to be made available for this service account. + "A String", + ], + }, + "shieldedInstanceConfig": { # Shielded instance configuration. # Optional. Shielded instance configuration. + "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance created by the machine image has integrity monitoring enabled. This can be set to true only if the image boot option is EFI, and vTPM is enabled. + "enableVtpm": True or False, # Optional. Defines whether the instance created by the machine image has vTPM enabled. This can be set to true only if the image boot option is EFI. + "secureBoot": "A String", # Optional. Defines whether the instance created by the machine image has Secure Boot enabled. This can be set to true only if the image boot option is EFI. + }, + "singleRegionStorage": True or False, # Optional. Set to true to set the machine image storageLocations to the single region of the import job. When false, the closest multi-region is selected. + "skipOsAdaptation": { # Mentions that the machine image import is not using OS adaptation process. # Optional. Use to skip OS adaptation process. + }, + "tags": [ # Optional. The tags to apply to the instance created by the machine image. + "A String", + ], + "targetProject": "A String", # Required. Reference to the TargetProject resource that represents the target project in which the imported machine image will be created. + }, "name": "A String", # Output only. The resource path of the ImageImportJob. "state": "A String", # Output only. The state of the image import. "steps": [ # Output only. The image import steps list representing its progress. @@ -289,6 +336,53 @@

Method Details

"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. }, ], + "machineImageTargetDetails": { # The target details of the machine image resource that will be created by the image import job. # Output only. Target details used to import a machine image. + "additionalLicenses": [ # Optional. Additional licenses to assign to the instance created by the machine image. Format: https://www.googleapis.com/compute/v1/projects/PROJECT_ID/global/licenses/LICENSE_NAME Or https://www.googleapis.com/compute/beta/projects/PROJECT_ID/global/licenses/LICENSE_NAME + "A String", + ], + "description": "A String", # Optional. An optional description of the machine image. + "encryption": { # Encryption message describes the details of the applied encryption. # Immutable. The encryption to apply to the machine image. + "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. + }, + "labels": { # Optional. The labels to apply to the instance created by the machine image. + "a_key": "A String", + }, + "machineImageName": "A String", # Required. The name of the machine image to be created. + "machineImageParametersOverrides": { # Parameters overriding decisions based on the source machine image configurations. # Optional. Parameters overriding decisions based on the source machine image configurations. + "machineType": "A String", # Optional. The machine type to create the MachineImage with. If empty, the service will choose a relevant machine type based on the information from the source image. For more information about machine types, please refer to https://cloud.google.com/compute/docs/machine-resource. + }, + "networkInterfaces": [ # Optional. The network interfaces to create with the instance created by the machine image. Internal and external IP addresses are ignored for machine image import. + { # NetworkInterface represents a NIC of a VM. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + }, + ], + "osAdaptationParameters": { # Parameters affecting the OS adaptation process. # Optional. Use to set the parameters relevant for the OS adaptation process. + "generalize": True or False, # Optional. Set to true in order to generalize the imported image. The generalization process enables co-existence of multiple VMs created from the same image. For Windows, generalizing the image removes computer-specific information such as installed drivers and the computer security identifier (SID). + "licenseType": "A String", # Optional. Choose which type of license to apply to the imported image. + }, + "serviceAccount": { # Service account to assign to the instance created by the machine image. # Optional. The service account to assign to the instance created by the machine image. + "email": "A String", # Required. The email address of the service account. + "scopes": [ # Optional. The list of scopes to be made available for this service account. + "A String", + ], + }, + "shieldedInstanceConfig": { # Shielded instance configuration. # Optional. Shielded instance configuration. + "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance created by the machine image has integrity monitoring enabled. This can be set to true only if the image boot option is EFI, and vTPM is enabled. + "enableVtpm": True or False, # Optional. Defines whether the instance created by the machine image has vTPM enabled. This can be set to true only if the image boot option is EFI. + "secureBoot": "A String", # Optional. Defines whether the instance created by the machine image has Secure Boot enabled. This can be set to true only if the image boot option is EFI. + }, + "singleRegionStorage": True or False, # Optional. Set to true to set the machine image storageLocations to the single region of the import job. When false, the closest multi-region is selected. + "skipOsAdaptation": { # Mentions that the machine image import is not using OS adaptation process. # Optional. Use to skip OS adaptation process. + }, + "tags": [ # Optional. The tags to apply to the instance created by the machine image. + "A String", + ], + "targetProject": "A String", # Required. Reference to the TargetProject resource that represents the target project in which the imported machine image will be created. + }, "name": "A String", # Output only. The resource path of the ImageImportJob. "state": "A String", # Output only. The state of the image import. "steps": [ # Output only. The image import steps list representing its progress. diff --git a/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.cloneJobs.html b/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.cloneJobs.html index 90252c842f7..40ed69337fb 100644 --- a/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.cloneJobs.html +++ b/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.cloneJobs.html @@ -204,6 +204,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -345,6 +346,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -462,6 +464,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], diff --git a/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.cutoverJobs.html b/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.cutoverJobs.html index b81a6797723..7921a1d4678 100644 --- a/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.cutoverJobs.html +++ b/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.cutoverJobs.html @@ -204,6 +204,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -455,6 +456,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -682,6 +684,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], diff --git a/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.html b/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.html index ee89aec584b..0d8c33e63af 100644 --- a/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.html +++ b/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.html @@ -238,6 +238,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -292,6 +293,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -496,6 +498,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -593,6 +596,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -993,6 +997,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -1047,6 +1052,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -1251,6 +1257,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -1348,6 +1355,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -1648,6 +1656,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -1702,6 +1711,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -1906,6 +1916,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -2003,6 +2014,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -2307,6 +2319,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -2361,6 +2374,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -2565,6 +2579,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -2662,6 +2677,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], diff --git a/docs/dyn/vmmigration_v1alpha1.projects.locations.imageImports.html b/docs/dyn/vmmigration_v1alpha1.projects.locations.imageImports.html index 85434e5fc97..e82d184fee6 100644 --- a/docs/dyn/vmmigration_v1alpha1.projects.locations.imageImports.html +++ b/docs/dyn/vmmigration_v1alpha1.projects.locations.imageImports.html @@ -140,6 +140,53 @@

Method Details

"encryption": { # Encryption message describes the details of the applied encryption. # Immutable. The encryption details used by the image import process during the image adaptation for Compute Engine. "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. }, + "machineImageTargetDefaults": { # The target details of the machine image resource that will be created by the image import job. # Immutable. Target details for importing a machine image, will be used by ImageImportJob. + "additionalLicenses": [ # Optional. Additional licenses to assign to the instance created by the machine image. Format: https://www.googleapis.com/compute/v1/projects/PROJECT_ID/global/licenses/LICENSE_NAME Or https://www.googleapis.com/compute/beta/projects/PROJECT_ID/global/licenses/LICENSE_NAME + "A String", + ], + "description": "A String", # Optional. An optional description of the machine image. + "encryption": { # Encryption message describes the details of the applied encryption. # Immutable. The encryption to apply to the machine image. + "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. + }, + "labels": { # Optional. The labels to apply to the instance created by the machine image. + "a_key": "A String", + }, + "machineImageName": "A String", # Required. The name of the machine image to be created. + "machineImageParametersOverrides": { # Parameters overriding decisions based on the source machine image configurations. # Optional. Parameters overriding decisions based on the source machine image configurations. + "machineType": "A String", # Optional. The machine type to create the MachineImage with. If empty, the service will choose a relevant machine type based on the information from the source image. For more information about machine types, please refer to https://cloud.google.com/compute/docs/machine-resource. + }, + "networkInterfaces": [ # Optional. The network interfaces to create with the instance created by the machine image. Internal and external IP addresses are ignored for machine image import. + { # NetworkInterface represents a NIC of a VM. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + }, + ], + "osAdaptationParameters": { # Parameters affecting the OS adaptation process. # Optional. Use to set the parameters relevant for the OS adaptation process. + "generalize": True or False, # Optional. Set to true in order to generalize the imported image. The generalization process enables co-existence of multiple VMs created from the same image. For Windows, generalizing the image removes computer-specific information such as installed drivers and the computer security identifier (SID). + "licenseType": "A String", # Optional. Choose which type of license to apply to the imported image. + }, + "serviceAccount": { # Service account to assign to the instance created by the machine image. # Optional. The service account to assign to the instance created by the machine image. + "email": "A String", # Required. The email address of the service account. + "scopes": [ # Optional. The list of scopes to be made available for this service account. + "A String", + ], + }, + "shieldedInstanceConfig": { # Shielded instance configuration. # Optional. Shielded instance configuration. + "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance created by the machine image has integrity monitoring enabled. This can be set to true only if the image boot option is EFI, and vTPM is enabled. + "enableVtpm": True or False, # Optional. Defines whether the instance created by the machine image has vTPM enabled. This can be set to true only if the image boot option is EFI. + "secureBoot": "A String", # Optional. Defines whether the instance created by the machine image has Secure Boot enabled. This can be set to true only if the image boot option is EFI. + }, + "singleRegionStorage": True or False, # Optional. Set to true to set the machine image storageLocations to the single region of the import job. When false, the closest multi-region is selected. + "skipOsAdaptation": { # Mentions that the machine image import is not using OS adaptation process. # Optional. Use to skip OS adaptation process. + }, + "tags": [ # Optional. The tags to apply to the instance created by the machine image. + "A String", + ], + "targetProject": "A String", # Required. Reference to the TargetProject resource that represents the target project in which the imported machine image will be created. + }, "name": "A String", # Output only. The resource path of the ImageImport. "recentImageImportJobs": [ # Output only. The result of the most recent runs for this ImageImport. All jobs for this ImageImport can be listed via ListImageImportJobs. { # ImageImportJob describes the progress and result of an image import. @@ -182,6 +229,53 @@

Method Details

"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. }, ], + "machineImageTargetDetails": { # The target details of the machine image resource that will be created by the image import job. # Output only. Target details used to import a machine image. + "additionalLicenses": [ # Optional. Additional licenses to assign to the instance created by the machine image. Format: https://www.googleapis.com/compute/v1/projects/PROJECT_ID/global/licenses/LICENSE_NAME Or https://www.googleapis.com/compute/beta/projects/PROJECT_ID/global/licenses/LICENSE_NAME + "A String", + ], + "description": "A String", # Optional. An optional description of the machine image. + "encryption": { # Encryption message describes the details of the applied encryption. # Immutable. The encryption to apply to the machine image. + "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. + }, + "labels": { # Optional. The labels to apply to the instance created by the machine image. + "a_key": "A String", + }, + "machineImageName": "A String", # Required. The name of the machine image to be created. + "machineImageParametersOverrides": { # Parameters overriding decisions based on the source machine image configurations. # Optional. Parameters overriding decisions based on the source machine image configurations. + "machineType": "A String", # Optional. The machine type to create the MachineImage with. If empty, the service will choose a relevant machine type based on the information from the source image. For more information about machine types, please refer to https://cloud.google.com/compute/docs/machine-resource. + }, + "networkInterfaces": [ # Optional. The network interfaces to create with the instance created by the machine image. Internal and external IP addresses are ignored for machine image import. + { # NetworkInterface represents a NIC of a VM. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + }, + ], + "osAdaptationParameters": { # Parameters affecting the OS adaptation process. # Optional. Use to set the parameters relevant for the OS adaptation process. + "generalize": True or False, # Optional. Set to true in order to generalize the imported image. The generalization process enables co-existence of multiple VMs created from the same image. For Windows, generalizing the image removes computer-specific information such as installed drivers and the computer security identifier (SID). + "licenseType": "A String", # Optional. Choose which type of license to apply to the imported image. + }, + "serviceAccount": { # Service account to assign to the instance created by the machine image. # Optional. The service account to assign to the instance created by the machine image. + "email": "A String", # Required. The email address of the service account. + "scopes": [ # Optional. The list of scopes to be made available for this service account. + "A String", + ], + }, + "shieldedInstanceConfig": { # Shielded instance configuration. # Optional. Shielded instance configuration. + "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance created by the machine image has integrity monitoring enabled. This can be set to true only if the image boot option is EFI, and vTPM is enabled. + "enableVtpm": True or False, # Optional. Defines whether the instance created by the machine image has vTPM enabled. This can be set to true only if the image boot option is EFI. + "secureBoot": "A String", # Optional. Defines whether the instance created by the machine image has Secure Boot enabled. This can be set to true only if the image boot option is EFI. + }, + "singleRegionStorage": True or False, # Optional. Set to true to set the machine image storageLocations to the single region of the import job. When false, the closest multi-region is selected. + "skipOsAdaptation": { # Mentions that the machine image import is not using OS adaptation process. # Optional. Use to skip OS adaptation process. + }, + "tags": [ # Optional. The tags to apply to the instance created by the machine image. + "A String", + ], + "targetProject": "A String", # Required. Reference to the TargetProject resource that represents the target project in which the imported machine image will be created. + }, "name": "A String", # Output only. The resource path of the ImageImportJob. "state": "A String", # Output only. The state of the image import. "steps": [ # Output only. The image import steps list representing its progress. @@ -331,6 +425,53 @@

Method Details

"encryption": { # Encryption message describes the details of the applied encryption. # Immutable. The encryption details used by the image import process during the image adaptation for Compute Engine. "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. }, + "machineImageTargetDefaults": { # The target details of the machine image resource that will be created by the image import job. # Immutable. Target details for importing a machine image, will be used by ImageImportJob. + "additionalLicenses": [ # Optional. Additional licenses to assign to the instance created by the machine image. Format: https://www.googleapis.com/compute/v1/projects/PROJECT_ID/global/licenses/LICENSE_NAME Or https://www.googleapis.com/compute/beta/projects/PROJECT_ID/global/licenses/LICENSE_NAME + "A String", + ], + "description": "A String", # Optional. An optional description of the machine image. + "encryption": { # Encryption message describes the details of the applied encryption. # Immutable. The encryption to apply to the machine image. + "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. + }, + "labels": { # Optional. The labels to apply to the instance created by the machine image. + "a_key": "A String", + }, + "machineImageName": "A String", # Required. The name of the machine image to be created. + "machineImageParametersOverrides": { # Parameters overriding decisions based on the source machine image configurations. # Optional. Parameters overriding decisions based on the source machine image configurations. + "machineType": "A String", # Optional. The machine type to create the MachineImage with. If empty, the service will choose a relevant machine type based on the information from the source image. For more information about machine types, please refer to https://cloud.google.com/compute/docs/machine-resource. + }, + "networkInterfaces": [ # Optional. The network interfaces to create with the instance created by the machine image. Internal and external IP addresses are ignored for machine image import. + { # NetworkInterface represents a NIC of a VM. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + }, + ], + "osAdaptationParameters": { # Parameters affecting the OS adaptation process. # Optional. Use to set the parameters relevant for the OS adaptation process. + "generalize": True or False, # Optional. Set to true in order to generalize the imported image. The generalization process enables co-existence of multiple VMs created from the same image. For Windows, generalizing the image removes computer-specific information such as installed drivers and the computer security identifier (SID). + "licenseType": "A String", # Optional. Choose which type of license to apply to the imported image. + }, + "serviceAccount": { # Service account to assign to the instance created by the machine image. # Optional. The service account to assign to the instance created by the machine image. + "email": "A String", # Required. The email address of the service account. + "scopes": [ # Optional. The list of scopes to be made available for this service account. + "A String", + ], + }, + "shieldedInstanceConfig": { # Shielded instance configuration. # Optional. Shielded instance configuration. + "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance created by the machine image has integrity monitoring enabled. This can be set to true only if the image boot option is EFI, and vTPM is enabled. + "enableVtpm": True or False, # Optional. Defines whether the instance created by the machine image has vTPM enabled. This can be set to true only if the image boot option is EFI. + "secureBoot": "A String", # Optional. Defines whether the instance created by the machine image has Secure Boot enabled. This can be set to true only if the image boot option is EFI. + }, + "singleRegionStorage": True or False, # Optional. Set to true to set the machine image storageLocations to the single region of the import job. When false, the closest multi-region is selected. + "skipOsAdaptation": { # Mentions that the machine image import is not using OS adaptation process. # Optional. Use to skip OS adaptation process. + }, + "tags": [ # Optional. The tags to apply to the instance created by the machine image. + "A String", + ], + "targetProject": "A String", # Required. Reference to the TargetProject resource that represents the target project in which the imported machine image will be created. + }, "name": "A String", # Output only. The resource path of the ImageImport. "recentImageImportJobs": [ # Output only. The result of the most recent runs for this ImageImport. All jobs for this ImageImport can be listed via ListImageImportJobs. { # ImageImportJob describes the progress and result of an image import. @@ -373,6 +514,53 @@

Method Details

"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. }, ], + "machineImageTargetDetails": { # The target details of the machine image resource that will be created by the image import job. # Output only. Target details used to import a machine image. + "additionalLicenses": [ # Optional. Additional licenses to assign to the instance created by the machine image. Format: https://www.googleapis.com/compute/v1/projects/PROJECT_ID/global/licenses/LICENSE_NAME Or https://www.googleapis.com/compute/beta/projects/PROJECT_ID/global/licenses/LICENSE_NAME + "A String", + ], + "description": "A String", # Optional. An optional description of the machine image. + "encryption": { # Encryption message describes the details of the applied encryption. # Immutable. The encryption to apply to the machine image. + "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. + }, + "labels": { # Optional. The labels to apply to the instance created by the machine image. + "a_key": "A String", + }, + "machineImageName": "A String", # Required. The name of the machine image to be created. + "machineImageParametersOverrides": { # Parameters overriding decisions based on the source machine image configurations. # Optional. Parameters overriding decisions based on the source machine image configurations. + "machineType": "A String", # Optional. The machine type to create the MachineImage with. If empty, the service will choose a relevant machine type based on the information from the source image. For more information about machine types, please refer to https://cloud.google.com/compute/docs/machine-resource. + }, + "networkInterfaces": [ # Optional. The network interfaces to create with the instance created by the machine image. Internal and external IP addresses are ignored for machine image import. + { # NetworkInterface represents a NIC of a VM. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + }, + ], + "osAdaptationParameters": { # Parameters affecting the OS adaptation process. # Optional. Use to set the parameters relevant for the OS adaptation process. + "generalize": True or False, # Optional. Set to true in order to generalize the imported image. The generalization process enables co-existence of multiple VMs created from the same image. For Windows, generalizing the image removes computer-specific information such as installed drivers and the computer security identifier (SID). + "licenseType": "A String", # Optional. Choose which type of license to apply to the imported image. + }, + "serviceAccount": { # Service account to assign to the instance created by the machine image. # Optional. The service account to assign to the instance created by the machine image. + "email": "A String", # Required. The email address of the service account. + "scopes": [ # Optional. The list of scopes to be made available for this service account. + "A String", + ], + }, + "shieldedInstanceConfig": { # Shielded instance configuration. # Optional. Shielded instance configuration. + "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance created by the machine image has integrity monitoring enabled. This can be set to true only if the image boot option is EFI, and vTPM is enabled. + "enableVtpm": True or False, # Optional. Defines whether the instance created by the machine image has vTPM enabled. This can be set to true only if the image boot option is EFI. + "secureBoot": "A String", # Optional. Defines whether the instance created by the machine image has Secure Boot enabled. This can be set to true only if the image boot option is EFI. + }, + "singleRegionStorage": True or False, # Optional. Set to true to set the machine image storageLocations to the single region of the import job. When false, the closest multi-region is selected. + "skipOsAdaptation": { # Mentions that the machine image import is not using OS adaptation process. # Optional. Use to skip OS adaptation process. + }, + "tags": [ # Optional. The tags to apply to the instance created by the machine image. + "A String", + ], + "targetProject": "A String", # Required. Reference to the TargetProject resource that represents the target project in which the imported machine image will be created. + }, "name": "A String", # Output only. The resource path of the ImageImportJob. "state": "A String", # Output only. The state of the image import. "steps": [ # Output only. The image import steps list representing its progress. @@ -462,6 +650,53 @@

Method Details

"encryption": { # Encryption message describes the details of the applied encryption. # Immutable. The encryption details used by the image import process during the image adaptation for Compute Engine. "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. }, + "machineImageTargetDefaults": { # The target details of the machine image resource that will be created by the image import job. # Immutable. Target details for importing a machine image, will be used by ImageImportJob. + "additionalLicenses": [ # Optional. Additional licenses to assign to the instance created by the machine image. Format: https://www.googleapis.com/compute/v1/projects/PROJECT_ID/global/licenses/LICENSE_NAME Or https://www.googleapis.com/compute/beta/projects/PROJECT_ID/global/licenses/LICENSE_NAME + "A String", + ], + "description": "A String", # Optional. An optional description of the machine image. + "encryption": { # Encryption message describes the details of the applied encryption. # Immutable. The encryption to apply to the machine image. + "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. + }, + "labels": { # Optional. The labels to apply to the instance created by the machine image. + "a_key": "A String", + }, + "machineImageName": "A String", # Required. The name of the machine image to be created. + "machineImageParametersOverrides": { # Parameters overriding decisions based on the source machine image configurations. # Optional. Parameters overriding decisions based on the source machine image configurations. + "machineType": "A String", # Optional. The machine type to create the MachineImage with. If empty, the service will choose a relevant machine type based on the information from the source image. For more information about machine types, please refer to https://cloud.google.com/compute/docs/machine-resource. + }, + "networkInterfaces": [ # Optional. The network interfaces to create with the instance created by the machine image. Internal and external IP addresses are ignored for machine image import. + { # NetworkInterface represents a NIC of a VM. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + }, + ], + "osAdaptationParameters": { # Parameters affecting the OS adaptation process. # Optional. Use to set the parameters relevant for the OS adaptation process. + "generalize": True or False, # Optional. Set to true in order to generalize the imported image. The generalization process enables co-existence of multiple VMs created from the same image. For Windows, generalizing the image removes computer-specific information such as installed drivers and the computer security identifier (SID). + "licenseType": "A String", # Optional. Choose which type of license to apply to the imported image. + }, + "serviceAccount": { # Service account to assign to the instance created by the machine image. # Optional. The service account to assign to the instance created by the machine image. + "email": "A String", # Required. The email address of the service account. + "scopes": [ # Optional. The list of scopes to be made available for this service account. + "A String", + ], + }, + "shieldedInstanceConfig": { # Shielded instance configuration. # Optional. Shielded instance configuration. + "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance created by the machine image has integrity monitoring enabled. This can be set to true only if the image boot option is EFI, and vTPM is enabled. + "enableVtpm": True or False, # Optional. Defines whether the instance created by the machine image has vTPM enabled. This can be set to true only if the image boot option is EFI. + "secureBoot": "A String", # Optional. Defines whether the instance created by the machine image has Secure Boot enabled. This can be set to true only if the image boot option is EFI. + }, + "singleRegionStorage": True or False, # Optional. Set to true to set the machine image storageLocations to the single region of the import job. When false, the closest multi-region is selected. + "skipOsAdaptation": { # Mentions that the machine image import is not using OS adaptation process. # Optional. Use to skip OS adaptation process. + }, + "tags": [ # Optional. The tags to apply to the instance created by the machine image. + "A String", + ], + "targetProject": "A String", # Required. Reference to the TargetProject resource that represents the target project in which the imported machine image will be created. + }, "name": "A String", # Output only. The resource path of the ImageImport. "recentImageImportJobs": [ # Output only. The result of the most recent runs for this ImageImport. All jobs for this ImageImport can be listed via ListImageImportJobs. { # ImageImportJob describes the progress and result of an image import. @@ -504,6 +739,53 @@

Method Details

"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. }, ], + "machineImageTargetDetails": { # The target details of the machine image resource that will be created by the image import job. # Output only. Target details used to import a machine image. + "additionalLicenses": [ # Optional. Additional licenses to assign to the instance created by the machine image. Format: https://www.googleapis.com/compute/v1/projects/PROJECT_ID/global/licenses/LICENSE_NAME Or https://www.googleapis.com/compute/beta/projects/PROJECT_ID/global/licenses/LICENSE_NAME + "A String", + ], + "description": "A String", # Optional. An optional description of the machine image. + "encryption": { # Encryption message describes the details of the applied encryption. # Immutable. The encryption to apply to the machine image. + "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. + }, + "labels": { # Optional. The labels to apply to the instance created by the machine image. + "a_key": "A String", + }, + "machineImageName": "A String", # Required. The name of the machine image to be created. + "machineImageParametersOverrides": { # Parameters overriding decisions based on the source machine image configurations. # Optional. Parameters overriding decisions based on the source machine image configurations. + "machineType": "A String", # Optional. The machine type to create the MachineImage with. If empty, the service will choose a relevant machine type based on the information from the source image. For more information about machine types, please refer to https://cloud.google.com/compute/docs/machine-resource. + }, + "networkInterfaces": [ # Optional. The network interfaces to create with the instance created by the machine image. Internal and external IP addresses are ignored for machine image import. + { # NetworkInterface represents a NIC of a VM. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + }, + ], + "osAdaptationParameters": { # Parameters affecting the OS adaptation process. # Optional. Use to set the parameters relevant for the OS adaptation process. + "generalize": True or False, # Optional. Set to true in order to generalize the imported image. The generalization process enables co-existence of multiple VMs created from the same image. For Windows, generalizing the image removes computer-specific information such as installed drivers and the computer security identifier (SID). + "licenseType": "A String", # Optional. Choose which type of license to apply to the imported image. + }, + "serviceAccount": { # Service account to assign to the instance created by the machine image. # Optional. The service account to assign to the instance created by the machine image. + "email": "A String", # Required. The email address of the service account. + "scopes": [ # Optional. The list of scopes to be made available for this service account. + "A String", + ], + }, + "shieldedInstanceConfig": { # Shielded instance configuration. # Optional. Shielded instance configuration. + "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance created by the machine image has integrity monitoring enabled. This can be set to true only if the image boot option is EFI, and vTPM is enabled. + "enableVtpm": True or False, # Optional. Defines whether the instance created by the machine image has vTPM enabled. This can be set to true only if the image boot option is EFI. + "secureBoot": "A String", # Optional. Defines whether the instance created by the machine image has Secure Boot enabled. This can be set to true only if the image boot option is EFI. + }, + "singleRegionStorage": True or False, # Optional. Set to true to set the machine image storageLocations to the single region of the import job. When false, the closest multi-region is selected. + "skipOsAdaptation": { # Mentions that the machine image import is not using OS adaptation process. # Optional. Use to skip OS adaptation process. + }, + "tags": [ # Optional. The tags to apply to the instance created by the machine image. + "A String", + ], + "targetProject": "A String", # Required. Reference to the TargetProject resource that represents the target project in which the imported machine image will be created. + }, "name": "A String", # Output only. The resource path of the ImageImportJob. "state": "A String", # Output only. The state of the image import. "steps": [ # Output only. The image import steps list representing its progress. diff --git a/docs/dyn/vmmigration_v1alpha1.projects.locations.imageImports.imageImportJobs.html b/docs/dyn/vmmigration_v1alpha1.projects.locations.imageImports.imageImportJobs.html index 6b3d3710f5f..a2ee38786f9 100644 --- a/docs/dyn/vmmigration_v1alpha1.projects.locations.imageImports.imageImportJobs.html +++ b/docs/dyn/vmmigration_v1alpha1.projects.locations.imageImports.imageImportJobs.html @@ -190,6 +190,53 @@

Method Details

"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. }, ], + "machineImageTargetDetails": { # The target details of the machine image resource that will be created by the image import job. # Output only. Target details used to import a machine image. + "additionalLicenses": [ # Optional. Additional licenses to assign to the instance created by the machine image. Format: https://www.googleapis.com/compute/v1/projects/PROJECT_ID/global/licenses/LICENSE_NAME Or https://www.googleapis.com/compute/beta/projects/PROJECT_ID/global/licenses/LICENSE_NAME + "A String", + ], + "description": "A String", # Optional. An optional description of the machine image. + "encryption": { # Encryption message describes the details of the applied encryption. # Immutable. The encryption to apply to the machine image. + "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. + }, + "labels": { # Optional. The labels to apply to the instance created by the machine image. + "a_key": "A String", + }, + "machineImageName": "A String", # Required. The name of the machine image to be created. + "machineImageParametersOverrides": { # Parameters overriding decisions based on the source machine image configurations. # Optional. Parameters overriding decisions based on the source machine image configurations. + "machineType": "A String", # Optional. The machine type to create the MachineImage with. If empty, the service will choose a relevant machine type based on the information from the source image. For more information about machine types, please refer to https://cloud.google.com/compute/docs/machine-resource. + }, + "networkInterfaces": [ # Optional. The network interfaces to create with the instance created by the machine image. Internal and external IP addresses are ignored for machine image import. + { # NetworkInterface represents a NIC of a VM. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + }, + ], + "osAdaptationParameters": { # Parameters affecting the OS adaptation process. # Optional. Use to set the parameters relevant for the OS adaptation process. + "generalize": True or False, # Optional. Set to true in order to generalize the imported image. The generalization process enables co-existence of multiple VMs created from the same image. For Windows, generalizing the image removes computer-specific information such as installed drivers and the computer security identifier (SID). + "licenseType": "A String", # Optional. Choose which type of license to apply to the imported image. + }, + "serviceAccount": { # Service account to assign to the instance created by the machine image. # Optional. The service account to assign to the instance created by the machine image. + "email": "A String", # Required. The email address of the service account. + "scopes": [ # Optional. The list of scopes to be made available for this service account. + "A String", + ], + }, + "shieldedInstanceConfig": { # Shielded instance configuration. # Optional. Shielded instance configuration. + "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance created by the machine image has integrity monitoring enabled. This can be set to true only if the image boot option is EFI, and vTPM is enabled. + "enableVtpm": True or False, # Optional. Defines whether the instance created by the machine image has vTPM enabled. This can be set to true only if the image boot option is EFI. + "secureBoot": "A String", # Optional. Defines whether the instance created by the machine image has Secure Boot enabled. This can be set to true only if the image boot option is EFI. + }, + "singleRegionStorage": True or False, # Optional. Set to true to set the machine image storageLocations to the single region of the import job. When false, the closest multi-region is selected. + "skipOsAdaptation": { # Mentions that the machine image import is not using OS adaptation process. # Optional. Use to skip OS adaptation process. + }, + "tags": [ # Optional. The tags to apply to the instance created by the machine image. + "A String", + ], + "targetProject": "A String", # Required. Reference to the TargetProject resource that represents the target project in which the imported machine image will be created. + }, "name": "A String", # Output only. The resource path of the ImageImportJob. "state": "A String", # Output only. The state of the image import. "steps": [ # Output only. The image import steps list representing its progress. @@ -289,6 +336,53 @@

Method Details

"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. }, ], + "machineImageTargetDetails": { # The target details of the machine image resource that will be created by the image import job. # Output only. Target details used to import a machine image. + "additionalLicenses": [ # Optional. Additional licenses to assign to the instance created by the machine image. Format: https://www.googleapis.com/compute/v1/projects/PROJECT_ID/global/licenses/LICENSE_NAME Or https://www.googleapis.com/compute/beta/projects/PROJECT_ID/global/licenses/LICENSE_NAME + "A String", + ], + "description": "A String", # Optional. An optional description of the machine image. + "encryption": { # Encryption message describes the details of the applied encryption. # Immutable. The encryption to apply to the machine image. + "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. + }, + "labels": { # Optional. The labels to apply to the instance created by the machine image. + "a_key": "A String", + }, + "machineImageName": "A String", # Required. The name of the machine image to be created. + "machineImageParametersOverrides": { # Parameters overriding decisions based on the source machine image configurations. # Optional. Parameters overriding decisions based on the source machine image configurations. + "machineType": "A String", # Optional. The machine type to create the MachineImage with. If empty, the service will choose a relevant machine type based on the information from the source image. For more information about machine types, please refer to https://cloud.google.com/compute/docs/machine-resource. + }, + "networkInterfaces": [ # Optional. The network interfaces to create with the instance created by the machine image. Internal and external IP addresses are ignored for machine image import. + { # NetworkInterface represents a NIC of a VM. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + }, + ], + "osAdaptationParameters": { # Parameters affecting the OS adaptation process. # Optional. Use to set the parameters relevant for the OS adaptation process. + "generalize": True or False, # Optional. Set to true in order to generalize the imported image. The generalization process enables co-existence of multiple VMs created from the same image. For Windows, generalizing the image removes computer-specific information such as installed drivers and the computer security identifier (SID). + "licenseType": "A String", # Optional. Choose which type of license to apply to the imported image. + }, + "serviceAccount": { # Service account to assign to the instance created by the machine image. # Optional. The service account to assign to the instance created by the machine image. + "email": "A String", # Required. The email address of the service account. + "scopes": [ # Optional. The list of scopes to be made available for this service account. + "A String", + ], + }, + "shieldedInstanceConfig": { # Shielded instance configuration. # Optional. Shielded instance configuration. + "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance created by the machine image has integrity monitoring enabled. This can be set to true only if the image boot option is EFI, and vTPM is enabled. + "enableVtpm": True or False, # Optional. Defines whether the instance created by the machine image has vTPM enabled. This can be set to true only if the image boot option is EFI. + "secureBoot": "A String", # Optional. Defines whether the instance created by the machine image has Secure Boot enabled. This can be set to true only if the image boot option is EFI. + }, + "singleRegionStorage": True or False, # Optional. Set to true to set the machine image storageLocations to the single region of the import job. When false, the closest multi-region is selected. + "skipOsAdaptation": { # Mentions that the machine image import is not using OS adaptation process. # Optional. Use to skip OS adaptation process. + }, + "tags": [ # Optional. The tags to apply to the instance created by the machine image. + "A String", + ], + "targetProject": "A String", # Required. Reference to the TargetProject resource that represents the target project in which the imported machine image will be created. + }, "name": "A String", # Output only. The resource path of the ImageImportJob. "state": "A String", # Output only. The state of the image import. "steps": [ # Output only. The image import steps list representing its progress. diff --git a/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.cloneJobs.html b/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.cloneJobs.html index 7ab21ae760c..1edd4ae2b95 100644 --- a/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.cloneJobs.html +++ b/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.cloneJobs.html @@ -205,6 +205,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -257,6 +258,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -336,6 +338,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -453,6 +456,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -505,6 +509,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -584,6 +589,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -677,6 +683,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -729,6 +736,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -808,6 +816,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], diff --git a/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.cutoverJobs.html b/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.cutoverJobs.html index e85ec57d634..2f6a4a3ad2e 100644 --- a/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.cutoverJobs.html +++ b/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.cutoverJobs.html @@ -205,6 +205,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -257,6 +258,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -449,6 +451,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -566,6 +569,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -618,6 +622,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -810,6 +815,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -903,6 +909,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -955,6 +962,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -1147,6 +1155,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], diff --git a/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.html b/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.html index 753aa2c294b..f504a96590a 100644 --- a/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.html +++ b/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.html @@ -239,6 +239,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -294,6 +295,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -346,6 +348,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -554,6 +557,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -606,6 +610,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -685,6 +690,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -758,6 +764,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -810,6 +817,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -1002,6 +1010,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -1060,6 +1069,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -1321,6 +1331,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -1376,6 +1387,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -1428,6 +1440,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -1636,6 +1649,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -1688,6 +1702,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -1767,6 +1782,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -1840,6 +1856,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -1892,6 +1909,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -2084,6 +2102,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -2142,6 +2161,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -2303,6 +2323,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -2358,6 +2379,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -2410,6 +2432,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -2618,6 +2641,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -2670,6 +2694,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -2749,6 +2774,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -2822,6 +2848,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -2874,6 +2901,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -3066,6 +3094,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -3124,6 +3153,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -3289,6 +3319,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -3344,6 +3375,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -3396,6 +3428,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -3604,6 +3637,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -3656,6 +3690,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -3735,6 +3770,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -3808,6 +3844,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -3860,6 +3897,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -4052,6 +4090,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -4110,6 +4149,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. + "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], diff --git a/docs/dyn/walletobjects_v1.eventticketobject.html b/docs/dyn/walletobjects_v1.eventticketobject.html index 99da6f8eac9..80a8e2d75b5 100644 --- a/docs/dyn/walletobjects_v1.eventticketobject.html +++ b/docs/dyn/walletobjects_v1.eventticketobject.html @@ -1812,6 +1812,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "seatInfo": { # Seating details for this ticket. "gate": { # The gate the ticket holder should enter to get to their seat, such as "A" or "West". This field is localizable so you may translate words or use different alphabets for the characters in an identifier. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -3610,6 +3613,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "seatInfo": { # Seating details for this ticket. "gate": { # The gate the ticket holder should enter to get to their seat, such as "A" or "West". This field is localizable so you may translate words or use different alphabets for the characters in an identifier. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -5396,6 +5402,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "seatInfo": { # Seating details for this ticket. "gate": { # The gate the ticket holder should enter to get to their seat, such as "A" or "West". This field is localizable so you may translate words or use different alphabets for the characters in an identifier. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -7181,6 +7190,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "seatInfo": { # Seating details for this ticket. "gate": { # The gate the ticket holder should enter to get to their seat, such as "A" or "West". This field is localizable so you may translate words or use different alphabets for the characters in an identifier. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -8982,6 +8994,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "seatInfo": { # Seating details for this ticket. "gate": { # The gate the ticket holder should enter to get to their seat, such as "A" or "West". This field is localizable so you may translate words or use different alphabets for the characters in an identifier. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -10790,6 +10805,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "seatInfo": { # Seating details for this ticket. "gate": { # The gate the ticket holder should enter to get to their seat, such as "A" or "West". This field is localizable so you may translate words or use different alphabets for the characters in an identifier. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -12577,6 +12595,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "seatInfo": { # Seating details for this ticket. "gate": { # The gate the ticket holder should enter to get to their seat, such as "A" or "West". This field is localizable so you may translate words or use different alphabets for the characters in an identifier. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -14362,6 +14383,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "seatInfo": { # Seating details for this ticket. "gate": { # The gate the ticket holder should enter to get to their seat, such as "A" or "West". This field is localizable so you may translate words or use different alphabets for the characters in an identifier. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -16149,6 +16173,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "seatInfo": { # Seating details for this ticket. "gate": { # The gate the ticket holder should enter to get to their seat, such as "A" or "West". This field is localizable so you may translate words or use different alphabets for the characters in an identifier. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -17934,6 +17961,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "seatInfo": { # Seating details for this ticket. "gate": { # The gate the ticket holder should enter to get to their seat, such as "A" or "West". This field is localizable so you may translate words or use different alphabets for the characters in an identifier. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. diff --git a/docs/dyn/walletobjects_v1.flightclass.html b/docs/dyn/walletobjects_v1.flightclass.html index dfdf83c6766..faa9a88e6c4 100644 --- a/docs/dyn/walletobjects_v1.flightclass.html +++ b/docs/dyn/walletobjects_v1.flightclass.html @@ -1134,11 +1134,11 @@

Method Details

}, ], }, - "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. + "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. + "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. + "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. - "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. + "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -2312,11 +2312,11 @@

Method Details

}, ], }, - "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. + "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. + "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. + "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. - "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. + "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -3478,11 +3478,11 @@

Method Details

}, ], }, - "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. + "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. + "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. + "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. - "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. + "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -4643,11 +4643,11 @@

Method Details

}, ], }, - "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. + "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. + "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. + "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. - "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. + "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -5824,11 +5824,11 @@

Method Details

}, ], }, - "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. + "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. + "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. + "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. - "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. + "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -6993,11 +6993,11 @@

Method Details

}, ], }, - "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. + "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. + "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. + "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. - "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. + "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -8158,11 +8158,11 @@

Method Details

}, ], }, - "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. + "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. + "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. + "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. - "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. + "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -9325,11 +9325,11 @@

Method Details

}, ], }, - "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. + "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. + "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. + "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. - "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. + "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -10490,11 +10490,11 @@

Method Details

}, ], }, - "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. + "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. + "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. + "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. - "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. + "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. diff --git a/docs/dyn/walletobjects_v1.flightobject.html b/docs/dyn/walletobjects_v1.flightobject.html index 8753e11d6f8..07cde39ef7f 100644 --- a/docs/dyn/walletobjects_v1.flightobject.html +++ b/docs/dyn/walletobjects_v1.flightobject.html @@ -1500,11 +1500,11 @@

Method Details

}, ], }, - "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. + "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. + "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. + "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. - "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. + "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -1966,6 +1966,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "securityProgramLogo": { # Wrapping type for Google hosted images. Next ID: 7 # An image for the security program that applies to the passenger. "contentDescription": { # Description of the image used for accessibility. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -3412,11 +3415,11 @@

Method Details

}, ], }, - "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. + "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. + "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. + "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. - "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. + "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -3878,6 +3881,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "securityProgramLogo": { # Wrapping type for Google hosted images. Next ID: 7 # An image for the security program that applies to the passenger. "contentDescription": { # Description of the image used for accessibility. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -5312,11 +5318,11 @@

Method Details

}, ], }, - "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. + "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. + "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. + "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. - "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. + "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -5778,6 +5784,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "securityProgramLogo": { # Wrapping type for Google hosted images. Next ID: 7 # An image for the security program that applies to the passenger. "contentDescription": { # Description of the image used for accessibility. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -7211,11 +7220,11 @@

Method Details

}, ], }, - "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. + "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. + "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. + "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. - "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. + "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -7677,6 +7686,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "securityProgramLogo": { # Wrapping type for Google hosted images. Next ID: 7 # An image for the security program that applies to the passenger. "contentDescription": { # Description of the image used for accessibility. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -9126,11 +9138,11 @@

Method Details

}, ], }, - "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. + "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. + "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. + "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. - "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. + "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -9592,6 +9604,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "securityProgramLogo": { # Wrapping type for Google hosted images. Next ID: 7 # An image for the security program that applies to the passenger. "contentDescription": { # Description of the image used for accessibility. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -11029,11 +11044,11 @@

Method Details

}, ], }, - "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. + "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. + "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. + "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. - "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. + "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -11495,6 +11510,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "securityProgramLogo": { # Wrapping type for Google hosted images. Next ID: 7 # An image for the security program that applies to the passenger. "contentDescription": { # Description of the image used for accessibility. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -12928,11 +12946,11 @@

Method Details

}, ], }, - "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. + "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. + "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. + "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. - "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. + "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -13394,6 +13412,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "securityProgramLogo": { # Wrapping type for Google hosted images. Next ID: 7 # An image for the security program that applies to the passenger. "contentDescription": { # Description of the image used for accessibility. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -14829,11 +14850,11 @@

Method Details

}, ], }, - "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. + "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. + "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. + "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. - "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. + "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -15295,6 +15316,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "securityProgramLogo": { # Wrapping type for Google hosted images. Next ID: 7 # An image for the security program that applies to the passenger. "contentDescription": { # Description of the image used for accessibility. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -16728,11 +16752,11 @@

Method Details

}, ], }, - "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. + "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. + "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. + "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. - "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. + "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -17194,6 +17218,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "securityProgramLogo": { # Wrapping type for Google hosted images. Next ID: 7 # An image for the security program that applies to the passenger. "contentDescription": { # Description of the image used for accessibility. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. diff --git a/docs/dyn/walletobjects_v1.genericobject.html b/docs/dyn/walletobjects_v1.genericobject.html index 1b831bc55df..4f0408b701f 100644 --- a/docs/dyn/walletobjects_v1.genericobject.html +++ b/docs/dyn/walletobjects_v1.genericobject.html @@ -699,6 +699,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. If this is not provided, the object would be considered `ACTIVE`. "subheader": { # The title label of the pass, such as location where this pass can be used. Appears right above the title in the title row in the pass detail view. @@ -1358,6 +1361,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. If this is not provided, the object would be considered `ACTIVE`. "subheader": { # The title label of the pass, such as location where this pass can be used. Appears right above the title in the title row in the pass detail view. @@ -2005,6 +2011,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. If this is not provided, the object would be considered `ACTIVE`. "subheader": { # The title label of the pass, such as location where this pass can be used. Appears right above the title in the title row in the pass detail view. @@ -2651,6 +2660,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. If this is not provided, the object would be considered `ACTIVE`. "subheader": { # The title label of the pass, such as location where this pass can be used. Appears right above the title in the title row in the pass detail view. @@ -3313,6 +3325,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. If this is not provided, the object would be considered `ACTIVE`. "subheader": { # The title label of the pass, such as location where this pass can be used. Appears right above the title in the title row in the pass detail view. @@ -3963,6 +3978,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. If this is not provided, the object would be considered `ACTIVE`. "subheader": { # The title label of the pass, such as location where this pass can be used. Appears right above the title in the title row in the pass detail view. @@ -4609,6 +4627,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. If this is not provided, the object would be considered `ACTIVE`. "subheader": { # The title label of the pass, such as location where this pass can be used. Appears right above the title in the title row in the pass detail view. @@ -5257,6 +5278,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. If this is not provided, the object would be considered `ACTIVE`. "subheader": { # The title label of the pass, such as location where this pass can be used. Appears right above the title in the title row in the pass detail view. @@ -5903,6 +5927,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. If this is not provided, the object would be considered `ACTIVE`. "subheader": { # The title label of the pass, such as location where this pass can be used. Appears right above the title in the title row in the pass detail view. diff --git a/docs/dyn/walletobjects_v1.giftcardobject.html b/docs/dyn/walletobjects_v1.giftcardobject.html index a53123b8a94..28a737590d7 100644 --- a/docs/dyn/walletobjects_v1.giftcardobject.html +++ b/docs/dyn/walletobjects_v1.giftcardobject.html @@ -1706,6 +1706,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class. @@ -3321,6 +3324,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class. @@ -4924,6 +4930,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class. @@ -6526,6 +6535,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class. @@ -8144,6 +8156,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class. @@ -9750,6 +9765,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class. @@ -11352,6 +11370,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class. @@ -12956,6 +12977,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class. @@ -14558,6 +14582,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class. diff --git a/docs/dyn/walletobjects_v1.jwt.html b/docs/dyn/walletobjects_v1.jwt.html index 6c10eed619e..024552cf10c 100644 --- a/docs/dyn/walletobjects_v1.jwt.html +++ b/docs/dyn/walletobjects_v1.jwt.html @@ -2830,6 +2830,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "seatInfo": { # Seating details for this ticket. "gate": { # The gate the ticket holder should enter to get to their seat, such as "A" or "West". This field is localizable so you may translate words or use different alphabets for the characters in an identifier. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -3933,11 +3936,11 @@

Method Details

}, ], }, - "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. + "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. + "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. + "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. - "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. + "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -5457,11 +5460,11 @@

Method Details

}, ], }, - "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. + "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. + "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. + "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. - "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. + "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -5923,6 +5926,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "securityProgramLogo": { # Wrapping type for Google hosted images. Next ID: 7 # An image for the security program that applies to the passenger. "contentDescription": { # Description of the image used for accessibility. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -7213,6 +7219,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. If this is not provided, the object would be considered `ACTIVE`. "subheader": { # The title label of the pass, such as location where this pass can be used. Appears right above the title in the title row in the pass detail view. @@ -9833,6 +9842,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class. @@ -12622,6 +12634,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "secondaryLoyaltyPoints": { # The secondary loyalty reward points label, balance, and type. Shown in addition to the primary loyalty points. "balance": { # The account holder's loyalty point balance, such as "500" or "$10.00". Recommended maximum length is 7 characters. This is a required field of `loyaltyPoints` and `secondaryLoyaltyPoints`. "double": 3.14, # The double form of a balance. Only one of these subtypes (string, int, double, money) should be populated. @@ -15282,6 +15297,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class. @@ -18468,6 +18486,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class. diff --git a/docs/dyn/walletobjects_v1.loyaltyobject.html b/docs/dyn/walletobjects_v1.loyaltyobject.html index aba265b5452..5361bf69441 100644 --- a/docs/dyn/walletobjects_v1.loyaltyobject.html +++ b/docs/dyn/walletobjects_v1.loyaltyobject.html @@ -1830,6 +1830,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "secondaryLoyaltyPoints": { # The secondary loyalty reward points label, balance, and type. Shown in addition to the primary loyalty points. "balance": { # The account holder's loyalty point balance, such as "500" or "$10.00". Recommended maximum length is 7 characters. This is a required field of `loyaltyPoints` and `secondaryLoyaltyPoints`. "double": 3.14, # The double form of a balance. Only one of these subtypes (string, int, double, money) should be populated. @@ -3594,6 +3597,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "secondaryLoyaltyPoints": { # The secondary loyalty reward points label, balance, and type. Shown in addition to the primary loyalty points. "balance": { # The account holder's loyalty point balance, such as "500" or "$10.00". Recommended maximum length is 7 characters. This is a required field of `loyaltyPoints` and `secondaryLoyaltyPoints`. "double": 3.14, # The double form of a balance. Only one of these subtypes (string, int, double, money) should be populated. @@ -5346,6 +5352,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "secondaryLoyaltyPoints": { # The secondary loyalty reward points label, balance, and type. Shown in addition to the primary loyalty points. "balance": { # The account holder's loyalty point balance, such as "500" or "$10.00". Recommended maximum length is 7 characters. This is a required field of `loyaltyPoints` and `secondaryLoyaltyPoints`. "double": 3.14, # The double form of a balance. Only one of these subtypes (string, int, double, money) should be populated. @@ -7097,6 +7106,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "secondaryLoyaltyPoints": { # The secondary loyalty reward points label, balance, and type. Shown in addition to the primary loyalty points. "balance": { # The account holder's loyalty point balance, such as "500" or "$10.00". Recommended maximum length is 7 characters. This is a required field of `loyaltyPoints` and `secondaryLoyaltyPoints`. "double": 3.14, # The double form of a balance. Only one of these subtypes (string, int, double, money) should be populated. @@ -8864,6 +8876,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "secondaryLoyaltyPoints": { # The secondary loyalty reward points label, balance, and type. Shown in addition to the primary loyalty points. "balance": { # The account holder's loyalty point balance, such as "500" or "$10.00". Recommended maximum length is 7 characters. This is a required field of `loyaltyPoints` and `secondaryLoyaltyPoints`. "double": 3.14, # The double form of a balance. Only one of these subtypes (string, int, double, money) should be populated. @@ -10638,6 +10653,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "secondaryLoyaltyPoints": { # The secondary loyalty reward points label, balance, and type. Shown in addition to the primary loyalty points. "balance": { # The account holder's loyalty point balance, such as "500" or "$10.00". Recommended maximum length is 7 characters. This is a required field of `loyaltyPoints` and `secondaryLoyaltyPoints`. "double": 3.14, # The double form of a balance. Only one of these subtypes (string, int, double, money) should be populated. @@ -12391,6 +12409,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "secondaryLoyaltyPoints": { # The secondary loyalty reward points label, balance, and type. Shown in addition to the primary loyalty points. "balance": { # The account holder's loyalty point balance, such as "500" or "$10.00". Recommended maximum length is 7 characters. This is a required field of `loyaltyPoints` and `secondaryLoyaltyPoints`. "double": 3.14, # The double form of a balance. Only one of these subtypes (string, int, double, money) should be populated. @@ -14142,6 +14163,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "secondaryLoyaltyPoints": { # The secondary loyalty reward points label, balance, and type. Shown in addition to the primary loyalty points. "balance": { # The account holder's loyalty point balance, such as "500" or "$10.00". Recommended maximum length is 7 characters. This is a required field of `loyaltyPoints` and `secondaryLoyaltyPoints`. "double": 3.14, # The double form of a balance. Only one of these subtypes (string, int, double, money) should be populated. @@ -15895,6 +15919,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "secondaryLoyaltyPoints": { # The secondary loyalty reward points label, balance, and type. Shown in addition to the primary loyalty points. "balance": { # The account holder's loyalty point balance, such as "500" or "$10.00". Recommended maximum length is 7 characters. This is a required field of `loyaltyPoints` and `secondaryLoyaltyPoints`. "double": 3.14, # The double form of a balance. Only one of these subtypes (string, int, double, money) should be populated. @@ -17646,6 +17673,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "secondaryLoyaltyPoints": { # The secondary loyalty reward points label, balance, and type. Shown in addition to the primary loyalty points. "balance": { # The account holder's loyalty point balance, such as "500" or "$10.00". Recommended maximum length is 7 characters. This is a required field of `loyaltyPoints` and `secondaryLoyaltyPoints`. "double": 3.14, # The double form of a balance. Only one of these subtypes (string, int, double, money) should be populated. diff --git a/docs/dyn/walletobjects_v1.offerobject.html b/docs/dyn/walletobjects_v1.offerobject.html index fb9ee8718bd..f9dc2a2695e 100644 --- a/docs/dyn/walletobjects_v1.offerobject.html +++ b/docs/dyn/walletobjects_v1.offerobject.html @@ -1732,6 +1732,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class. @@ -3373,6 +3376,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class. @@ -5002,6 +5008,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class. @@ -6630,6 +6639,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class. @@ -8274,6 +8286,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class. @@ -9906,6 +9921,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class. @@ -11534,6 +11552,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class. @@ -13164,6 +13185,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class. @@ -14792,6 +14816,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class. diff --git a/docs/dyn/walletobjects_v1.transitobject.html b/docs/dyn/walletobjects_v1.transitobject.html index bb770720411..8fcd15db34b 100644 --- a/docs/dyn/walletobjects_v1.transitobject.html +++ b/docs/dyn/walletobjects_v1.transitobject.html @@ -2045,6 +2045,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class. @@ -4379,6 +4382,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class. @@ -6701,6 +6707,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class. @@ -9022,6 +9031,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class. @@ -11359,6 +11371,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class. @@ -13684,6 +13699,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class. @@ -16005,6 +16023,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class. @@ -18328,6 +18349,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class. @@ -20649,6 +20673,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class. diff --git a/docs/dyn/workflowexecutions_v1.projects.locations.workflows.executions.html b/docs/dyn/workflowexecutions_v1.projects.locations.workflows.executions.html index f9282d0411d..b240fc117e2 100644 --- a/docs/dyn/workflowexecutions_v1.projects.locations.workflows.executions.html +++ b/docs/dyn/workflowexecutions_v1.projects.locations.workflows.executions.html @@ -150,6 +150,7 @@

Method Details

], }, }, + "executionHistoryLevel": "A String", # Optional. Describes the level of the execution history feature to apply to this execution. If not specified, the level of the execution history feature will be determined by its workflow's execution history level. If the value is different from its workflow's value, it will override the workflow's execution history level for this exeuction. "labels": { # Labels associated with this execution. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, and dashes. Label keys must start with a letter. International characters are allowed. By default, labels are inherited from the workflow but are overridden by any labels associated with the execution. "a_key": "A String", }, @@ -211,6 +212,7 @@

Method Details

], }, }, + "executionHistoryLevel": "A String", # Optional. Describes the level of the execution history feature to apply to this execution. If not specified, the level of the execution history feature will be determined by its workflow's execution history level. If the value is different from its workflow's value, it will override the workflow's execution history level for this exeuction. "labels": { # Labels associated with this execution. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, and dashes. Label keys must start with a letter. International characters are allowed. By default, labels are inherited from the workflow but are overridden by any labels associated with the execution. "a_key": "A String", }, @@ -265,6 +267,7 @@

Method Details

], }, }, + "executionHistoryLevel": "A String", # Optional. Describes the level of the execution history feature to apply to this execution. If not specified, the level of the execution history feature will be determined by its workflow's execution history level. If the value is different from its workflow's value, it will override the workflow's execution history level for this exeuction. "labels": { # Labels associated with this execution. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, and dashes. Label keys must start with a letter. International characters are allowed. By default, labels are inherited from the workflow but are overridden by any labels associated with the execution. "a_key": "A String", }, @@ -350,6 +353,7 @@

Method Details

], }, }, + "executionHistoryLevel": "A String", # Optional. Describes the level of the execution history feature to apply to this execution. If not specified, the level of the execution history feature will be determined by its workflow's execution history level. If the value is different from its workflow's value, it will override the workflow's execution history level for this exeuction. "labels": { # Labels associated with this execution. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, and dashes. Label keys must start with a letter. International characters are allowed. By default, labels are inherited from the workflow but are overridden by any labels associated with the execution. "a_key": "A String", }, @@ -422,6 +426,7 @@

Method Details

], }, }, + "executionHistoryLevel": "A String", # Optional. Describes the level of the execution history feature to apply to this execution. If not specified, the level of the execution history feature will be determined by its workflow's execution history level. If the value is different from its workflow's value, it will override the workflow's execution history level for this exeuction. "labels": { # Labels associated with this execution. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, and dashes. Label keys must start with a letter. International characters are allowed. By default, labels are inherited from the workflow but are overridden by any labels associated with the execution. "a_key": "A String", }, diff --git a/docs/dyn/workflowexecutions_v1.projects.locations.workflows.html b/docs/dyn/workflowexecutions_v1.projects.locations.workflows.html index 907d7fa3fbe..cfe73c5edd7 100644 --- a/docs/dyn/workflowexecutions_v1.projects.locations.workflows.html +++ b/docs/dyn/workflowexecutions_v1.projects.locations.workflows.html @@ -147,6 +147,7 @@

Method Details

], }, }, + "executionHistoryLevel": "A String", # Optional. Describes the level of the execution history feature to apply to this execution. If not specified, the level of the execution history feature will be determined by its workflow's execution history level. If the value is different from its workflow's value, it will override the workflow's execution history level for this exeuction. "labels": { # Labels associated with this execution. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, and dashes. Label keys must start with a letter. International characters are allowed. By default, labels are inherited from the workflow but are overridden by any labels associated with the execution. "a_key": "A String", }, diff --git a/docs/dyn/workflows_v1.projects.locations.workflows.html b/docs/dyn/workflows_v1.projects.locations.workflows.html index f3a998dc9f4..d6f2c3f3768 100644 --- a/docs/dyn/workflows_v1.projects.locations.workflows.html +++ b/docs/dyn/workflows_v1.projects.locations.workflows.html @@ -116,7 +116,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # Workflow program to be executed by Workflows. +{ # LINT.IfChange Workflow program to be executed by Workflows. "allKmsKeys": [ # Output only. A list of all KMS crypto keys used to encrypt or decrypt the data associated with the workflow. "A String", ], @@ -227,7 +227,7 @@

Method Details

Returns: An object of the form: - { # Workflow program to be executed by Workflows. + { # LINT.IfChange Workflow program to be executed by Workflows. "allKmsKeys": [ # Output only. A list of all KMS crypto keys used to encrypt or decrypt the data associated with the workflow. "A String", ], @@ -283,7 +283,7 @@

Method Details

"A String", ], "workflows": [ # The workflows that match the request. - { # Workflow program to be executed by Workflows. + { # LINT.IfChange Workflow program to be executed by Workflows. "allKmsKeys": [ # Output only. A list of all KMS crypto keys used to encrypt or decrypt the data associated with the workflow. "A String", ], @@ -336,7 +336,7 @@

Method Details

{ # Response for the ListWorkflowRevisions method. "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. "workflows": [ # The revisions of the workflow, ordered in reverse chronological order. - { # Workflow program to be executed by Workflows. + { # LINT.IfChange Workflow program to be executed by Workflows. "allKmsKeys": [ # Output only. A list of all KMS crypto keys used to encrypt or decrypt the data associated with the workflow. "A String", ], @@ -407,7 +407,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # Workflow program to be executed by Workflows. +{ # LINT.IfChange Workflow program to be executed by Workflows. "allKmsKeys": [ # Output only. A list of all KMS crypto keys used to encrypt or decrypt the data associated with the workflow. "A String", ], diff --git a/docs/dyn/workstations_v1.projects.locations.workstationClusters.workstationConfigs.html b/docs/dyn/workstations_v1.projects.locations.workstationClusters.workstationConfigs.html index 61da7cce064..de121e9bbf8 100644 --- a/docs/dyn/workstations_v1.projects.locations.workstationClusters.workstationConfigs.html +++ b/docs/dyn/workstations_v1.projects.locations.workstationClusters.workstationConfigs.html @@ -170,7 +170,7 @@

Method Details

"deleteTime": "A String", # Output only. Time when this workstation configuration was soft-deleted. "disableTcpConnections": True or False, # Optional. Disables support for plain TCP connections in the workstation. By default the service supports TCP connections through a websocket relay. Setting this option to true disables that relay, which prevents the usage of services that require plain TCP connections, such as SSH. When enabled, all communication must occur over HTTPS or WSS. "displayName": "A String", # Optional. Human-readable name for this workstation configuration. - "enableAuditAgent": True or False, # Optional. Whether to enable Linux `auditd` logging on the workstation. When enabled, a service account must also be specified that has `logging.buckets.write` permission on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging). + "enableAuditAgent": True or False, # Optional. Whether to enable Linux `auditd` logging on the workstation. When enabled, a service_account must also be specified that has `roles/logging.logWriter` and `roles/monitoring.metricWriter` on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging) and [Container output logging](http://cloud/workstations/docs/container-output-logging#overview). Operating system audit logs are available in the [Cloud Logging](https://cloud.google.com/logging/docs) console by querying: resource.type="gce_instance" log_name:"/logs/linux-auditd" "encryptionKey": { # A customer-managed encryption key (CMEK) for the Compute Engine resources of the associated workstation configuration. Specify the name of your Cloud KMS encryption key and the default service account. We recommend that you use a separate service account and follow [Cloud KMS best practices](https://cloud.google.com/kms/docs/separation-of-duties). # Immutable. Encrypts resources of this workstation configuration using a customer-managed encryption key (CMEK). If specified, the boot disk of the Compute Engine instance and the persistent disk are encrypted using this encryption key. If this field is not set, the disks are encrypted using a generated key. Customer-managed encryption keys do not protect disk metadata. If the customer-managed encryption key is rotated, when the workstation instance is stopped, the system attempts to recreate the persistent disk with the new version of the key. Be sure to keep older versions of the key until the persistent disk is recreated. Otherwise, data on the persistent disk might be lost. If the encryption key is revoked, the workstation session automatically stops within 7 hours. Immutable after the workstation configuration is created. "kmsKey": "A String", # Immutable. The name of the Google Cloud KMS encryption key. For example, `"projects/PROJECT_ID/locations/REGION/keyRings/KEY_RING/cryptoKeys/KEY_NAME"`. The key must be in the same region as the workstation configuration. "kmsKeyServiceAccount": "A String", # Immutable. The service account to use with the specified KMS key. We recommend that you use a separate service account and follow KMS best practices. For more information, see [Separation of duties](https://cloud.google.com/kms/docs/separation-of-duties) and `gcloud kms keys add-iam-policy-binding` [`--member`](https://cloud.google.com/sdk/gcloud/reference/kms/keys/add-iam-policy-binding#--member). @@ -201,7 +201,7 @@

Method Details

}, "disablePublicIpAddresses": True or False, # Optional. When set to true, disables public IP addresses for VMs. If you disable public IP addresses, you must set up Private Google Access or Cloud NAT on your network. If you use Private Google Access and you use `private.googleapis.com` or `restricted.googleapis.com` for Container Registry and Artifact Registry, make sure that you set up DNS records for domains `*.gcr.io` and `*.pkg.dev`. Defaults to false (VMs have public IP addresses). "disableSsh": True or False, # Optional. Whether to disable SSH access to the VM. - "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. * **GPUs**: nested virtualization may not be enabled on workstation configurations with accelerators. * **Operating System**: because [Container-Optimized OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos) does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) image. + "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Defaults to false. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. "machineType": "A String", # Optional. The type of machine to use for VM instances—for example, `"e2-standard-4"`. For more information about machine types that Cloud Workstations supports, see the list of [available machine types](https://cloud.google.com/workstations/docs/available-machine-types). "poolSize": 42, # Optional. The number of VMs that the system should keep idle so that new workstations can be started quickly for new users. Defaults to `0` in the API. "pooledInstances": 42, # Output only. Number of instances currently available in the pool for faster workstation startup. @@ -377,7 +377,7 @@

Method Details

"deleteTime": "A String", # Output only. Time when this workstation configuration was soft-deleted. "disableTcpConnections": True or False, # Optional. Disables support for plain TCP connections in the workstation. By default the service supports TCP connections through a websocket relay. Setting this option to true disables that relay, which prevents the usage of services that require plain TCP connections, such as SSH. When enabled, all communication must occur over HTTPS or WSS. "displayName": "A String", # Optional. Human-readable name for this workstation configuration. - "enableAuditAgent": True or False, # Optional. Whether to enable Linux `auditd` logging on the workstation. When enabled, a service account must also be specified that has `logging.buckets.write` permission on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging). + "enableAuditAgent": True or False, # Optional. Whether to enable Linux `auditd` logging on the workstation. When enabled, a service_account must also be specified that has `roles/logging.logWriter` and `roles/monitoring.metricWriter` on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging) and [Container output logging](http://cloud/workstations/docs/container-output-logging#overview). Operating system audit logs are available in the [Cloud Logging](https://cloud.google.com/logging/docs) console by querying: resource.type="gce_instance" log_name:"/logs/linux-auditd" "encryptionKey": { # A customer-managed encryption key (CMEK) for the Compute Engine resources of the associated workstation configuration. Specify the name of your Cloud KMS encryption key and the default service account. We recommend that you use a separate service account and follow [Cloud KMS best practices](https://cloud.google.com/kms/docs/separation-of-duties). # Immutable. Encrypts resources of this workstation configuration using a customer-managed encryption key (CMEK). If specified, the boot disk of the Compute Engine instance and the persistent disk are encrypted using this encryption key. If this field is not set, the disks are encrypted using a generated key. Customer-managed encryption keys do not protect disk metadata. If the customer-managed encryption key is rotated, when the workstation instance is stopped, the system attempts to recreate the persistent disk with the new version of the key. Be sure to keep older versions of the key until the persistent disk is recreated. Otherwise, data on the persistent disk might be lost. If the encryption key is revoked, the workstation session automatically stops within 7 hours. Immutable after the workstation configuration is created. "kmsKey": "A String", # Immutable. The name of the Google Cloud KMS encryption key. For example, `"projects/PROJECT_ID/locations/REGION/keyRings/KEY_RING/cryptoKeys/KEY_NAME"`. The key must be in the same region as the workstation configuration. "kmsKeyServiceAccount": "A String", # Immutable. The service account to use with the specified KMS key. We recommend that you use a separate service account and follow KMS best practices. For more information, see [Separation of duties](https://cloud.google.com/kms/docs/separation-of-duties) and `gcloud kms keys add-iam-policy-binding` [`--member`](https://cloud.google.com/sdk/gcloud/reference/kms/keys/add-iam-policy-binding#--member). @@ -408,7 +408,7 @@

Method Details

}, "disablePublicIpAddresses": True or False, # Optional. When set to true, disables public IP addresses for VMs. If you disable public IP addresses, you must set up Private Google Access or Cloud NAT on your network. If you use Private Google Access and you use `private.googleapis.com` or `restricted.googleapis.com` for Container Registry and Artifact Registry, make sure that you set up DNS records for domains `*.gcr.io` and `*.pkg.dev`. Defaults to false (VMs have public IP addresses). "disableSsh": True or False, # Optional. Whether to disable SSH access to the VM. - "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. * **GPUs**: nested virtualization may not be enabled on workstation configurations with accelerators. * **Operating System**: because [Container-Optimized OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos) does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) image. + "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Defaults to false. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. "machineType": "A String", # Optional. The type of machine to use for VM instances—for example, `"e2-standard-4"`. For more information about machine types that Cloud Workstations supports, see the list of [available machine types](https://cloud.google.com/workstations/docs/available-machine-types). "poolSize": 42, # Optional. The number of VMs that the system should keep idle so that new workstations can be started quickly for new users. Defaults to `0` in the API. "pooledInstances": 42, # Output only. Number of instances currently available in the pool for faster workstation startup. @@ -572,7 +572,7 @@

Method Details

"deleteTime": "A String", # Output only. Time when this workstation configuration was soft-deleted. "disableTcpConnections": True or False, # Optional. Disables support for plain TCP connections in the workstation. By default the service supports TCP connections through a websocket relay. Setting this option to true disables that relay, which prevents the usage of services that require plain TCP connections, such as SSH. When enabled, all communication must occur over HTTPS or WSS. "displayName": "A String", # Optional. Human-readable name for this workstation configuration. - "enableAuditAgent": True or False, # Optional. Whether to enable Linux `auditd` logging on the workstation. When enabled, a service account must also be specified that has `logging.buckets.write` permission on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging). + "enableAuditAgent": True or False, # Optional. Whether to enable Linux `auditd` logging on the workstation. When enabled, a service_account must also be specified that has `roles/logging.logWriter` and `roles/monitoring.metricWriter` on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging) and [Container output logging](http://cloud/workstations/docs/container-output-logging#overview). Operating system audit logs are available in the [Cloud Logging](https://cloud.google.com/logging/docs) console by querying: resource.type="gce_instance" log_name:"/logs/linux-auditd" "encryptionKey": { # A customer-managed encryption key (CMEK) for the Compute Engine resources of the associated workstation configuration. Specify the name of your Cloud KMS encryption key and the default service account. We recommend that you use a separate service account and follow [Cloud KMS best practices](https://cloud.google.com/kms/docs/separation-of-duties). # Immutable. Encrypts resources of this workstation configuration using a customer-managed encryption key (CMEK). If specified, the boot disk of the Compute Engine instance and the persistent disk are encrypted using this encryption key. If this field is not set, the disks are encrypted using a generated key. Customer-managed encryption keys do not protect disk metadata. If the customer-managed encryption key is rotated, when the workstation instance is stopped, the system attempts to recreate the persistent disk with the new version of the key. Be sure to keep older versions of the key until the persistent disk is recreated. Otherwise, data on the persistent disk might be lost. If the encryption key is revoked, the workstation session automatically stops within 7 hours. Immutable after the workstation configuration is created. "kmsKey": "A String", # Immutable. The name of the Google Cloud KMS encryption key. For example, `"projects/PROJECT_ID/locations/REGION/keyRings/KEY_RING/cryptoKeys/KEY_NAME"`. The key must be in the same region as the workstation configuration. "kmsKeyServiceAccount": "A String", # Immutable. The service account to use with the specified KMS key. We recommend that you use a separate service account and follow KMS best practices. For more information, see [Separation of duties](https://cloud.google.com/kms/docs/separation-of-duties) and `gcloud kms keys add-iam-policy-binding` [`--member`](https://cloud.google.com/sdk/gcloud/reference/kms/keys/add-iam-policy-binding#--member). @@ -603,7 +603,7 @@

Method Details

}, "disablePublicIpAddresses": True or False, # Optional. When set to true, disables public IP addresses for VMs. If you disable public IP addresses, you must set up Private Google Access or Cloud NAT on your network. If you use Private Google Access and you use `private.googleapis.com` or `restricted.googleapis.com` for Container Registry and Artifact Registry, make sure that you set up DNS records for domains `*.gcr.io` and `*.pkg.dev`. Defaults to false (VMs have public IP addresses). "disableSsh": True or False, # Optional. Whether to disable SSH access to the VM. - "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. * **GPUs**: nested virtualization may not be enabled on workstation configurations with accelerators. * **Operating System**: because [Container-Optimized OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos) does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) image. + "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Defaults to false. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. "machineType": "A String", # Optional. The type of machine to use for VM instances—for example, `"e2-standard-4"`. For more information about machine types that Cloud Workstations supports, see the list of [available machine types](https://cloud.google.com/workstations/docs/available-machine-types). "poolSize": 42, # Optional. The number of VMs that the system should keep idle so that new workstations can be started quickly for new users. Defaults to `0` in the API. "pooledInstances": 42, # Output only. Number of instances currently available in the pool for faster workstation startup. @@ -721,7 +721,7 @@

Method Details

"deleteTime": "A String", # Output only. Time when this workstation configuration was soft-deleted. "disableTcpConnections": True or False, # Optional. Disables support for plain TCP connections in the workstation. By default the service supports TCP connections through a websocket relay. Setting this option to true disables that relay, which prevents the usage of services that require plain TCP connections, such as SSH. When enabled, all communication must occur over HTTPS or WSS. "displayName": "A String", # Optional. Human-readable name for this workstation configuration. - "enableAuditAgent": True or False, # Optional. Whether to enable Linux `auditd` logging on the workstation. When enabled, a service account must also be specified that has `logging.buckets.write` permission on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging). + "enableAuditAgent": True or False, # Optional. Whether to enable Linux `auditd` logging on the workstation. When enabled, a service_account must also be specified that has `roles/logging.logWriter` and `roles/monitoring.metricWriter` on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging) and [Container output logging](http://cloud/workstations/docs/container-output-logging#overview). Operating system audit logs are available in the [Cloud Logging](https://cloud.google.com/logging/docs) console by querying: resource.type="gce_instance" log_name:"/logs/linux-auditd" "encryptionKey": { # A customer-managed encryption key (CMEK) for the Compute Engine resources of the associated workstation configuration. Specify the name of your Cloud KMS encryption key and the default service account. We recommend that you use a separate service account and follow [Cloud KMS best practices](https://cloud.google.com/kms/docs/separation-of-duties). # Immutable. Encrypts resources of this workstation configuration using a customer-managed encryption key (CMEK). If specified, the boot disk of the Compute Engine instance and the persistent disk are encrypted using this encryption key. If this field is not set, the disks are encrypted using a generated key. Customer-managed encryption keys do not protect disk metadata. If the customer-managed encryption key is rotated, when the workstation instance is stopped, the system attempts to recreate the persistent disk with the new version of the key. Be sure to keep older versions of the key until the persistent disk is recreated. Otherwise, data on the persistent disk might be lost. If the encryption key is revoked, the workstation session automatically stops within 7 hours. Immutable after the workstation configuration is created. "kmsKey": "A String", # Immutable. The name of the Google Cloud KMS encryption key. For example, `"projects/PROJECT_ID/locations/REGION/keyRings/KEY_RING/cryptoKeys/KEY_NAME"`. The key must be in the same region as the workstation configuration. "kmsKeyServiceAccount": "A String", # Immutable. The service account to use with the specified KMS key. We recommend that you use a separate service account and follow KMS best practices. For more information, see [Separation of duties](https://cloud.google.com/kms/docs/separation-of-duties) and `gcloud kms keys add-iam-policy-binding` [`--member`](https://cloud.google.com/sdk/gcloud/reference/kms/keys/add-iam-policy-binding#--member). @@ -752,7 +752,7 @@

Method Details

}, "disablePublicIpAddresses": True or False, # Optional. When set to true, disables public IP addresses for VMs. If you disable public IP addresses, you must set up Private Google Access or Cloud NAT on your network. If you use Private Google Access and you use `private.googleapis.com` or `restricted.googleapis.com` for Container Registry and Artifact Registry, make sure that you set up DNS records for domains `*.gcr.io` and `*.pkg.dev`. Defaults to false (VMs have public IP addresses). "disableSsh": True or False, # Optional. Whether to disable SSH access to the VM. - "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. * **GPUs**: nested virtualization may not be enabled on workstation configurations with accelerators. * **Operating System**: because [Container-Optimized OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos) does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) image. + "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Defaults to false. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. "machineType": "A String", # Optional. The type of machine to use for VM instances—for example, `"e2-standard-4"`. For more information about machine types that Cloud Workstations supports, see the list of [available machine types](https://cloud.google.com/workstations/docs/available-machine-types). "poolSize": 42, # Optional. The number of VMs that the system should keep idle so that new workstations can be started quickly for new users. Defaults to `0` in the API. "pooledInstances": 42, # Output only. Number of instances currently available in the pool for faster workstation startup. @@ -885,7 +885,7 @@

Method Details

"deleteTime": "A String", # Output only. Time when this workstation configuration was soft-deleted. "disableTcpConnections": True or False, # Optional. Disables support for plain TCP connections in the workstation. By default the service supports TCP connections through a websocket relay. Setting this option to true disables that relay, which prevents the usage of services that require plain TCP connections, such as SSH. When enabled, all communication must occur over HTTPS or WSS. "displayName": "A String", # Optional. Human-readable name for this workstation configuration. - "enableAuditAgent": True or False, # Optional. Whether to enable Linux `auditd` logging on the workstation. When enabled, a service account must also be specified that has `logging.buckets.write` permission on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging). + "enableAuditAgent": True or False, # Optional. Whether to enable Linux `auditd` logging on the workstation. When enabled, a service_account must also be specified that has `roles/logging.logWriter` and `roles/monitoring.metricWriter` on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging) and [Container output logging](http://cloud/workstations/docs/container-output-logging#overview). Operating system audit logs are available in the [Cloud Logging](https://cloud.google.com/logging/docs) console by querying: resource.type="gce_instance" log_name:"/logs/linux-auditd" "encryptionKey": { # A customer-managed encryption key (CMEK) for the Compute Engine resources of the associated workstation configuration. Specify the name of your Cloud KMS encryption key and the default service account. We recommend that you use a separate service account and follow [Cloud KMS best practices](https://cloud.google.com/kms/docs/separation-of-duties). # Immutable. Encrypts resources of this workstation configuration using a customer-managed encryption key (CMEK). If specified, the boot disk of the Compute Engine instance and the persistent disk are encrypted using this encryption key. If this field is not set, the disks are encrypted using a generated key. Customer-managed encryption keys do not protect disk metadata. If the customer-managed encryption key is rotated, when the workstation instance is stopped, the system attempts to recreate the persistent disk with the new version of the key. Be sure to keep older versions of the key until the persistent disk is recreated. Otherwise, data on the persistent disk might be lost. If the encryption key is revoked, the workstation session automatically stops within 7 hours. Immutable after the workstation configuration is created. "kmsKey": "A String", # Immutable. The name of the Google Cloud KMS encryption key. For example, `"projects/PROJECT_ID/locations/REGION/keyRings/KEY_RING/cryptoKeys/KEY_NAME"`. The key must be in the same region as the workstation configuration. "kmsKeyServiceAccount": "A String", # Immutable. The service account to use with the specified KMS key. We recommend that you use a separate service account and follow KMS best practices. For more information, see [Separation of duties](https://cloud.google.com/kms/docs/separation-of-duties) and `gcloud kms keys add-iam-policy-binding` [`--member`](https://cloud.google.com/sdk/gcloud/reference/kms/keys/add-iam-policy-binding#--member). @@ -916,7 +916,7 @@

Method Details

}, "disablePublicIpAddresses": True or False, # Optional. When set to true, disables public IP addresses for VMs. If you disable public IP addresses, you must set up Private Google Access or Cloud NAT on your network. If you use Private Google Access and you use `private.googleapis.com` or `restricted.googleapis.com` for Container Registry and Artifact Registry, make sure that you set up DNS records for domains `*.gcr.io` and `*.pkg.dev`. Defaults to false (VMs have public IP addresses). "disableSsh": True or False, # Optional. Whether to disable SSH access to the VM. - "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. * **GPUs**: nested virtualization may not be enabled on workstation configurations with accelerators. * **Operating System**: because [Container-Optimized OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos) does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) image. + "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Defaults to false. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. "machineType": "A String", # Optional. The type of machine to use for VM instances—for example, `"e2-standard-4"`. For more information about machine types that Cloud Workstations supports, see the list of [available machine types](https://cloud.google.com/workstations/docs/available-machine-types). "poolSize": 42, # Optional. The number of VMs that the system should keep idle so that new workstations can be started quickly for new users. Defaults to `0` in the API. "pooledInstances": 42, # Output only. Number of instances currently available in the pool for faster workstation startup. diff --git a/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.workstationConfigs.html b/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.workstationConfigs.html index 4039768cf8d..4abb55917f9 100644 --- a/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.workstationConfigs.html +++ b/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.workstationConfigs.html @@ -170,7 +170,7 @@

Method Details

"deleteTime": "A String", # Output only. Time when this workstation configuration was soft-deleted. "disableTcpConnections": True or False, # Optional. Disables support for plain TCP connections in the workstation. By default the service supports TCP connections through a websocket relay. Setting this option to true disables that relay, which prevents the usage of services that require plain TCP connections, such as SSH. When enabled, all communication must occur over HTTPS or WSS. "displayName": "A String", # Optional. Human-readable name for this workstation configuration. - "enableAuditAgent": True or False, # Optional. Whether to enable Linux `auditd` logging on the workstation. When enabled, a service account must also be specified that has `logging.buckets.write` permission on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging). + "enableAuditAgent": True or False, # Optional. Whether to enable Linux `auditd` logging on the workstation. When enabled, a service_account must also be specified that has `roles/logging.logWriter` and `roles/monitoring.metricWriter` on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging) and [Container output logging](http://cloud/workstations/docs/container-output-logging#overview). Operating system audit logs are available in the [Cloud Logging](https://cloud.google.com/logging/docs) console by querying: resource.type="gce_instance" log_name:"/logs/linux-auditd" "encryptionKey": { # A customer-managed encryption key (CMEK) for the Compute Engine resources of the associated workstation configuration. Specify the name of your Cloud KMS encryption key and the default service account. We recommend that you use a separate service account and follow [Cloud KMS best practices](https://cloud.google.com/kms/docs/separation-of-duties). # Immutable. Encrypts resources of this workstation configuration using a customer-managed encryption key (CMEK). If specified, the boot disk of the Compute Engine instance and the persistent disk are encrypted using this encryption key. If this field is not set, the disks are encrypted using a generated key. Customer-managed encryption keys do not protect disk metadata. If the customer-managed encryption key is rotated, when the workstation instance is stopped, the system attempts to recreate the persistent disk with the new version of the key. Be sure to keep older versions of the key until the persistent disk is recreated. Otherwise, data on the persistent disk might be lost. If the encryption key is revoked, the workstation session automatically stops within 7 hours. Immutable after the workstation configuration is created. "kmsKey": "A String", # Immutable. The name of the Google Cloud KMS encryption key. For example, `"projects/PROJECT_ID/locations/REGION/keyRings/KEY_RING/cryptoKeys/KEY_NAME"`. The key must be in the same region as the workstation configuration. "kmsKeyServiceAccount": "A String", # Immutable. The service account to use with the specified KMS key. We recommend that you use a separate service account and follow KMS best practices. For more information, see [Separation of duties](https://cloud.google.com/kms/docs/separation-of-duties) and `gcloud kms keys add-iam-policy-binding` [`--member`](https://cloud.google.com/sdk/gcloud/reference/kms/keys/add-iam-policy-binding#--member). @@ -204,7 +204,7 @@

Method Details

}, ], "bootDiskSizeGb": 42, # Optional. The size of the boot disk for the VM in gigabytes (GB). The minimum boot disk size is `30` GB. Defaults to `50` GB. - "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on boosted Cloud Workstations VMs running using this boost configuration. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on boost configurations that specify a machine_type in the N1 or N2 machine series. * **GPUs**: nested virtualization may not be enabled on boost configurations with accelerators. * **Operating System**: Because [Container-Optimized OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos) does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) image. Defaults to false. + "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on boosted Cloud Workstations VMs running using this boost configuration. Defaults to false. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on boost configurations that specify a machine_type in the N1 or N2 machine series. "id": "A String", # Optional. Required. The id to be used for the boost config. "machineType": "A String", # Optional. The type of machine that boosted VM instances will use—for example, `e2-standard-4`. For more information about machine types that Cloud Workstations supports, see the list of [available machine types](https://cloud.google.com/workstations/docs/available-machine-types). Defaults to `e2-standard-4`. "poolSize": 42, # Optional. The number of boost VMs that the system should keep idle so that workstations can be boosted quickly. Defaults to `0`. @@ -216,7 +216,7 @@

Method Details

}, "disablePublicIpAddresses": True or False, # Optional. When set to true, disables public IP addresses for VMs. If you disable public IP addresses, you must set up Private Google Access or Cloud NAT on your network. If you use Private Google Access and you use `private.googleapis.com` or `restricted.googleapis.com` for Container Registry and Artifact Registry, make sure that you set up DNS records for domains `*.gcr.io` and `*.pkg.dev`. Defaults to false (VMs have public IP addresses). "disableSsh": True or False, # Optional. Whether to disable SSH access to the VM. - "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. * **GPUs**: nested virtualization may not be enabled on workstation configurations with accelerators. * **Operating System**: because [Container-Optimized OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos) does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) image. + "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Defaults to false. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. "machineType": "A String", # Optional. The type of machine to use for VM instances—for example, `"e2-standard-4"`. For more information about machine types that Cloud Workstations supports, see the list of [available machine types](https://cloud.google.com/workstations/docs/available-machine-types). "poolSize": 42, # Optional. The number of VMs that the system should keep idle so that new workstations can be started quickly for new users. Defaults to `0` in the API. "pooledInstances": 42, # Output only. Number of instances currently available in the pool for faster workstation startup. @@ -397,7 +397,7 @@

Method Details

"deleteTime": "A String", # Output only. Time when this workstation configuration was soft-deleted. "disableTcpConnections": True or False, # Optional. Disables support for plain TCP connections in the workstation. By default the service supports TCP connections through a websocket relay. Setting this option to true disables that relay, which prevents the usage of services that require plain TCP connections, such as SSH. When enabled, all communication must occur over HTTPS or WSS. "displayName": "A String", # Optional. Human-readable name for this workstation configuration. - "enableAuditAgent": True or False, # Optional. Whether to enable Linux `auditd` logging on the workstation. When enabled, a service account must also be specified that has `logging.buckets.write` permission on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging). + "enableAuditAgent": True or False, # Optional. Whether to enable Linux `auditd` logging on the workstation. When enabled, a service_account must also be specified that has `roles/logging.logWriter` and `roles/monitoring.metricWriter` on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging) and [Container output logging](http://cloud/workstations/docs/container-output-logging#overview). Operating system audit logs are available in the [Cloud Logging](https://cloud.google.com/logging/docs) console by querying: resource.type="gce_instance" log_name:"/logs/linux-auditd" "encryptionKey": { # A customer-managed encryption key (CMEK) for the Compute Engine resources of the associated workstation configuration. Specify the name of your Cloud KMS encryption key and the default service account. We recommend that you use a separate service account and follow [Cloud KMS best practices](https://cloud.google.com/kms/docs/separation-of-duties). # Immutable. Encrypts resources of this workstation configuration using a customer-managed encryption key (CMEK). If specified, the boot disk of the Compute Engine instance and the persistent disk are encrypted using this encryption key. If this field is not set, the disks are encrypted using a generated key. Customer-managed encryption keys do not protect disk metadata. If the customer-managed encryption key is rotated, when the workstation instance is stopped, the system attempts to recreate the persistent disk with the new version of the key. Be sure to keep older versions of the key until the persistent disk is recreated. Otherwise, data on the persistent disk might be lost. If the encryption key is revoked, the workstation session automatically stops within 7 hours. Immutable after the workstation configuration is created. "kmsKey": "A String", # Immutable. The name of the Google Cloud KMS encryption key. For example, `"projects/PROJECT_ID/locations/REGION/keyRings/KEY_RING/cryptoKeys/KEY_NAME"`. The key must be in the same region as the workstation configuration. "kmsKeyServiceAccount": "A String", # Immutable. The service account to use with the specified KMS key. We recommend that you use a separate service account and follow KMS best practices. For more information, see [Separation of duties](https://cloud.google.com/kms/docs/separation-of-duties) and `gcloud kms keys add-iam-policy-binding` [`--member`](https://cloud.google.com/sdk/gcloud/reference/kms/keys/add-iam-policy-binding#--member). @@ -431,7 +431,7 @@

Method Details

}, ], "bootDiskSizeGb": 42, # Optional. The size of the boot disk for the VM in gigabytes (GB). The minimum boot disk size is `30` GB. Defaults to `50` GB. - "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on boosted Cloud Workstations VMs running using this boost configuration. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on boost configurations that specify a machine_type in the N1 or N2 machine series. * **GPUs**: nested virtualization may not be enabled on boost configurations with accelerators. * **Operating System**: Because [Container-Optimized OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos) does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) image. Defaults to false. + "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on boosted Cloud Workstations VMs running using this boost configuration. Defaults to false. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on boost configurations that specify a machine_type in the N1 or N2 machine series. "id": "A String", # Optional. Required. The id to be used for the boost config. "machineType": "A String", # Optional. The type of machine that boosted VM instances will use—for example, `e2-standard-4`. For more information about machine types that Cloud Workstations supports, see the list of [available machine types](https://cloud.google.com/workstations/docs/available-machine-types). Defaults to `e2-standard-4`. "poolSize": 42, # Optional. The number of boost VMs that the system should keep idle so that workstations can be boosted quickly. Defaults to `0`. @@ -443,7 +443,7 @@

Method Details

}, "disablePublicIpAddresses": True or False, # Optional. When set to true, disables public IP addresses for VMs. If you disable public IP addresses, you must set up Private Google Access or Cloud NAT on your network. If you use Private Google Access and you use `private.googleapis.com` or `restricted.googleapis.com` for Container Registry and Artifact Registry, make sure that you set up DNS records for domains `*.gcr.io` and `*.pkg.dev`. Defaults to false (VMs have public IP addresses). "disableSsh": True or False, # Optional. Whether to disable SSH access to the VM. - "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. * **GPUs**: nested virtualization may not be enabled on workstation configurations with accelerators. * **Operating System**: because [Container-Optimized OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos) does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) image. + "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Defaults to false. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. "machineType": "A String", # Optional. The type of machine to use for VM instances—for example, `"e2-standard-4"`. For more information about machine types that Cloud Workstations supports, see the list of [available machine types](https://cloud.google.com/workstations/docs/available-machine-types). "poolSize": 42, # Optional. The number of VMs that the system should keep idle so that new workstations can be started quickly for new users. Defaults to `0` in the API. "pooledInstances": 42, # Output only. Number of instances currently available in the pool for faster workstation startup. @@ -612,7 +612,7 @@

Method Details

"deleteTime": "A String", # Output only. Time when this workstation configuration was soft-deleted. "disableTcpConnections": True or False, # Optional. Disables support for plain TCP connections in the workstation. By default the service supports TCP connections through a websocket relay. Setting this option to true disables that relay, which prevents the usage of services that require plain TCP connections, such as SSH. When enabled, all communication must occur over HTTPS or WSS. "displayName": "A String", # Optional. Human-readable name for this workstation configuration. - "enableAuditAgent": True or False, # Optional. Whether to enable Linux `auditd` logging on the workstation. When enabled, a service account must also be specified that has `logging.buckets.write` permission on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging). + "enableAuditAgent": True or False, # Optional. Whether to enable Linux `auditd` logging on the workstation. When enabled, a service_account must also be specified that has `roles/logging.logWriter` and `roles/monitoring.metricWriter` on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging) and [Container output logging](http://cloud/workstations/docs/container-output-logging#overview). Operating system audit logs are available in the [Cloud Logging](https://cloud.google.com/logging/docs) console by querying: resource.type="gce_instance" log_name:"/logs/linux-auditd" "encryptionKey": { # A customer-managed encryption key (CMEK) for the Compute Engine resources of the associated workstation configuration. Specify the name of your Cloud KMS encryption key and the default service account. We recommend that you use a separate service account and follow [Cloud KMS best practices](https://cloud.google.com/kms/docs/separation-of-duties). # Immutable. Encrypts resources of this workstation configuration using a customer-managed encryption key (CMEK). If specified, the boot disk of the Compute Engine instance and the persistent disk are encrypted using this encryption key. If this field is not set, the disks are encrypted using a generated key. Customer-managed encryption keys do not protect disk metadata. If the customer-managed encryption key is rotated, when the workstation instance is stopped, the system attempts to recreate the persistent disk with the new version of the key. Be sure to keep older versions of the key until the persistent disk is recreated. Otherwise, data on the persistent disk might be lost. If the encryption key is revoked, the workstation session automatically stops within 7 hours. Immutable after the workstation configuration is created. "kmsKey": "A String", # Immutable. The name of the Google Cloud KMS encryption key. For example, `"projects/PROJECT_ID/locations/REGION/keyRings/KEY_RING/cryptoKeys/KEY_NAME"`. The key must be in the same region as the workstation configuration. "kmsKeyServiceAccount": "A String", # Immutable. The service account to use with the specified KMS key. We recommend that you use a separate service account and follow KMS best practices. For more information, see [Separation of duties](https://cloud.google.com/kms/docs/separation-of-duties) and `gcloud kms keys add-iam-policy-binding` [`--member`](https://cloud.google.com/sdk/gcloud/reference/kms/keys/add-iam-policy-binding#--member). @@ -646,7 +646,7 @@

Method Details

}, ], "bootDiskSizeGb": 42, # Optional. The size of the boot disk for the VM in gigabytes (GB). The minimum boot disk size is `30` GB. Defaults to `50` GB. - "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on boosted Cloud Workstations VMs running using this boost configuration. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on boost configurations that specify a machine_type in the N1 or N2 machine series. * **GPUs**: nested virtualization may not be enabled on boost configurations with accelerators. * **Operating System**: Because [Container-Optimized OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos) does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) image. Defaults to false. + "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on boosted Cloud Workstations VMs running using this boost configuration. Defaults to false. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on boost configurations that specify a machine_type in the N1 or N2 machine series. "id": "A String", # Optional. Required. The id to be used for the boost config. "machineType": "A String", # Optional. The type of machine that boosted VM instances will use—for example, `e2-standard-4`. For more information about machine types that Cloud Workstations supports, see the list of [available machine types](https://cloud.google.com/workstations/docs/available-machine-types). Defaults to `e2-standard-4`. "poolSize": 42, # Optional. The number of boost VMs that the system should keep idle so that workstations can be boosted quickly. Defaults to `0`. @@ -658,7 +658,7 @@

Method Details

}, "disablePublicIpAddresses": True or False, # Optional. When set to true, disables public IP addresses for VMs. If you disable public IP addresses, you must set up Private Google Access or Cloud NAT on your network. If you use Private Google Access and you use `private.googleapis.com` or `restricted.googleapis.com` for Container Registry and Artifact Registry, make sure that you set up DNS records for domains `*.gcr.io` and `*.pkg.dev`. Defaults to false (VMs have public IP addresses). "disableSsh": True or False, # Optional. Whether to disable SSH access to the VM. - "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. * **GPUs**: nested virtualization may not be enabled on workstation configurations with accelerators. * **Operating System**: because [Container-Optimized OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos) does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) image. + "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Defaults to false. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. "machineType": "A String", # Optional. The type of machine to use for VM instances—for example, `"e2-standard-4"`. For more information about machine types that Cloud Workstations supports, see the list of [available machine types](https://cloud.google.com/workstations/docs/available-machine-types). "poolSize": 42, # Optional. The number of VMs that the system should keep idle so that new workstations can be started quickly for new users. Defaults to `0` in the API. "pooledInstances": 42, # Output only. Number of instances currently available in the pool for faster workstation startup. @@ -781,7 +781,7 @@

Method Details

"deleteTime": "A String", # Output only. Time when this workstation configuration was soft-deleted. "disableTcpConnections": True or False, # Optional. Disables support for plain TCP connections in the workstation. By default the service supports TCP connections through a websocket relay. Setting this option to true disables that relay, which prevents the usage of services that require plain TCP connections, such as SSH. When enabled, all communication must occur over HTTPS or WSS. "displayName": "A String", # Optional. Human-readable name for this workstation configuration. - "enableAuditAgent": True or False, # Optional. Whether to enable Linux `auditd` logging on the workstation. When enabled, a service account must also be specified that has `logging.buckets.write` permission on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging). + "enableAuditAgent": True or False, # Optional. Whether to enable Linux `auditd` logging on the workstation. When enabled, a service_account must also be specified that has `roles/logging.logWriter` and `roles/monitoring.metricWriter` on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging) and [Container output logging](http://cloud/workstations/docs/container-output-logging#overview). Operating system audit logs are available in the [Cloud Logging](https://cloud.google.com/logging/docs) console by querying: resource.type="gce_instance" log_name:"/logs/linux-auditd" "encryptionKey": { # A customer-managed encryption key (CMEK) for the Compute Engine resources of the associated workstation configuration. Specify the name of your Cloud KMS encryption key and the default service account. We recommend that you use a separate service account and follow [Cloud KMS best practices](https://cloud.google.com/kms/docs/separation-of-duties). # Immutable. Encrypts resources of this workstation configuration using a customer-managed encryption key (CMEK). If specified, the boot disk of the Compute Engine instance and the persistent disk are encrypted using this encryption key. If this field is not set, the disks are encrypted using a generated key. Customer-managed encryption keys do not protect disk metadata. If the customer-managed encryption key is rotated, when the workstation instance is stopped, the system attempts to recreate the persistent disk with the new version of the key. Be sure to keep older versions of the key until the persistent disk is recreated. Otherwise, data on the persistent disk might be lost. If the encryption key is revoked, the workstation session automatically stops within 7 hours. Immutable after the workstation configuration is created. "kmsKey": "A String", # Immutable. The name of the Google Cloud KMS encryption key. For example, `"projects/PROJECT_ID/locations/REGION/keyRings/KEY_RING/cryptoKeys/KEY_NAME"`. The key must be in the same region as the workstation configuration. "kmsKeyServiceAccount": "A String", # Immutable. The service account to use with the specified KMS key. We recommend that you use a separate service account and follow KMS best practices. For more information, see [Separation of duties](https://cloud.google.com/kms/docs/separation-of-duties) and `gcloud kms keys add-iam-policy-binding` [`--member`](https://cloud.google.com/sdk/gcloud/reference/kms/keys/add-iam-policy-binding#--member). @@ -815,7 +815,7 @@

Method Details

}, ], "bootDiskSizeGb": 42, # Optional. The size of the boot disk for the VM in gigabytes (GB). The minimum boot disk size is `30` GB. Defaults to `50` GB. - "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on boosted Cloud Workstations VMs running using this boost configuration. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on boost configurations that specify a machine_type in the N1 or N2 machine series. * **GPUs**: nested virtualization may not be enabled on boost configurations with accelerators. * **Operating System**: Because [Container-Optimized OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos) does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) image. Defaults to false. + "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on boosted Cloud Workstations VMs running using this boost configuration. Defaults to false. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on boost configurations that specify a machine_type in the N1 or N2 machine series. "id": "A String", # Optional. Required. The id to be used for the boost config. "machineType": "A String", # Optional. The type of machine that boosted VM instances will use—for example, `e2-standard-4`. For more information about machine types that Cloud Workstations supports, see the list of [available machine types](https://cloud.google.com/workstations/docs/available-machine-types). Defaults to `e2-standard-4`. "poolSize": 42, # Optional. The number of boost VMs that the system should keep idle so that workstations can be boosted quickly. Defaults to `0`. @@ -827,7 +827,7 @@

Method Details

}, "disablePublicIpAddresses": True or False, # Optional. When set to true, disables public IP addresses for VMs. If you disable public IP addresses, you must set up Private Google Access or Cloud NAT on your network. If you use Private Google Access and you use `private.googleapis.com` or `restricted.googleapis.com` for Container Registry and Artifact Registry, make sure that you set up DNS records for domains `*.gcr.io` and `*.pkg.dev`. Defaults to false (VMs have public IP addresses). "disableSsh": True or False, # Optional. Whether to disable SSH access to the VM. - "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. * **GPUs**: nested virtualization may not be enabled on workstation configurations with accelerators. * **Operating System**: because [Container-Optimized OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos) does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) image. + "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Defaults to false. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. "machineType": "A String", # Optional. The type of machine to use for VM instances—for example, `"e2-standard-4"`. For more information about machine types that Cloud Workstations supports, see the list of [available machine types](https://cloud.google.com/workstations/docs/available-machine-types). "poolSize": 42, # Optional. The number of VMs that the system should keep idle so that new workstations can be started quickly for new users. Defaults to `0` in the API. "pooledInstances": 42, # Output only. Number of instances currently available in the pool for faster workstation startup. @@ -965,7 +965,7 @@

Method Details

"deleteTime": "A String", # Output only. Time when this workstation configuration was soft-deleted. "disableTcpConnections": True or False, # Optional. Disables support for plain TCP connections in the workstation. By default the service supports TCP connections through a websocket relay. Setting this option to true disables that relay, which prevents the usage of services that require plain TCP connections, such as SSH. When enabled, all communication must occur over HTTPS or WSS. "displayName": "A String", # Optional. Human-readable name for this workstation configuration. - "enableAuditAgent": True or False, # Optional. Whether to enable Linux `auditd` logging on the workstation. When enabled, a service account must also be specified that has `logging.buckets.write` permission on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging). + "enableAuditAgent": True or False, # Optional. Whether to enable Linux `auditd` logging on the workstation. When enabled, a service_account must also be specified that has `roles/logging.logWriter` and `roles/monitoring.metricWriter` on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging) and [Container output logging](http://cloud/workstations/docs/container-output-logging#overview). Operating system audit logs are available in the [Cloud Logging](https://cloud.google.com/logging/docs) console by querying: resource.type="gce_instance" log_name:"/logs/linux-auditd" "encryptionKey": { # A customer-managed encryption key (CMEK) for the Compute Engine resources of the associated workstation configuration. Specify the name of your Cloud KMS encryption key and the default service account. We recommend that you use a separate service account and follow [Cloud KMS best practices](https://cloud.google.com/kms/docs/separation-of-duties). # Immutable. Encrypts resources of this workstation configuration using a customer-managed encryption key (CMEK). If specified, the boot disk of the Compute Engine instance and the persistent disk are encrypted using this encryption key. If this field is not set, the disks are encrypted using a generated key. Customer-managed encryption keys do not protect disk metadata. If the customer-managed encryption key is rotated, when the workstation instance is stopped, the system attempts to recreate the persistent disk with the new version of the key. Be sure to keep older versions of the key until the persistent disk is recreated. Otherwise, data on the persistent disk might be lost. If the encryption key is revoked, the workstation session automatically stops within 7 hours. Immutable after the workstation configuration is created. "kmsKey": "A String", # Immutable. The name of the Google Cloud KMS encryption key. For example, `"projects/PROJECT_ID/locations/REGION/keyRings/KEY_RING/cryptoKeys/KEY_NAME"`. The key must be in the same region as the workstation configuration. "kmsKeyServiceAccount": "A String", # Immutable. The service account to use with the specified KMS key. We recommend that you use a separate service account and follow KMS best practices. For more information, see [Separation of duties](https://cloud.google.com/kms/docs/separation-of-duties) and `gcloud kms keys add-iam-policy-binding` [`--member`](https://cloud.google.com/sdk/gcloud/reference/kms/keys/add-iam-policy-binding#--member). @@ -999,7 +999,7 @@

Method Details

}, ], "bootDiskSizeGb": 42, # Optional. The size of the boot disk for the VM in gigabytes (GB). The minimum boot disk size is `30` GB. Defaults to `50` GB. - "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on boosted Cloud Workstations VMs running using this boost configuration. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on boost configurations that specify a machine_type in the N1 or N2 machine series. * **GPUs**: nested virtualization may not be enabled on boost configurations with accelerators. * **Operating System**: Because [Container-Optimized OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos) does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) image. Defaults to false. + "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on boosted Cloud Workstations VMs running using this boost configuration. Defaults to false. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on boost configurations that specify a machine_type in the N1 or N2 machine series. "id": "A String", # Optional. Required. The id to be used for the boost config. "machineType": "A String", # Optional. The type of machine that boosted VM instances will use—for example, `e2-standard-4`. For more information about machine types that Cloud Workstations supports, see the list of [available machine types](https://cloud.google.com/workstations/docs/available-machine-types). Defaults to `e2-standard-4`. "poolSize": 42, # Optional. The number of boost VMs that the system should keep idle so that workstations can be boosted quickly. Defaults to `0`. @@ -1011,7 +1011,7 @@

Method Details

}, "disablePublicIpAddresses": True or False, # Optional. When set to true, disables public IP addresses for VMs. If you disable public IP addresses, you must set up Private Google Access or Cloud NAT on your network. If you use Private Google Access and you use `private.googleapis.com` or `restricted.googleapis.com` for Container Registry and Artifact Registry, make sure that you set up DNS records for domains `*.gcr.io` and `*.pkg.dev`. Defaults to false (VMs have public IP addresses). "disableSsh": True or False, # Optional. Whether to disable SSH access to the VM. - "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. * **GPUs**: nested virtualization may not be enabled on workstation configurations with accelerators. * **Operating System**: because [Container-Optimized OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos) does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) image. + "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Defaults to false. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. "machineType": "A String", # Optional. The type of machine to use for VM instances—for example, `"e2-standard-4"`. For more information about machine types that Cloud Workstations supports, see the list of [available machine types](https://cloud.google.com/workstations/docs/available-machine-types). "poolSize": 42, # Optional. The number of VMs that the system should keep idle so that new workstations can be started quickly for new users. Defaults to `0` in the API. "pooledInstances": 42, # Output only. Number of instances currently available in the pool for faster workstation startup. diff --git a/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.workstationConfigs.workstations.html b/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.workstationConfigs.workstations.html index 226d08d664a..ddd0e3610c2 100644 --- a/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.workstationConfigs.workstations.html +++ b/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.workstationConfigs.workstations.html @@ -138,6 +138,11 @@

Method Details

"annotations": { # Optional. Client-specified annotations. "a_key": "A String", }, + "boostConfigs": [ # Output only. List of available boost configuration ids that this workstation can be boosted up to + { # Boost config for this workstation. This object is populated from the parent workstation config. + "id": "A String", # Output only. Boost config id. + }, + ], "createTime": "A String", # Output only. Time when this workstation was created. "deleteTime": "A String", # Output only. Time when this workstation was soft-deleted. "displayName": "A String", # Optional. Human-readable name for this workstation. @@ -276,6 +281,11 @@

Method Details

"annotations": { # Optional. Client-specified annotations. "a_key": "A String", }, + "boostConfigs": [ # Output only. List of available boost configuration ids that this workstation can be boosted up to + { # Boost config for this workstation. This object is populated from the parent workstation config. + "id": "A String", # Output only. Boost config id. + }, + ], "createTime": "A String", # Output only. Time when this workstation was created. "deleteTime": "A String", # Output only. Time when this workstation was soft-deleted. "displayName": "A String", # Optional. Human-readable name for this workstation. @@ -374,6 +384,11 @@

Method Details

"annotations": { # Optional. Client-specified annotations. "a_key": "A String", }, + "boostConfigs": [ # Output only. List of available boost configuration ids that this workstation can be boosted up to + { # Boost config for this workstation. This object is populated from the parent workstation config. + "id": "A String", # Output only. Boost config id. + }, + ], "createTime": "A String", # Output only. Time when this workstation was created. "deleteTime": "A String", # Output only. Time when this workstation was soft-deleted. "displayName": "A String", # Optional. Human-readable name for this workstation. @@ -426,6 +441,11 @@

Method Details

"annotations": { # Optional. Client-specified annotations. "a_key": "A String", }, + "boostConfigs": [ # Output only. List of available boost configuration ids that this workstation can be boosted up to + { # Boost config for this workstation. This object is populated from the parent workstation config. + "id": "A String", # Output only. Boost config id. + }, + ], "createTime": "A String", # Output only. Time when this workstation was created. "deleteTime": "A String", # Output only. Time when this workstation was soft-deleted. "displayName": "A String", # Optional. Human-readable name for this workstation. @@ -493,6 +513,11 @@

Method Details

"annotations": { # Optional. Client-specified annotations. "a_key": "A String", }, + "boostConfigs": [ # Output only. List of available boost configuration ids that this workstation can be boosted up to + { # Boost config for this workstation. This object is populated from the parent workstation config. + "id": "A String", # Output only. Boost config id. + }, + ], "createTime": "A String", # Output only. Time when this workstation was created. "deleteTime": "A String", # Output only. Time when this workstation was soft-deleted. "displayName": "A String", # Optional. Human-readable name for this workstation. diff --git a/googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json b/googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json index 9c72c3a8fc6..5e2efc129f8 100644 --- a/googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json +++ b/googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json @@ -1290,7 +1290,7 @@ } } }, -"revision": "20240708", +"revision": "20240716", "rootUrl": "https://accesscontextmanager.googleapis.com/", "schemas": { "AccessContextManagerOperationMetadata": { @@ -1742,7 +1742,7 @@ "type": "string" }, "sources": { -"description": "Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out.", +"description": "Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`.", "items": { "$ref": "EgressSource" }, @@ -1771,7 +1771,7 @@ "id": "EgressSource", "properties": { "accessLevel": { -"description": "An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out.", +"description": "An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed.", "type": "string" } }, @@ -2549,7 +2549,7 @@ "properties": { "vpcSubnetwork": { "$ref": "VpcSubNetwork", -"description": "Sub-segment ranges of a VPC network. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out." +"description": "Sub-segment ranges of a VPC network." } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/adsenseplatform.v1.json b/googleapiclient/discovery_cache/documents/adsenseplatform.v1.json new file mode 100644 index 00000000000..d45f007e704 --- /dev/null +++ b/googleapiclient/discovery_cache/documents/adsenseplatform.v1.json @@ -0,0 +1,721 @@ +{ +"auth": { +"oauth2": { +"scopes": { +"https://www.googleapis.com/auth/adsense": { +"description": "View and manage your AdSense data" +}, +"https://www.googleapis.com/auth/adsense.readonly": { +"description": "View your AdSense data" +} +} +} +}, +"basePath": "", +"baseUrl": "https://adsenseplatform.googleapis.com/", +"batchPath": "batch", +"canonicalName": "AdSense Platform", +"description": "", +"discoveryVersion": "v1", +"documentationLink": "https://developers.google.com/adsense/platforms/", +"fullyEncodeReservedExpansion": true, +"icons": { +"x16": "http://www.google.com/images/icons/product/search-16.gif", +"x32": "http://www.google.com/images/icons/product/search-32.gif" +}, +"id": "adsenseplatform:v1", +"kind": "discovery#restDescription", +"mtlsRootUrl": "https://adsenseplatform.mtls.googleapis.com/", +"name": "adsenseplatform", +"ownerDomain": "google.com", +"ownerName": "Google", +"parameters": { +"$.xgafv": { +"description": "V1 error format.", +"enum": [ +"1", +"2" +], +"enumDescriptions": [ +"v1 error format", +"v2 error format" +], +"location": "query", +"type": "string" +}, +"access_token": { +"description": "OAuth access token.", +"location": "query", +"type": "string" +}, +"alt": { +"default": "json", +"description": "Data format for response.", +"enum": [ +"json", +"media", +"proto" +], +"enumDescriptions": [ +"Responses with Content-Type of application/json", +"Media download with context-dependent Content-Type", +"Responses with Content-Type of application/x-protobuf" +], +"location": "query", +"type": "string" +}, +"callback": { +"description": "JSONP", +"location": "query", +"type": "string" +}, +"fields": { +"description": "Selector specifying which fields to include in a partial response.", +"location": "query", +"type": "string" +}, +"key": { +"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", +"location": "query", +"type": "string" +}, +"oauth_token": { +"description": "OAuth 2.0 token for the current user.", +"location": "query", +"type": "string" +}, +"prettyPrint": { +"default": "true", +"description": "Returns response with indentations and line breaks.", +"location": "query", +"type": "boolean" +}, +"quotaUser": { +"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", +"location": "query", +"type": "string" +}, +"uploadType": { +"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", +"location": "query", +"type": "string" +}, +"upload_protocol": { +"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", +"location": "query", +"type": "string" +} +}, +"protocol": "rest", +"resources": { +"platforms": { +"resources": { +"accounts": { +"methods": { +"close": { +"description": "Closes a sub-account.", +"flatPath": "v1/platforms/{platformsId}/accounts/{accountsId}:close", +"httpMethod": "POST", +"id": "adsenseplatform.platforms.accounts.close", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Account to close. Format: platforms/{platform}/accounts/{account_id}", +"location": "path", +"pattern": "^platforms/[^/]+/accounts/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:close", +"request": { +"$ref": "CloseAccountRequest" +}, +"response": { +"$ref": "CloseAccountResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/adsense" +] +}, +"create": { +"description": "Creates a sub-account.", +"flatPath": "v1/platforms/{platformsId}/accounts", +"httpMethod": "POST", +"id": "adsenseplatform.platforms.accounts.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. Platform to create an account for. Format: platforms/{platform}", +"location": "path", +"pattern": "^platforms/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/accounts", +"request": { +"$ref": "Account" +}, +"response": { +"$ref": "Account" +}, +"scopes": [ +"https://www.googleapis.com/auth/adsense" +] +}, +"get": { +"description": "Gets information about the selected sub-account.", +"flatPath": "v1/platforms/{platformsId}/accounts/{accountsId}", +"httpMethod": "GET", +"id": "adsenseplatform.platforms.accounts.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Account to get information about. Format: platforms/{platform}/accounts/{account_id}", +"location": "path", +"pattern": "^platforms/[^/]+/accounts/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Account" +}, +"scopes": [ +"https://www.googleapis.com/auth/adsense", +"https://www.googleapis.com/auth/adsense.readonly" +] +}, +"list": { +"description": "Lists a partial view of sub-accounts for a specific parent account.", +"flatPath": "v1/platforms/{platformsId}/accounts", +"httpMethod": "GET", +"id": "adsenseplatform.platforms.accounts.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Optional. The maximum number of accounts to include in the response, used for paging. If unspecified, at most 10000 accounts will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Platform who parents the accounts. Format: platforms/{platform}", +"location": "path", +"pattern": "^platforms/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/accounts", +"response": { +"$ref": "ListAccountsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/adsense", +"https://www.googleapis.com/auth/adsense.readonly" +] +}, +"lookup": { +"description": "Looks up information about a sub-account for a specified creation_request_id. If no account exists for the given creation_request_id, returns 404.", +"flatPath": "v1/platforms/{platformsId}/accounts:lookup", +"httpMethod": "GET", +"id": "adsenseplatform.platforms.accounts.lookup", +"parameterOrder": [ +"parent" +], +"parameters": { +"creationRequestId": { +"description": "Optional. The creation_request_id provided when calling createAccount.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Platform who parents the account. Format: platforms/{platform}", +"location": "path", +"pattern": "^platforms/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/accounts:lookup", +"response": { +"$ref": "LookupAccountResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/adsense", +"https://www.googleapis.com/auth/adsense.readonly" +] +} +}, +"resources": { +"events": { +"methods": { +"create": { +"description": "Creates an account event.", +"flatPath": "v1/platforms/{platformsId}/accounts/{accountsId}/events", +"httpMethod": "POST", +"id": "adsenseplatform.platforms.accounts.events.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. Account to log events about. Format: platforms/{platform}/accounts/{account}", +"location": "path", +"pattern": "^platforms/[^/]+/accounts/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/events", +"request": { +"$ref": "Event" +}, +"response": { +"$ref": "Event" +}, +"scopes": [ +"https://www.googleapis.com/auth/adsense" +] +} +} +}, +"sites": { +"methods": { +"create": { +"description": "Creates a site for a specified account.", +"flatPath": "v1/platforms/{platformsId}/accounts/{accountsId}/sites", +"httpMethod": "POST", +"id": "adsenseplatform.platforms.accounts.sites.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. Account to create site. Format: platforms/{platform}/accounts/{account_id}", +"location": "path", +"pattern": "^platforms/[^/]+/accounts/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/sites", +"request": { +"$ref": "Site" +}, +"response": { +"$ref": "Site" +}, +"scopes": [ +"https://www.googleapis.com/auth/adsense" +] +}, +"delete": { +"description": "Deletes a site from a specified account.", +"flatPath": "v1/platforms/{platformsId}/accounts/{accountsId}/sites/{sitesId}", +"httpMethod": "DELETE", +"id": "adsenseplatform.platforms.accounts.sites.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the site to delete. Format: platforms/{platform}/accounts/{account}/sites/{site}", +"location": "path", +"pattern": "^platforms/[^/]+/accounts/[^/]+/sites/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/adsense" +] +}, +"get": { +"description": "Gets a site from a specified sub-account.", +"flatPath": "v1/platforms/{platformsId}/accounts/{accountsId}/sites/{sitesId}", +"httpMethod": "GET", +"id": "adsenseplatform.platforms.accounts.sites.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the site to retrieve. Format: platforms/{platform}/accounts/{account}/sites/{site}", +"location": "path", +"pattern": "^platforms/[^/]+/accounts/[^/]+/sites/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Site" +}, +"scopes": [ +"https://www.googleapis.com/auth/adsense", +"https://www.googleapis.com/auth/adsense.readonly" +] +}, +"list": { +"description": "Lists sites for a specific account.", +"flatPath": "v1/platforms/{platformsId}/accounts/{accountsId}/sites", +"httpMethod": "GET", +"id": "adsenseplatform.platforms.accounts.sites.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "The maximum number of sites to include in the response, used for paging. If unspecified, at most 10000 sites will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A page token, received from a previous `ListSites` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSites` must match the call that provided the page token.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The account which owns the sites. Format: platforms/{platform}/accounts/{account}", +"location": "path", +"pattern": "^platforms/[^/]+/accounts/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/sites", +"response": { +"$ref": "ListSitesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/adsense", +"https://www.googleapis.com/auth/adsense.readonly" +] +}, +"requestReview": { +"description": "Requests the review of a site. The site should be in REQUIRES_REVIEW or NEEDS_ATTENTION state. Note: Make sure you place an [ad tag](https://developers.google.com/adsense/platforms/direct/ad-tags) on your site before requesting a review.", +"flatPath": "v1/platforms/{platformsId}/accounts/{accountsId}/sites/{sitesId}:requestReview", +"httpMethod": "POST", +"id": "adsenseplatform.platforms.accounts.sites.requestReview", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the site to submit for review. Format: platforms/{platform}/accounts/{account}/sites/{site}", +"location": "path", +"pattern": "^platforms/[^/]+/accounts/[^/]+/sites/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:requestReview", +"response": { +"$ref": "RequestSiteReviewResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/adsense" +] +} +} +} +} +} +} +} +}, +"revision": "20240722", +"rootUrl": "https://adsenseplatform.googleapis.com/", +"schemas": { +"Account": { +"description": "Representation of an Account.", +"id": "Account", +"properties": { +"createTime": { +"description": "Output only. Creation time of the account.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"creationRequestId": { +"description": "Required. An opaque token that uniquely identifies the account among all the platform's accounts. This string may contain at most 64 non-whitespace ASCII characters, but otherwise has no predefined structure. However, it is expected to be a platform-specific identifier for the user creating the account, so that only a single account can be created for any given user. This field must not contain any information that is recognizable as personally identifiable information. e.g. it should not be an email address or login name. Once an account has been created, a second attempt to create an account using the same creation_request_id will result in an ALREADY_EXISTS error.", +"type": "string" +}, +"displayName": { +"description": "Display name of this account.", +"type": "string" +}, +"name": { +"description": "Output only. Resource name of the account. Format: platforms/pub-[0-9]+/accounts/pub-[0-9]+", +"readOnly": true, +"type": "string" +}, +"regionCode": { +"description": "Required. Input only. CLDR region code of the country/region of the address. Set this to country code of the child account if known, otherwise to your own country code.", +"type": "string" +}, +"state": { +"description": "Output only. Approval state of the account.", +"enum": [ +"STATE_UNSPECIFIED", +"UNCHECKED", +"APPROVED", +"DISAPPROVED" +], +"enumDescriptions": [ +"Unspecified.", +"Unchecked.", +"The account is ready to serve ads.", +"The account has been blocked from serving ads." +], +"readOnly": true, +"type": "string" +}, +"timeZone": { +"$ref": "TimeZone", +"description": "Required. The IANA TZ timezone code of this account. For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. This field is used for reporting. It is recommended to set it to the same value for all child accounts." +} +}, +"type": "object" +}, +"Address": { +"description": "Address data.", +"id": "Address", +"properties": { +"address1": { +"description": "First line of address. Max length 64 bytes or 30 characters.", +"type": "string" +}, +"address2": { +"description": "Second line of address. Max length 64 bytes or 30 characters.", +"type": "string" +}, +"city": { +"description": "City. Max length 60 bytes or 30 characters.", +"type": "string" +}, +"company": { +"description": "Name of the company. Max length 255 bytes or 34 characters.", +"type": "string" +}, +"contact": { +"description": "Contact name of the company. Max length 128 bytes or 34 characters.", +"type": "string" +}, +"fax": { +"description": "Fax number with international code (i.e. +441234567890).", +"type": "string" +}, +"phone": { +"description": "Phone number with international code (i.e. +441234567890).", +"type": "string" +}, +"regionCode": { +"description": "Country/Region code. The region is specified as a CLDR region code (e.g. \"US\", \"FR\").", +"type": "string" +}, +"state": { +"description": "State. Max length 60 bytes or 30 characters.", +"type": "string" +}, +"zip": { +"description": "Zip/post code. Max length 10 bytes or 10 characters.", +"type": "string" +} +}, +"type": "object" +}, +"CloseAccountRequest": { +"description": "Request definition for the account close rpc.", +"id": "CloseAccountRequest", +"properties": {}, +"type": "object" +}, +"CloseAccountResponse": { +"description": "Response definition for the account close rpc.", +"id": "CloseAccountResponse", +"properties": {}, +"type": "object" +}, +"Empty": { +"description": "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); }", +"id": "Empty", +"properties": {}, +"type": "object" +}, +"Event": { +"description": "A platform sub-account event to record spam signals.", +"id": "Event", +"properties": { +"eventInfo": { +"$ref": "EventInfo", +"description": "Required. Information associated with the event." +}, +"eventTime": { +"description": "Required. Event timestamp.", +"format": "google-datetime", +"type": "string" +}, +"eventType": { +"description": "Required. Event type.", +"enum": [ +"EVENT_TYPE_UNSPECIFIED", +"LOG_IN_VIA_PLATFORM", +"SIGN_UP_VIA_PLATFORM" +], +"enumDescriptions": [ +"Do not use. You must set an event type explicitly.", +"Log in via platform.", +"Sign up via platform." +], +"type": "string" +} +}, +"type": "object" +}, +"EventInfo": { +"description": "Private information for partner recorded events (PII).", +"id": "EventInfo", +"properties": { +"billingAddress": { +"$ref": "Address", +"description": "The billing address of the publisher associated with this event, if available." +}, +"email": { +"description": "Required. The email address that is associated with the publisher when performing the event.", +"type": "string" +} +}, +"type": "object" +}, +"ListAccountsResponse": { +"description": "Response definition for the list accounts rpc.", +"id": "ListAccountsResponse", +"properties": { +"accounts": { +"description": "The Accounts returned in the list response. Represented by a partial view of the Account resource, populating `name` and `creation_request_id`.", +"items": { +"$ref": "Account" +}, +"type": "array" +}, +"nextPageToken": { +"description": "Continuation token used to page through accounts. To retrieve the next page of the results, set the next request's \"page_token\" value to this.", +"type": "string" +} +}, +"type": "object" +}, +"ListSitesResponse": { +"description": "Response definition for the site list rpc.", +"id": "ListSitesResponse", +"properties": { +"nextPageToken": { +"description": "Continuation token used to page through sites. To retrieve the next page of the results, set the next request's \"page_token\" value to this.", +"type": "string" +}, +"sites": { +"description": "The sites returned in this list response.", +"items": { +"$ref": "Site" +}, +"type": "array" +} +}, +"type": "object" +}, +"LookupAccountResponse": { +"description": "Response definition for the lookup account rpc.", +"id": "LookupAccountResponse", +"properties": { +"name": { +"description": "The name of the Account Format: platforms/{platform}/accounts/{account_id}", +"type": "string" +} +}, +"type": "object" +}, +"RequestSiteReviewResponse": { +"description": "Response definition for the site request review rpc.", +"id": "RequestSiteReviewResponse", +"properties": {}, +"type": "object" +}, +"Site": { +"description": "Representation of a Site.", +"id": "Site", +"properties": { +"domain": { +"description": "Domain/sub-domain of the site. Must be a valid domain complying with [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt) and formatted as punycode [RFC 3492](https://www.ietf.org/rfc/rfc3492.txt) in case the domain contains unicode characters.", +"type": "string" +}, +"name": { +"description": "Output only. Resource name of a site. Format: platforms/{platform}/accounts/{account}/sites/{site}", +"readOnly": true, +"type": "string" +}, +"state": { +"description": "Output only. State of a site.", +"enum": [ +"STATE_UNSPECIFIED", +"REQUIRES_REVIEW", +"GETTING_READY", +"READY", +"NEEDS_ATTENTION" +], +"enumDescriptions": [ +"State unspecified.", +"Either: - The site hasn't been checked yet. - The site is inactive and needs another review before it can show ads again. Learn how to [request a review for an inactive site](https://support.google.com/adsense/answer/9393996).", +"Google is running some checks on the site. This usually takes a few days, but in some cases it can take two to four weeks.", +"The site is ready to show ads. Learn how to [set up ads on the site](https://support.google.com/adsense/answer/7037624).", +"Publisher needs to fix some issues before the site is ready to show ads. Learn what to do [if a new site isn't ready](https://support.google.com/adsense/answer/9061852)." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"TimeZone": { +"description": "Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones).", +"id": "TimeZone", +"properties": { +"id": { +"description": "IANA Time Zone Database time zone, e.g. \"America/New_York\".", +"type": "string" +}, +"version": { +"description": "Optional. IANA Time Zone Database version number, e.g. \"2019a\".", +"type": "string" +} +}, +"type": "object" +} +}, +"servicePath": "", +"title": "AdSense Platform API", +"version": "v1", +"version_module": true +} \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/aiplatform.v1.json b/googleapiclient/discovery_cache/documents/aiplatform.v1.json index 8867fb7591e..51b2d54074d 100644 --- a/googleapiclient/discovery_cache/documents/aiplatform.v1.json +++ b/googleapiclient/discovery_cache/documents/aiplatform.v1.json @@ -1391,7 +1391,7 @@ ], "parameters": { "name": { -"description": "Output only. The resource name of the Dataset.", +"description": "Output only. Identifier. The resource name of the Dataset.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "required": true, @@ -2268,7 +2268,7 @@ ], "parameters": { "name": { -"description": "Output only. The resource name of the DatasetVersion.", +"description": "Output only. Identifier. The resource name of the DatasetVersion.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/datasetVersions/[^/]+$", "required": true, @@ -11179,6 +11179,167 @@ } }, "notebookExecutionJobs": { +"methods": { +"create": { +"description": "Creates a NotebookExecutionJob.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.notebookExecutionJobs.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"notebookExecutionJobId": { +"description": "Optional. User specified ID for the NotebookExecutionJob.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The resource name of the Location to create the NotebookExecutionJob. Format: `projects/{project}/locations/{location}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/notebookExecutionJobs", +"request": { +"$ref": "GoogleCloudAiplatformV1NotebookExecutionJob" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a NotebookExecutionJob.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}", +"httpMethod": "DELETE", +"id": "aiplatform.projects.locations.notebookExecutionJobs.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the NotebookExecutionJob resource to be deleted.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets a NotebookExecutionJob.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.notebookExecutionJobs.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the NotebookExecutionJob resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+$", +"required": true, +"type": "string" +}, +"view": { +"description": "Optional. The NotebookExecutionJob view. Defaults to BASIC.", +"enum": [ +"NOTEBOOK_EXECUTION_JOB_VIEW_UNSPECIFIED", +"NOTEBOOK_EXECUTION_JOB_VIEW_BASIC", +"NOTEBOOK_EXECUTION_JOB_VIEW_FULL" +], +"enumDescriptions": [ +"When unspecified, the API defaults to the BASIC view.", +"Includes all fields except for direct notebook inputs.", +"Includes all fields." +], +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleCloudAiplatformV1NotebookExecutionJob" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists NotebookExecutionJobs in a Location.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.notebookExecutionJobs.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookExecutionJob` supports = and !=. `notebookExecutionJob` represents the NotebookExecutionJob ID. * `displayName` supports = and != and regex. * `schedule` supports = and != and regex. Some examples: * `notebookExecutionJob=\"123\"` * `notebookExecutionJob=\"my-execution-job\"` * `displayName=\"myDisplayName\"` and `displayName=~\"myDisplayNameRegex\"`", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. The standard list page token. Typically obtained via ListNotebookExecutionJobs.next_page_token of the previous NotebookService.ListNotebookExecutionJobs call.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The resource name of the Location from which to list the NotebookExecutionJobs. Format: `projects/{project}/locations/{location}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"view": { +"description": "Optional. The NotebookExecutionJob view. Defaults to BASIC.", +"enum": [ +"NOTEBOOK_EXECUTION_JOB_VIEW_UNSPECIFIED", +"NOTEBOOK_EXECUTION_JOB_VIEW_BASIC", +"NOTEBOOK_EXECUTION_JOB_VIEW_FULL" +], +"enumDescriptions": [ +"When unspecified, the API defaults to the BASIC view.", +"Includes all fields except for direct notebook inputs.", +"Includes all fields." +], +"location": "query", +"type": "string" +} +}, +"path": "v1/{+parent}/notebookExecutionJobs", +"response": { +"$ref": "GoogleCloudAiplatformV1ListNotebookExecutionJobsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, "resources": { "operations": { "methods": { @@ -16767,8 +16928,13 @@ "name" ], "parameters": { +"isHuggingFaceModel": { +"description": "Optional. Boolean indicates whether the requested model is a Hugging Face model.", +"location": "query", +"type": "boolean" +}, "languageCode": { -"description": "Optional. The IETF BCP-47 language code representing the language in which the publisher model's text information should be written in (see go/bcp47).", +"description": "Optional. The IETF BCP-47 language code representing the language in which the publisher model's text information should be written in.", "location": "query", "type": "string" }, @@ -16810,11 +16976,11 @@ } } }, -"revision": "20240709", +"revision": "20240715", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionGenerateVideoResponse": { -"description": "Next ID: 8 Generate video response.", +"description": "Generate video response.", "id": "CloudAiLargeModelsVisionGenerateVideoResponse", "properties": { "generatedSamples": { @@ -16835,10 +17001,6 @@ "type": "string" }, "type": "array" -}, -"reportingMetrics": { -"$ref": "IntelligenceCloudAutomlXpsReportingMetrics", -"description": "Billable prediction metrics." } }, "type": "object" @@ -18444,6 +18606,12 @@ }, "readOnly": true, "type": "array" +}, +"score": { +"description": "Output only. Confidence score of the candidate.", +"format": "double", +"readOnly": true, +"type": "number" } }, "type": "object" @@ -18655,21 +18823,21 @@ "id": "GoogleCloudAiplatformV1ComputeTokensRequest", "properties": { "contents": { -"description": "Required. Input content.", +"description": "Optional. Input content.", "items": { "$ref": "GoogleCloudAiplatformV1Content" }, "type": "array" }, "instances": { -"description": "Required. The instances that are the input to token computing API call. Schema is identical to the prediction schema of the text model, even for the non-text models, like chat models, or Codey models.", +"description": "Optional. The instances that are the input to token computing API call. Schema is identical to the prediction schema of the text model, even for the non-text models, like chat models, or Codey models.", "items": { "type": "any" }, "type": "array" }, "model": { -"description": "Required. The name of the publisher model requested to serve the prediction. Format: projects/{project}/locations/{location}/publishers/*/models/*", +"description": "Optional. The name of the publisher model requested to serve the prediction. Format: projects/{project}/locations/{location}/publishers/*/models/*", "type": "string" } }, @@ -18871,22 +19039,33 @@ "id": "GoogleCloudAiplatformV1CountTokensRequest", "properties": { "contents": { -"description": "Required. Input content.", +"description": "Optional. Input content.", "items": { "$ref": "GoogleCloudAiplatformV1Content" }, "type": "array" }, "instances": { -"description": "Required. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model.", +"description": "Optional. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model.", "items": { "type": "any" }, "type": "array" }, "model": { -"description": "Required. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*`", +"description": "Optional. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*`", "type": "string" +}, +"systemInstruction": { +"$ref": "GoogleCloudAiplatformV1Content", +"description": "Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph." +}, +"tools": { +"description": "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.", +"items": { +"$ref": "GoogleCloudAiplatformV1Tool" +}, +"type": "array" } }, "type": "object" @@ -19089,6 +19268,21 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1CreateNotebookExecutionJobOperationMetadata": { +"description": "Metadata information for NotebookService.CreateNotebookExecutionJob.", +"id": "GoogleCloudAiplatformV1CreateNotebookExecutionJobOperationMetadata", +"properties": { +"genericMetadata": { +"$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", +"description": "The operation generic information." +}, +"progressMessage": { +"description": "A human-readable message that shows the intermediate progress details of NotebookRuntime.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1CreateNotebookRuntimeTemplateOperationMetadata": { "description": "Metadata information for NotebookService.CreateNotebookRuntimeTemplate.", "id": "GoogleCloudAiplatformV1CreateNotebookRuntimeTemplateOperationMetadata", @@ -19648,7 +19842,7 @@ "type": "string" }, "name": { -"description": "Output only. The resource name of the Dataset.", +"description": "Output only. Identifier. The resource name of the Dataset.", "readOnly": true, "type": "string" }, @@ -19702,7 +19896,7 @@ "type": "string" }, "name": { -"description": "Output only. The resource name of the DatasetVersion.", +"description": "Output only. Identifier. The resource name of the DatasetVersion.", "readOnly": true, "type": "string" }, @@ -20313,6 +20507,15 @@ "readOnly": true, "type": "string" }, +"dedicatedEndpointDns": { +"description": "Output only. DNS of the dedicated endpoint. Will only be populated if dedicated_endpoint_enabled is true. Format: `https://{endpoint_id}.{region}-{project_number}.prediction.vertexai.goog`.", +"readOnly": true, +"type": "string" +}, +"dedicatedEndpointEnabled": { +"description": "If true, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitation will be removed soon.", +"type": "boolean" +}, "deployedModels": { "description": "Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively.", "items": { @@ -23546,45 +23749,6 @@ }, "type": "object" }, -"GoogleCloudAiplatformV1GroundingAttribution": { -"description": "Grounding attribution.", -"id": "GoogleCloudAiplatformV1GroundingAttribution", -"properties": { -"confidenceScore": { -"description": "Optional. Output only. Confidence score of the attribution. Ranges from 0 to 1. 1 is the most confident.", -"format": "float", -"readOnly": true, -"type": "number" -}, -"segment": { -"$ref": "GoogleCloudAiplatformV1Segment", -"description": "Output only. Segment of the content this attribution belongs to.", -"readOnly": true -}, -"web": { -"$ref": "GoogleCloudAiplatformV1GroundingAttributionWeb", -"description": "Optional. Attribution from the web." -} -}, -"type": "object" -}, -"GoogleCloudAiplatformV1GroundingAttributionWeb": { -"description": "Attribution from the web.", -"id": "GoogleCloudAiplatformV1GroundingAttributionWeb", -"properties": { -"title": { -"description": "Output only. Title of the attribution.", -"readOnly": true, -"type": "string" -}, -"uri": { -"description": "Output only. URI reference of the attribution.", -"readOnly": true, -"type": "string" -} -}, -"type": "object" -}, "GoogleCloudAiplatformV1GroundingChunk": { "description": "Grounding chunk.", "id": "GoogleCloudAiplatformV1GroundingChunk", @@ -23634,13 +23798,6 @@ "description": "Metadata returned to client when grounding is enabled.", "id": "GoogleCloudAiplatformV1GroundingMetadata", "properties": { -"groundingAttributions": { -"description": "Optional. List of grounding attributions.", -"items": { -"$ref": "GoogleCloudAiplatformV1GroundingAttribution" -}, -"type": "array" -}, "groundingChunks": { "description": "List of supporting references retrieved from specified grounding source.", "items": { @@ -25082,6 +25239,24 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1ListNotebookExecutionJobsResponse": { +"description": "Response message for [NotebookService.CreateNotebookExecutionJob]", +"id": "GoogleCloudAiplatformV1ListNotebookExecutionJobsResponse", +"properties": { +"nextPageToken": { +"description": "A token to retrieve next page of results. Pass to ListNotebookExecutionJobs.page_token to obtain that page.", +"type": "string" +}, +"notebookExecutionJobs": { +"description": "List of NotebookExecutionJobs in the requested page.", +"items": { +"$ref": "GoogleCloudAiplatformV1NotebookExecutionJob" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1ListNotebookRuntimeTemplatesResponse": { "description": "Response message for NotebookService.ListNotebookRuntimeTemplates.", "id": "GoogleCloudAiplatformV1ListNotebookRuntimeTemplatesResponse", @@ -27420,6 +27595,13 @@ false "format": "int32", "type": "integer" }, +"numericFilters": { +"description": "Optional. The list of numeric filters.", +"items": { +"$ref": "GoogleCloudAiplatformV1NearestNeighborQueryNumericFilter" +}, +"type": "array" +}, "parameters": { "$ref": "GoogleCloudAiplatformV1NearestNeighborQueryParameters", "description": "Optional. Parameters that can be set to tune query on the fly." @@ -27454,6 +27636,54 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1NearestNeighborQueryNumericFilter": { +"description": "Numeric filter is used to search a subset of the entities by using boolean rules on numeric columns. For example: Database Point 0: {name: \u201ca\u201d value_int: 42} {name: \u201cb\u201d value_float: 1.0} Database Point 1: {name: \u201ca\u201d value_int: 10} {name: \u201cb\u201d value_float: 2.0} Database Point 2: {name: \u201ca\u201d value_int: -1} {name: \u201cb\u201d value_float: 3.0} Query: {name: \u201ca\u201d value_int: 12 operator: LESS} // Matches Point 1, 2 {name: \u201cb\u201d value_float: 2.0 operator: EQUAL} // Matches Point 1", +"id": "GoogleCloudAiplatformV1NearestNeighborQueryNumericFilter", +"properties": { +"name": { +"description": "Required. Column name in BigQuery that used as filters.", +"type": "string" +}, +"op": { +"description": "Optional. This MUST be specified for queries and must NOT be specified for database points.", +"enum": [ +"OPERATOR_UNSPECIFIED", +"LESS", +"LESS_EQUAL", +"EQUAL", +"GREATER_EQUAL", +"GREATER", +"NOT_EQUAL" +], +"enumDescriptions": [ +"Unspecified operator.", +"Entities are eligible if their value is < the query's.", +"Entities are eligible if their value is <= the query's.", +"Entities are eligible if their value is == the query's.", +"Entities are eligible if their value is >= the query's.", +"Entities are eligible if their value is > the query's.", +"Entities are eligible if their value is != the query's." +], +"type": "string" +}, +"valueDouble": { +"description": "double value type.", +"format": "double", +"type": "number" +}, +"valueFloat": { +"description": "float value type.", +"format": "float", +"type": "number" +}, +"valueInt": { +"description": "int value type.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1NearestNeighborQueryParameters": { "description": "Parameters that can be overrided in each query to tune query latency and recall.", "id": "GoogleCloudAiplatformV1NearestNeighborQueryParameters", @@ -27724,6 +27954,159 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1NotebookExecutionJob": { +"description": "NotebookExecutionJob represents an instance of a notebook execution.", +"id": "GoogleCloudAiplatformV1NotebookExecutionJob", +"properties": { +"createTime": { +"description": "Output only. Timestamp when this NotebookExecutionJob was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"dataformRepositorySource": { +"$ref": "GoogleCloudAiplatformV1NotebookExecutionJobDataformRepositorySource", +"description": "The Dataform Repository pointing to a single file notebook repository." +}, +"directNotebookSource": { +"$ref": "GoogleCloudAiplatformV1NotebookExecutionJobDirectNotebookSource", +"description": "The contents of an input notebook file." +}, +"displayName": { +"description": "The display name of the NotebookExecutionJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.", +"type": "string" +}, +"executionTimeout": { +"description": "Max running time of the execution job in seconds (default 86400s / 24 hrs).", +"format": "google-duration", +"type": "string" +}, +"executionUser": { +"description": "The user email to run the execution as. Only supported by Colab runtimes.", +"type": "string" +}, +"gcsNotebookSource": { +"$ref": "GoogleCloudAiplatformV1NotebookExecutionJobGcsNotebookSource", +"description": "The Cloud Storage url pointing to the ipynb file. Format: `gs://bucket/notebook_file.ipynb`" +}, +"gcsOutputUri": { +"description": "The Cloud Storage location to upload the result to. Format: `gs://bucket-name`", +"type": "string" +}, +"jobState": { +"description": "Output only. The state of the NotebookExecutionJob.", +"enum": [ +"JOB_STATE_UNSPECIFIED", +"JOB_STATE_QUEUED", +"JOB_STATE_PENDING", +"JOB_STATE_RUNNING", +"JOB_STATE_SUCCEEDED", +"JOB_STATE_FAILED", +"JOB_STATE_CANCELLING", +"JOB_STATE_CANCELLED", +"JOB_STATE_PAUSED", +"JOB_STATE_EXPIRED", +"JOB_STATE_UPDATING", +"JOB_STATE_PARTIALLY_SUCCEEDED" +], +"enumDescriptions": [ +"The job state is unspecified.", +"The job has been just created or resumed and processing has not yet begun.", +"The service is preparing to run the job.", +"The job is in progress.", +"The job completed successfully.", +"The job failed.", +"The job is being cancelled. From this state the job may only go to either `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`.", +"The job has been cancelled.", +"The job has been stopped, and can be resumed.", +"The job has expired.", +"The job is being updated. Only jobs in the `RUNNING` state can be updated. After updating, the job goes back to the `RUNNING` state.", +"The job is partially succeeded, some results may be missing due to errors." +], +"readOnly": true, +"type": "string" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "The labels with user-defined metadata to organize NotebookExecutionJobs. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with \"aiplatform.googleapis.com/\" and are immutable.", +"type": "object" +}, +"name": { +"description": "Output only. The resource name of this NotebookExecutionJob. Format: `projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}`", +"readOnly": true, +"type": "string" +}, +"notebookRuntimeTemplateResourceName": { +"description": "The NotebookRuntimeTemplate to source compute configuration from.", +"type": "string" +}, +"scheduleResourceName": { +"description": "Output only. The Schedule resource name if this job is triggered by one. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`", +"readOnly": true, +"type": "string" +}, +"serviceAccount": { +"description": "The service account to run the execution as.", +"type": "string" +}, +"status": { +"$ref": "GoogleRpcStatus", +"description": "Output only. Populated when the NotebookExecutionJob is completed. When there is an error during notebook execution, the error details are populated.", +"readOnly": true +}, +"updateTime": { +"description": "Output only. Timestamp when this NotebookExecutionJob was most recently updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1NotebookExecutionJobDataformRepositorySource": { +"description": "The Dataform Repository containing the input notebook.", +"id": "GoogleCloudAiplatformV1NotebookExecutionJobDataformRepositorySource", +"properties": { +"commitSha": { +"description": "The commit SHA to read repository with. If unset, the file will be read at HEAD.", +"type": "string" +}, +"dataformRepositoryResourceName": { +"description": "The resource name of the Dataform Repository. Format: `projects/{project_id}/locations/{location}/repositories/{repository_id}`", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1NotebookExecutionJobDirectNotebookSource": { +"description": "The content of the input notebook in ipynb format.", +"id": "GoogleCloudAiplatformV1NotebookExecutionJobDirectNotebookSource", +"properties": { +"content": { +"description": "The base64-encoded contents of the input notebook file.", +"format": "byte", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1NotebookExecutionJobGcsNotebookSource": { +"description": "The Cloud Storage uri for the input notebook.", +"id": "GoogleCloudAiplatformV1NotebookExecutionJobGcsNotebookSource", +"properties": { +"generation": { +"description": "The version of the Cloud Storage object to read. If unset, the current version of the object is read. See https://cloud.google.com/storage/docs/metadata#generation-number.", +"type": "string" +}, +"uri": { +"description": "The Cloud Storage uri pointing to the ipynb file. Format: `gs://bucket/notebook_file.ipynb`", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1NotebookIdleShutdownConfig": { "description": "The idle shutdown configuration of NotebookRuntimeTemplate, which contains the idle_timeout as required field.", "id": "GoogleCloudAiplatformV1NotebookIdleShutdownConfig", @@ -28290,6 +28673,10 @@ false "description": "Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to peered with Vertex AI to host the persistent resources. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the resources aren't peered with any network.", "type": "string" }, +"pscInterfaceConfig": { +"$ref": "GoogleCloudAiplatformV1PscInterfaceConfig", +"description": "Optional. Configuration for PSC-I for PersistentResource." +}, "reservedIpRanges": { "description": "Optional. A list of names for the reserved IP ranges under the VPC network that can be used for this persistent resource. If set, we will deploy the persistent resource within the provided IP ranges. Otherwise, the persistent resource is deployed to any IP ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].", "items": { @@ -29072,6 +29459,17 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1PscInterfaceConfig": { +"description": "Configuration for PSC-I.", +"id": "GoogleCloudAiplatformV1PscInterfaceConfig", +"properties": { +"networkAttachment": { +"description": "Optional. The full name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource. For example, `projects/12345/regions/us-central1/networkAttachments/myNA`. is of the form `projects/{project}/regions/{region}/networkAttachments/{networkAttachment}`. Where {project} is a project number, as in `12345`, and {networkAttachment} is a network attachment name. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1PublisherModel": { "description": "A Model Garden Publisher Model.", "id": "GoogleCloudAiplatformV1PublisherModel", @@ -29945,6 +30343,17 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1RayLogsSpec": { +"description": "Configuration for the Ray OSS Logs.", +"id": "GoogleCloudAiplatformV1RayLogsSpec", +"properties": { +"disabled": { +"description": "Optional. Flag to disable the export of Ray OSS logs to Cloud Logging.", +"type": "boolean" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1RayMetricSpec": { "description": "Configuration for the Ray metrics.", "id": "GoogleCloudAiplatformV1RayMetricSpec", @@ -29968,6 +30377,10 @@ false "description": "Optional. Default image for user to choose a preferred ML framework (for example, TensorFlow or Pytorch) by choosing from [Vertex prebuilt images](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). Either this or the resource_pool_images is required. Use this field if you need all the resource pools to have the same Ray image. Otherwise, use the {@code resource_pool_images} field.", "type": "string" }, +"rayLogsSpec": { +"$ref": "GoogleCloudAiplatformV1RayLogsSpec", +"description": "Optional. OSS Ray logging configurations." +}, "rayMetricSpec": { "$ref": "GoogleCloudAiplatformV1RayMetricSpec", "description": "Optional. Ray metrics configurations." @@ -30375,7 +30788,8 @@ false "id": "GoogleCloudAiplatformV1Retrieval", "properties": { "disableAttribution": { -"description": "Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation.", +"deprecated": true, +"description": "Optional. Deprecated. This option is no longer supported.", "type": "boolean" }, "vertexAiSearch": { @@ -30935,6 +31349,20 @@ false "description": "Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job.", "type": "boolean" }, +"strategy": { +"description": "Optional. This determines which type of scheduling strategy to use.", +"enum": [ +"STRATEGY_UNSPECIFIED", +"ON_DEMAND", +"LOW_COST" +], +"enumDescriptions": [ +"Strategy will default to ON_DEMAND.", +"Regular on-demand provisioning strategy.", +"Low cost by making potential use of spot resources." +], +"type": "string" +}, "timeout": { "description": "The maximum job running time. The default is 7 days.", "format": "google-duration", @@ -32193,6 +32621,7 @@ false "id": "GoogleCloudAiplatformV1SchemaPredictParamsGroundingConfig", "properties": { "disableAttribution": { +"deprecated": true, "description": "If set, skip finding claim attributions (i.e not generate grounding citation).", "type": "boolean" }, @@ -36132,14 +36561,16 @@ false "ADAPTER_SIZE_ONE", "ADAPTER_SIZE_FOUR", "ADAPTER_SIZE_EIGHT", -"ADAPTER_SIZE_SIXTEEN" +"ADAPTER_SIZE_SIXTEEN", +"ADAPTER_SIZE_THIRTY_TWO" ], "enumDescriptions": [ "Adapter size is unspecified.", "Adapter size 1.", "Adapter size 4.", "Adapter size 8.", -"Adapter size 16." +"Adapter size 16.", +"Adapter size 32." ], "type": "string" }, @@ -38486,70 +38917,6 @@ false } }, "type": "object" -}, -"IntelligenceCloudAutomlXpsMetricEntry": { -"id": "IntelligenceCloudAutomlXpsMetricEntry", -"properties": { -"argentumMetricId": { -"description": "For billing metrics that are using legacy sku's, set the legacy billing metric id here. This will be sent to Chemist as the \"cloudbilling.googleapis.com/argentum_metric_id\" label. Otherwise leave empty.", -"type": "string" -}, -"doubleValue": { -"description": "A double value.", -"format": "double", -"type": "number" -}, -"int64Value": { -"description": "A signed 64-bit integer value.", -"format": "int64", -"type": "string" -}, -"metricName": { -"description": "The metric name defined in the service configuration.", -"type": "string" -}, -"systemLabels": { -"description": "Billing system labels for this (metric, value) pair.", -"items": { -"$ref": "IntelligenceCloudAutomlXpsMetricEntryLabel" -}, -"type": "array" -} -}, -"type": "object" -}, -"IntelligenceCloudAutomlXpsMetricEntryLabel": { -"id": "IntelligenceCloudAutomlXpsMetricEntryLabel", -"properties": { -"labelName": { -"description": "The name of the label.", -"type": "string" -}, -"labelValue": { -"description": "The value of the label.", -"type": "string" -} -}, -"type": "object" -}, -"IntelligenceCloudAutomlXpsReportingMetrics": { -"id": "IntelligenceCloudAutomlXpsReportingMetrics", -"properties": { -"effectiveTrainingDuration": { -"deprecated": true, -"description": "The effective time training used. If set, this is used for quota management and billing. Deprecated. AutoML BE doesn't use this. Don't set.", -"format": "google-duration", -"type": "string" -}, -"metricEntries": { -"description": "One entry per metric name. The values must be aggregated per metric name.", -"items": { -"$ref": "IntelligenceCloudAutomlXpsMetricEntry" -}, -"type": "array" -} -}, -"type": "object" } }, "servicePath": "", diff --git a/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json b/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json index 6e14dd34949..589feb70cf0 100644 --- a/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json @@ -1980,7 +1980,7 @@ ], "parameters": { "name": { -"description": "Output only. The resource name of the Dataset.", +"description": "Output only. Identifier. The resource name of the Dataset.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "required": true, @@ -2857,7 +2857,7 @@ ], "parameters": { "name": { -"description": "Output only. The resource name of the DatasetVersion.", +"description": "Output only. Identifier. The resource name of the DatasetVersion.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/datasetVersions/[^/]+$", "required": true, @@ -20336,8 +20336,13 @@ "name" ], "parameters": { +"isHuggingFaceModel": { +"description": "Optional. Boolean indicates whether the requested model is a Hugging Face model.", +"location": "query", +"type": "boolean" +}, "languageCode": { -"description": "Optional. The IETF BCP-47 language code representing the language in which the publisher model's text information should be written in (see go/bcp47).", +"description": "Optional. The IETF BCP-47 language code representing the language in which the publisher model's text information should be written in.", "location": "query", "type": "string" }, @@ -20389,7 +20394,7 @@ "type": "string" }, "languageCode": { -"description": "Optional. The IETF BCP-47 language code representing the language in which the publisher models' text information should be written in (see go/bcp47). If not set, by default English (en).", +"description": "Optional. The IETF BCP-47 language code representing the language in which the publisher models' text information should be written in. If not set, by default English (en).", "location": "query", "type": "string" }, @@ -20447,11 +20452,11 @@ } } }, -"revision": "20240709", +"revision": "20240715", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionGenerateVideoResponse": { -"description": "Next ID: 8 Generate video response.", +"description": "Generate video response.", "id": "CloudAiLargeModelsVisionGenerateVideoResponse", "properties": { "generatedSamples": { @@ -20472,10 +20477,6 @@ "type": "string" }, "type": "array" -}, -"reportingMetrics": { -"$ref": "IntelligenceCloudAutomlXpsReportingMetrics", -"description": "Billable prediction metrics." } }, "type": "object" @@ -21002,6 +21003,17 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1beta1ApiAuthApiKeyConfig": { +"description": "The API secret.", +"id": "GoogleCloudAiplatformV1beta1ApiAuthApiKeyConfig", +"properties": { +"apiKeySecretVersion": { +"description": "Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version}", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1Artifact": { "description": "Instance of a general artifact.", "id": "GoogleCloudAiplatformV1beta1Artifact", @@ -22339,6 +22351,12 @@ }, "readOnly": true, "type": "array" +}, +"score": { +"description": "Output only. Confidence score of the candidate.", +"format": "double", +"readOnly": true, +"type": "number" } }, "type": "object" @@ -22550,21 +22568,21 @@ "id": "GoogleCloudAiplatformV1beta1ComputeTokensRequest", "properties": { "contents": { -"description": "Required. Input content.", +"description": "Optional. Input content.", "items": { "$ref": "GoogleCloudAiplatformV1beta1Content" }, "type": "array" }, "instances": { -"description": "Required. The instances that are the input to token computing API call. Schema is identical to the prediction schema of the text model, even for the non-text models, like chat models, or Codey models.", +"description": "Optional. The instances that are the input to token computing API call. Schema is identical to the prediction schema of the text model, even for the non-text models, like chat models, or Codey models.", "items": { "type": "any" }, "type": "array" }, "model": { -"description": "Required. The name of the publisher model requested to serve the prediction. Format: projects/{project}/locations/{location}/publishers/*/models/*", +"description": "Optional. The name of the publisher model requested to serve the prediction. Format: projects/{project}/locations/{location}/publishers/*/models/*", "type": "string" } }, @@ -22766,22 +22784,33 @@ "id": "GoogleCloudAiplatformV1beta1CountTokensRequest", "properties": { "contents": { -"description": "Required. Input content.", +"description": "Optional. Input content.", "items": { "$ref": "GoogleCloudAiplatformV1beta1Content" }, "type": "array" }, "instances": { -"description": "Required. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model.", +"description": "Optional. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model.", "items": { "type": "any" }, "type": "array" }, "model": { -"description": "Required. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*`", +"description": "Optional. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*`", "type": "string" +}, +"systemInstruction": { +"$ref": "GoogleCloudAiplatformV1beta1Content", +"description": "Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph." +}, +"tools": { +"description": "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.", +"items": { +"$ref": "GoogleCloudAiplatformV1beta1Tool" +}, +"type": "array" } }, "type": "object" @@ -23629,7 +23658,7 @@ "type": "string" }, "name": { -"description": "Output only. The resource name of the Dataset.", +"description": "Output only. Identifier. The resource name of the Dataset.", "readOnly": true, "type": "string" }, @@ -23683,7 +23712,7 @@ "type": "string" }, "name": { -"description": "Output only. The resource name of the DatasetVersion.", +"description": "Output only. Identifier. The resource name of the DatasetVersion.", "readOnly": true, "type": "string" }, @@ -24311,6 +24340,15 @@ "readOnly": true, "type": "string" }, +"dedicatedEndpointDns": { +"description": "Output only. DNS of the dedicated endpoint. Will only be populated if dedicated_endpoint_enabled is true. Format: `https://{endpoint_id}.{region}-{project_number}.prediction.vertexai.goog`.", +"readOnly": true, +"type": "string" +}, +"dedicatedEndpointEnabled": { +"description": "If true, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitation will be removed soon.", +"type": "boolean" +}, "deployedModels": { "description": "Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively.", "items": { @@ -27920,66 +27958,6 @@ }, "type": "object" }, -"GoogleCloudAiplatformV1beta1GroundingAttribution": { -"description": "Grounding attribution.", -"id": "GoogleCloudAiplatformV1beta1GroundingAttribution", -"properties": { -"confidenceScore": { -"description": "Optional. Output only. Confidence score of the attribution. Ranges from 0 to 1. 1 is the most confident.", -"format": "float", -"readOnly": true, -"type": "number" -}, -"retrievedContext": { -"$ref": "GoogleCloudAiplatformV1beta1GroundingAttributionRetrievedContext", -"description": "Optional. Attribution from context retrieved by the retrieval tools." -}, -"segment": { -"$ref": "GoogleCloudAiplatformV1beta1Segment", -"description": "Output only. Segment of the content this attribution belongs to.", -"readOnly": true -}, -"web": { -"$ref": "GoogleCloudAiplatformV1beta1GroundingAttributionWeb", -"description": "Optional. Attribution from the web." -} -}, -"type": "object" -}, -"GoogleCloudAiplatformV1beta1GroundingAttributionRetrievedContext": { -"description": "Attribution from context retrieved by the retrieval tools.", -"id": "GoogleCloudAiplatformV1beta1GroundingAttributionRetrievedContext", -"properties": { -"title": { -"description": "Output only. Title of the attribution.", -"readOnly": true, -"type": "string" -}, -"uri": { -"description": "Output only. URI reference of the attribution.", -"readOnly": true, -"type": "string" -} -}, -"type": "object" -}, -"GoogleCloudAiplatformV1beta1GroundingAttributionWeb": { -"description": "Attribution from the web.", -"id": "GoogleCloudAiplatformV1beta1GroundingAttributionWeb", -"properties": { -"title": { -"description": "Output only. Title of the attribution.", -"readOnly": true, -"type": "string" -}, -"uri": { -"description": "Output only. URI reference of the attribution.", -"readOnly": true, -"type": "string" -} -}, -"type": "object" -}, "GoogleCloudAiplatformV1beta1GroundingChunk": { "description": "Grounding chunk.", "id": "GoogleCloudAiplatformV1beta1GroundingChunk", @@ -28029,13 +28007,6 @@ "description": "Metadata returned to client when grounding is enabled.", "id": "GoogleCloudAiplatformV1beta1GroundingMetadata", "properties": { -"groundingAttributions": { -"description": "Optional. List of grounding attributions.", -"items": { -"$ref": "GoogleCloudAiplatformV1beta1GroundingAttribution" -}, -"type": "array" -}, "groundingChunks": { "description": "List of supporting references retrieved from specified grounding source.", "items": { @@ -28463,6 +28434,10 @@ "$ref": "GoogleCloudAiplatformV1beta1GoogleDriveSource", "description": "Google Drive location. Supports importing individual files as well as Google Drive folders." }, +"jiraSource": { +"$ref": "GoogleCloudAiplatformV1beta1JiraSource", +"description": "Jira queries with their corresponding authentication." +}, "maxEmbeddingRequestsPerMin": { "description": "Optional. The max number of queries per minute that this job is allowed to make to the embedding model specified on the corpus. This value is specific to this job and not shared across other import jobs. Consult the Quotas page on the project to set an appropriate value here. If unspecified, a default value of 1,000 QPM would be used.", "format": "int32", @@ -28471,6 +28446,10 @@ "ragFileChunkingConfig": { "$ref": "GoogleCloudAiplatformV1beta1RagFileChunkingConfig", "description": "Specifies the size and overlap of chunks after importing RagFiles." +}, +"slackSource": { +"$ref": "GoogleCloudAiplatformV1beta1SlackSource", +"description": "Slack channels with their corresponding access tokens." } }, "type": "object" @@ -28984,6 +28963,53 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1beta1JiraSource": { +"description": "The Jira source for the ImportRagFilesRequest.", +"id": "GoogleCloudAiplatformV1beta1JiraSource", +"properties": { +"jiraQueries": { +"description": "Required. The Jira queries.", +"items": { +"$ref": "GoogleCloudAiplatformV1beta1JiraSourceJiraQueries" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1JiraSourceJiraQueries": { +"description": "JiraQueries contains the Jira queries and corresponding authentication.", +"id": "GoogleCloudAiplatformV1beta1JiraSourceJiraQueries", +"properties": { +"apiKeyConfig": { +"$ref": "GoogleCloudAiplatformV1beta1ApiAuthApiKeyConfig", +"description": "Required. The SecretManager secret version resource name (e.g. projects/{project}/secrets/{secret}/versions/{version}) storing the Jira API key (https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/)." +}, +"customQueries": { +"description": "A list of custom Jira queries to import. For information about JQL (Jira Query Language), see https://support.atlassian.com/jira-service-management-cloud/docs/use-advanced-search-with-jira-query-language-jql/", +"items": { +"type": "string" +}, +"type": "array" +}, +"email": { +"description": "Required. The Jira email address.", +"type": "string" +}, +"projects": { +"description": "A list of Jira projects to import in their entirety.", +"items": { +"type": "string" +}, +"type": "array" +}, +"serverUri": { +"description": "Required. The Jira server URI.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1LargeModelReference": { "description": "Contains information about the Large Model.", "id": "GoogleCloudAiplatformV1beta1LargeModelReference", @@ -31373,6 +31399,16 @@ false "$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringOutputSpec", "description": "Optional default monitoring metrics/logs export spec, it can be overridden in the ModelMonitoringJob output spec. If not specified, a default Google Cloud Storage bucket will be created under your project." }, +"satisfiesPzi": { +"description": "Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" +}, +"satisfiesPzs": { +"description": "Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" +}, "tabularObjective": { "$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringObjectiveSpecTabularObjective", "description": "Optional default tabular model monitoring objective." @@ -32838,6 +32874,13 @@ false "format": "int32", "type": "integer" }, +"numericFilters": { +"description": "Optional. The list of numeric filters.", +"items": { +"$ref": "GoogleCloudAiplatformV1beta1NearestNeighborQueryNumericFilter" +}, +"type": "array" +}, "parameters": { "$ref": "GoogleCloudAiplatformV1beta1NearestNeighborQueryParameters", "description": "Optional. Parameters that can be set to tune query on the fly." @@ -32872,6 +32915,54 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1beta1NearestNeighborQueryNumericFilter": { +"description": "Numeric filter is used to search a subset of the entities by using boolean rules on numeric columns. For example: Database Point 0: {name: \u201ca\u201d value_int: 42} {name: \u201cb\u201d value_float: 1.0} Database Point 1: {name: \u201ca\u201d value_int: 10} {name: \u201cb\u201d value_float: 2.0} Database Point 2: {name: \u201ca\u201d value_int: -1} {name: \u201cb\u201d value_float: 3.0} Query: {name: \u201ca\u201d value_int: 12 operator: LESS} // Matches Point 1, 2 {name: \u201cb\u201d value_float: 2.0 operator: EQUAL} // Matches Point 1", +"id": "GoogleCloudAiplatformV1beta1NearestNeighborQueryNumericFilter", +"properties": { +"name": { +"description": "Required. Column name in BigQuery that used as filters.", +"type": "string" +}, +"op": { +"description": "Optional. This MUST be specified for queries and must NOT be specified for database points.", +"enum": [ +"OPERATOR_UNSPECIFIED", +"LESS", +"LESS_EQUAL", +"EQUAL", +"GREATER_EQUAL", +"GREATER", +"NOT_EQUAL" +], +"enumDescriptions": [ +"Unspecified operator.", +"Entities are eligible if their value is < the query's.", +"Entities are eligible if their value is <= the query's.", +"Entities are eligible if their value is == the query's.", +"Entities are eligible if their value is >= the query's.", +"Entities are eligible if their value is > the query's.", +"Entities are eligible if their value is != the query's." +], +"type": "string" +}, +"valueDouble": { +"description": "double value type.", +"format": "double", +"type": "number" +}, +"valueFloat": { +"description": "float value type.", +"format": "float", +"type": "number" +}, +"valueInt": { +"description": "int value type.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1NearestNeighborQueryParameters": { "description": "Parameters that can be overrided in each query to tune query latency and recall.", "id": "GoogleCloudAiplatformV1beta1NearestNeighborQueryParameters", @@ -33861,6 +33952,10 @@ false "description": "Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to peered with Vertex AI to host the persistent resources. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the resources aren't peered with any network.", "type": "string" }, +"pscInterfaceConfig": { +"$ref": "GoogleCloudAiplatformV1beta1PscInterfaceConfig", +"description": "Optional. Configuration for PSC-I for PersistentResource." +}, "reservedIpRanges": { "description": "Optional. A list of names for the reserved IP ranges under the VPC network that can be used for this persistent resource. If set, we will deploy the persistent resource within the provided IP ranges. Otherwise, the persistent resource is deployed to any IP ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].", "items": { @@ -33995,6 +34090,16 @@ false "$ref": "GoogleCloudAiplatformV1beta1PipelineJobRuntimeConfig", "description": "Runtime config of the pipeline." }, +"satisfiesPzi": { +"description": "Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" +}, +"satisfiesPzs": { +"description": "Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" +}, "scheduleName": { "description": "Output only. The schedule resource name. Only returned if the Pipeline is created by Schedule API.", "readOnly": true, @@ -34643,6 +34748,17 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1beta1PscInterfaceConfig": { +"description": "Configuration for PSC-I.", +"id": "GoogleCloudAiplatformV1beta1PscInterfaceConfig", +"properties": { +"networkAttachment": { +"description": "Optional. The full name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource. For example, `projects/12345/regions/us-central1/networkAttachments/myNA`. is of the form `projects/{project}/regions/{region}/networkAttachments/{networkAttachment}`. Where {project} is a project number, as in `12345`, and {networkAttachment} is a network attachment name. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1PublisherModel": { "description": "A Model Garden Publisher Model.", "id": "GoogleCloudAiplatformV1beta1PublisherModel", @@ -35717,6 +35833,10 @@ false "description": "Output only. Google Drive location. Supports importing individual files as well as Google Drive folders.", "readOnly": true }, +"jiraSource": { +"$ref": "GoogleCloudAiplatformV1beta1JiraSource", +"description": "The RagFile is imported from a Jira query." +}, "name": { "description": "Output only. The resource name of the RagFile.", "readOnly": true, @@ -35743,6 +35863,10 @@ false "readOnly": true, "type": "string" }, +"slackSource": { +"$ref": "GoogleCloudAiplatformV1beta1SlackSource", +"description": "The RagFile is imported from a Slack channel." +}, "updateTime": { "description": "Output only. Timestamp when this RagFile was last updated.", "format": "google-datetime", @@ -35796,6 +35920,17 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1beta1RayLogsSpec": { +"description": "Configuration for the Ray OSS Logs.", +"id": "GoogleCloudAiplatformV1beta1RayLogsSpec", +"properties": { +"disabled": { +"description": "Optional. Flag to disable the export of Ray OSS logs to Cloud Logging.", +"type": "boolean" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1RayMetricSpec": { "description": "Configuration for the Ray metrics.", "id": "GoogleCloudAiplatformV1beta1RayMetricSpec", @@ -35819,6 +35954,10 @@ false "description": "Optional. Default image for user to choose a preferred ML framework (for example, TensorFlow or Pytorch) by choosing from [Vertex prebuilt images](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). Either this or the resource_pool_images is required. Use this field if you need all the resource pools to have the same Ray image. Otherwise, use the {@code resource_pool_images} field.", "type": "string" }, +"rayLogsSpec": { +"$ref": "GoogleCloudAiplatformV1beta1RayLogsSpec", +"description": "Optional. OSS Ray logging configurations." +}, "rayMetricSpec": { "$ref": "GoogleCloudAiplatformV1beta1RayMetricSpec", "description": "Optional. Ray metrics configurations." @@ -36411,7 +36550,8 @@ false "id": "GoogleCloudAiplatformV1beta1Retrieval", "properties": { "disableAttribution": { -"description": "Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation.", +"deprecated": true, +"description": "Optional. Deprecated. This option is no longer supported.", "type": "boolean" }, "vertexAiSearch": { @@ -37105,6 +37245,20 @@ false "description": "Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job.", "type": "boolean" }, +"strategy": { +"description": "Optional. This determines which type of scheduling strategy to use.", +"enum": [ +"STRATEGY_UNSPECIFIED", +"ON_DEMAND", +"LOW_COST" +], +"enumDescriptions": [ +"Strategy will default to ON_DEMAND.", +"Regular on-demand provisioning strategy.", +"Low cost by making potential use of spot resources." +], +"type": "string" +}, "timeout": { "description": "The maximum job running time. The default is 7 days.", "format": "google-duration", @@ -41271,6 +41425,59 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1beta1SlackSource": { +"description": "The Slack source for the ImportRagFilesRequest.", +"id": "GoogleCloudAiplatformV1beta1SlackSource", +"properties": { +"channels": { +"description": "Required. The Slack channels.", +"items": { +"$ref": "GoogleCloudAiplatformV1beta1SlackSourceSlackChannels" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1SlackSourceSlackChannels": { +"description": "SlackChannels contains the Slack channels and corresponding access token.", +"id": "GoogleCloudAiplatformV1beta1SlackSourceSlackChannels", +"properties": { +"apiKeyConfig": { +"$ref": "GoogleCloudAiplatformV1beta1ApiAuthApiKeyConfig", +"description": "Required. The SecretManager secret version resource name (e.g. projects/{project}/secrets/{secret}/versions/{version}) storing the Slack channel access token that has access to the slack channel IDs. See: https://api.slack.com/tutorials/tracks/getting-a-token." +}, +"channels": { +"description": "Required. The Slack channel IDs.", +"items": { +"$ref": "GoogleCloudAiplatformV1beta1SlackSourceSlackChannelsSlackChannel" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1SlackSourceSlackChannelsSlackChannel": { +"description": "SlackChannel contains the Slack channel ID and the time range to import.", +"id": "GoogleCloudAiplatformV1beta1SlackSourceSlackChannelsSlackChannel", +"properties": { +"channelId": { +"description": "Required. The Slack channel ID.", +"type": "string" +}, +"endTime": { +"description": "Optional. The ending timestamp for messages to import.", +"format": "google-datetime", +"type": "string" +}, +"startTime": { +"description": "Optional. The starting timestamp for messages to import.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1SmoothGradConfig": { "description": "Config for SmoothGrad approximation of gradients. When enabled, the gradients are approximated by averaging the gradients from noisy samples in the vicinity of the inputs. Adding noise can help improve the computed gradients. Refer to this paper for more details: https://arxiv.org/pdf/1706.03825.pdf", "id": "GoogleCloudAiplatformV1beta1SmoothGradConfig", @@ -42412,14 +42619,16 @@ false "ADAPTER_SIZE_ONE", "ADAPTER_SIZE_FOUR", "ADAPTER_SIZE_EIGHT", -"ADAPTER_SIZE_SIXTEEN" +"ADAPTER_SIZE_SIXTEEN", +"ADAPTER_SIZE_THIRTY_TWO" ], "enumDescriptions": [ "Adapter size is unspecified.", "Adapter size 1.", "Adapter size 4.", "Adapter size 8.", -"Adapter size 16." +"Adapter size 16.", +"Adapter size 32." ], "type": "string" }, @@ -44974,70 +45183,6 @@ false } }, "type": "object" -}, -"IntelligenceCloudAutomlXpsMetricEntry": { -"id": "IntelligenceCloudAutomlXpsMetricEntry", -"properties": { -"argentumMetricId": { -"description": "For billing metrics that are using legacy sku's, set the legacy billing metric id here. This will be sent to Chemist as the \"cloudbilling.googleapis.com/argentum_metric_id\" label. Otherwise leave empty.", -"type": "string" -}, -"doubleValue": { -"description": "A double value.", -"format": "double", -"type": "number" -}, -"int64Value": { -"description": "A signed 64-bit integer value.", -"format": "int64", -"type": "string" -}, -"metricName": { -"description": "The metric name defined in the service configuration.", -"type": "string" -}, -"systemLabels": { -"description": "Billing system labels for this (metric, value) pair.", -"items": { -"$ref": "IntelligenceCloudAutomlXpsMetricEntryLabel" -}, -"type": "array" -} -}, -"type": "object" -}, -"IntelligenceCloudAutomlXpsMetricEntryLabel": { -"id": "IntelligenceCloudAutomlXpsMetricEntryLabel", -"properties": { -"labelName": { -"description": "The name of the label.", -"type": "string" -}, -"labelValue": { -"description": "The value of the label.", -"type": "string" -} -}, -"type": "object" -}, -"IntelligenceCloudAutomlXpsReportingMetrics": { -"id": "IntelligenceCloudAutomlXpsReportingMetrics", -"properties": { -"effectiveTrainingDuration": { -"deprecated": true, -"description": "The effective time training used. If set, this is used for quota management and billing. Deprecated. AutoML BE doesn't use this. Don't set.", -"format": "google-duration", -"type": "string" -}, -"metricEntries": { -"description": "One entry per metric name. The values must be aggregated per metric name.", -"items": { -"$ref": "IntelligenceCloudAutomlXpsMetricEntry" -}, -"type": "array" -} -}, -"type": "object" } }, "servicePath": "", diff --git a/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json b/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json index 93e1b0aae25..ef2e4a58f17 100644 --- a/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json @@ -209,7 +209,7 @@ ], "parameters": { "name": { -"description": "Required. The name of the settings to lookup. Format: accounts/{account}/dataSharingSettings Example: \"accounts/1000/dataSharingSettings\"", +"description": "Required. The name of the settings to lookup. Format: accounts/{account}/dataSharingSettings Example: `accounts/1000/dataSharingSettings`", "location": "path", "pattern": "^accounts/[^/]+/dataSharingSettings$", "required": true, @@ -349,7 +349,7 @@ ], "parameters": { "account": { -"description": "Required. The account resource for which to return change history resources. Format: accounts/{account} Example: \"accounts/100\"", +"description": "Required. The account resource for which to return change history resources. Format: accounts/{account} Example: `accounts/100`", "location": "path", "pattern": "^accounts/[^/]+$", "required": true, @@ -2180,7 +2180,7 @@ "methods": { "create": { "deprecated": true, -"description": "Creates a conversion event with the specified attributes.", +"description": "Deprecated: Use `CreateKeyEvent` instead. Creates a conversion event with the specified attributes.", "flatPath": "v1alpha/properties/{propertiesId}/conversionEvents", "httpMethod": "POST", "id": "analyticsadmin.properties.conversionEvents.create", @@ -2209,7 +2209,7 @@ }, "delete": { "deprecated": true, -"description": "Deletes a conversion event in a property.", +"description": "Deprecated: Use `DeleteKeyEvent` instead. Deletes a conversion event in a property.", "flatPath": "v1alpha/properties/{propertiesId}/conversionEvents/{conversionEventsId}", "httpMethod": "DELETE", "id": "analyticsadmin.properties.conversionEvents.delete", @@ -2235,7 +2235,7 @@ }, "get": { "deprecated": true, -"description": "Retrieve a single conversion event.", +"description": "Deprecated: Use `GetKeyEvent` instead. Retrieve a single conversion event.", "flatPath": "v1alpha/properties/{propertiesId}/conversionEvents/{conversionEventsId}", "httpMethod": "GET", "id": "analyticsadmin.properties.conversionEvents.get", @@ -2262,7 +2262,7 @@ }, "list": { "deprecated": true, -"description": "Returns a list of conversion events in the specified parent property. Returns an empty list if no conversion events are found.", +"description": "Deprecated: Use `ListKeyEvents` instead. Returns a list of conversion events in the specified parent property. Returns an empty list if no conversion events are found.", "flatPath": "v1alpha/properties/{propertiesId}/conversionEvents", "httpMethod": "GET", "id": "analyticsadmin.properties.conversionEvents.list", @@ -2300,7 +2300,7 @@ }, "patch": { "deprecated": true, -"description": "Updates a conversion event with the specified attributes.", +"description": "Deprecated: Use `UpdateKeyEvent` instead. Updates a conversion event with the specified attributes.", "flatPath": "v1alpha/properties/{propertiesId}/conversionEvents/{conversionEventsId}", "httpMethod": "PATCH", "id": "analyticsadmin.properties.conversionEvents.patch", @@ -2792,7 +2792,7 @@ ], "parameters": { "name": { -"description": "Required. The name of the site tag to lookup. Note that site tags are singletons and do not have unique IDs. Format: properties/{property_id}/dataStreams/{stream_id}/globalSiteTag Example: \"properties/123/dataStreams/456/globalSiteTag\"", +"description": "Required. The name of the site tag to lookup. Note that site tags are singletons and do not have unique IDs. Format: properties/{property_id}/dataStreams/{stream_id}/globalSiteTag Example: `properties/123/dataStreams/456/globalSiteTag`", "location": "path", "pattern": "^properties/[^/]+/dataStreams/[^/]+/globalSiteTag$", "required": true, @@ -3103,35 +3103,6 @@ } } }, -"eventEditRules": { -"methods": { -"reorder": { -"description": "Changes the processing order of event edit rules on the specified stream.", -"flatPath": "v1alpha/properties/{propertiesId}/dataStreams/{dataStreamsId}/eventEditRules:reorder", -"httpMethod": "POST", -"id": "analyticsadmin.properties.dataStreams.eventEditRules.reorder", -"parameterOrder": [ -"parent" -], -"parameters": { -"parent": { -"description": "Required. Example format: properties/123/dataStreams/456", -"location": "path", -"pattern": "^properties/[^/]+/dataStreams/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1alpha/{+parent}/eventEditRules:reorder", -"request": { -"$ref": "GoogleAnalyticsAdminV1alphaReorderEventEditRulesRequest" -}, -"response": { -"$ref": "GoogleProtobufEmpty" -} -} -} -}, "measurementProtocolSecrets": { "methods": { "create": { @@ -3938,7 +3909,7 @@ ], "parameters": { "parent": { -"description": "Required. Format: properties/{property_id} Example: properties/1234", +"description": "Required. Format: properties/{property_id} Example: `properties/1234`", "location": "path", "pattern": "^properties/[^/]+$", "required": true, @@ -3966,7 +3937,7 @@ ], "parameters": { "name": { -"description": "Required. Format: properties/{property_id}/firebaseLinks/{firebase_link_id} Example: properties/1234/firebaseLinks/5678", +"description": "Required. Format: properties/{property_id}/firebaseLinks/{firebase_link_id} Example: `properties/1234/firebaseLinks/5678`", "location": "path", "pattern": "^properties/[^/]+/firebaseLinks/[^/]+$", "required": true, @@ -4002,7 +3973,7 @@ "type": "string" }, "parent": { -"description": "Required. Format: properties/{property_id} Example: properties/1234", +"description": "Required. Format: properties/{property_id} Example: `properties/1234`", "location": "path", "pattern": "^properties/[^/]+$", "required": true, @@ -4733,7 +4704,7 @@ } } }, -"revision": "20240707", +"revision": "20240722", "rootUrl": "https://analyticsadmin.googleapis.com/", "schemas": { "GoogleAnalyticsAdminV1alphaAccessBetweenFilter": { @@ -8326,20 +8297,6 @@ }, "type": "object" }, -"GoogleAnalyticsAdminV1alphaReorderEventEditRulesRequest": { -"description": "Request message for ReorderEventEditRules RPC.", -"id": "GoogleAnalyticsAdminV1alphaReorderEventEditRulesRequest", -"properties": { -"eventEditRules": { -"description": "Required. EventEditRule resource names for the specified data stream, in the needed processing order. All EventEditRules for the stream must be present in the list.", -"items": { -"type": "string" -}, -"type": "array" -} -}, -"type": "object" -}, "GoogleAnalyticsAdminV1alphaRollupPropertySourceLink": { "description": "A link that references a source property under the parent rollup property.", "id": "GoogleAnalyticsAdminV1alphaRollupPropertySourceLink", @@ -8577,7 +8534,7 @@ "type": "string" }, "property": { -"description": "Optional. Resource name for a child property. If set, only return changes made to this property or its child resources. Format: properties/{propertyId} Example: \"properties/100\"", +"description": "Optional. Resource name for a child property. If set, only return changes made to this property or its child resources. Format: properties/{propertyId} Example: `properties/100`", "type": "string" }, "resourceType": { diff --git a/googleapiclient/discovery_cache/documents/analyticsadmin.v1beta.json b/googleapiclient/discovery_cache/documents/analyticsadmin.v1beta.json index c5994be2a5c..c1ab57d0f77 100644 --- a/googleapiclient/discovery_cache/documents/analyticsadmin.v1beta.json +++ b/googleapiclient/discovery_cache/documents/analyticsadmin.v1beta.json @@ -203,7 +203,7 @@ ], "parameters": { "name": { -"description": "Required. The name of the settings to lookup. Format: accounts/{account}/dataSharingSettings Example: \"accounts/1000/dataSharingSettings\"", +"description": "Required. The name of the settings to lookup. Format: accounts/{account}/dataSharingSettings Example: `accounts/1000/dataSharingSettings`", "location": "path", "pattern": "^accounts/[^/]+/dataSharingSettings$", "required": true, @@ -343,7 +343,7 @@ ], "parameters": { "account": { -"description": "Required. The account resource for which to return change history resources. Format: accounts/{account} Example: \"accounts/100\"", +"description": "Required. The account resource for which to return change history resources. Format: accounts/{account} Example: `accounts/100`", "location": "path", "pattern": "^accounts/[^/]+$", "required": true, @@ -630,7 +630,7 @@ "methods": { "create": { "deprecated": true, -"description": "Creates a conversion event with the specified attributes.", +"description": "Deprecated: Use `CreateKeyEvent` instead. Creates a conversion event with the specified attributes.", "flatPath": "v1beta/properties/{propertiesId}/conversionEvents", "httpMethod": "POST", "id": "analyticsadmin.properties.conversionEvents.create", @@ -659,7 +659,7 @@ }, "delete": { "deprecated": true, -"description": "Deletes a conversion event in a property.", +"description": "Deprecated: Use `DeleteKeyEvent` instead. Deletes a conversion event in a property.", "flatPath": "v1beta/properties/{propertiesId}/conversionEvents/{conversionEventsId}", "httpMethod": "DELETE", "id": "analyticsadmin.properties.conversionEvents.delete", @@ -685,7 +685,7 @@ }, "get": { "deprecated": true, -"description": "Retrieve a single conversion event.", +"description": "Deprecated: Use `GetKeyEvent` instead. Retrieve a single conversion event.", "flatPath": "v1beta/properties/{propertiesId}/conversionEvents/{conversionEventsId}", "httpMethod": "GET", "id": "analyticsadmin.properties.conversionEvents.get", @@ -712,7 +712,7 @@ }, "list": { "deprecated": true, -"description": "Returns a list of conversion events in the specified parent property. Returns an empty list if no conversion events are found.", +"description": "Deprecated: Use `ListKeyEvents` instead. Returns a list of conversion events in the specified parent property. Returns an empty list if no conversion events are found.", "flatPath": "v1beta/properties/{propertiesId}/conversionEvents", "httpMethod": "GET", "id": "analyticsadmin.properties.conversionEvents.list", @@ -750,7 +750,7 @@ }, "patch": { "deprecated": true, -"description": "Updates a conversion event with the specified attributes.", +"description": "Deprecated: Use `UpdateKeyEvent` instead. Updates a conversion event with the specified attributes.", "flatPath": "v1beta/properties/{propertiesId}/conversionEvents/{conversionEventsId}", "httpMethod": "PATCH", "id": "analyticsadmin.properties.conversionEvents.patch", @@ -1253,35 +1253,6 @@ } }, "resources": { -"eventEditRules": { -"methods": { -"reorder": { -"description": "Changes the processing order of event edit rules on the specified stream.", -"flatPath": "v1beta/properties/{propertiesId}/dataStreams/{dataStreamsId}/eventEditRules:reorder", -"httpMethod": "POST", -"id": "analyticsadmin.properties.dataStreams.eventEditRules.reorder", -"parameterOrder": [ -"parent" -], -"parameters": { -"parent": { -"description": "Required. Example format: properties/123/dataStreams/456", -"location": "path", -"pattern": "^properties/[^/]+/dataStreams/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1beta/{+parent}/eventEditRules:reorder", -"request": { -"$ref": "GoogleAnalyticsAdminV1betaReorderEventEditRulesRequest" -}, -"response": { -"$ref": "GoogleProtobufEmpty" -} -} -} -}, "measurementProtocolSecrets": { "methods": { "create": { @@ -1450,7 +1421,7 @@ ], "parameters": { "parent": { -"description": "Required. Format: properties/{property_id} Example: properties/1234", +"description": "Required. Format: properties/{property_id} Example: `properties/1234`", "location": "path", "pattern": "^properties/[^/]+$", "required": true, @@ -1478,7 +1449,7 @@ ], "parameters": { "name": { -"description": "Required. Format: properties/{property_id}/firebaseLinks/{firebase_link_id} Example: properties/1234/firebaseLinks/5678", +"description": "Required. Format: properties/{property_id}/firebaseLinks/{firebase_link_id} Example: `properties/1234/firebaseLinks/5678`", "location": "path", "pattern": "^properties/[^/]+/firebaseLinks/[^/]+$", "required": true, @@ -1514,7 +1485,7 @@ "type": "string" }, "parent": { -"description": "Required. Format: properties/{property_id} Example: properties/1234", +"description": "Required. Format: properties/{property_id} Example: `properties/1234`", "location": "path", "pattern": "^properties/[^/]+$", "required": true, @@ -1817,7 +1788,7 @@ } } }, -"revision": "20240707", +"revision": "20240722", "rootUrl": "https://analyticsadmin.googleapis.com/", "schemas": { "GoogleAnalyticsAdminV1betaAccessBetweenFilter": { @@ -3352,20 +3323,6 @@ }, "type": "object" }, -"GoogleAnalyticsAdminV1betaReorderEventEditRulesRequest": { -"description": "Request message for ReorderEventEditRules RPC.", -"id": "GoogleAnalyticsAdminV1betaReorderEventEditRulesRequest", -"properties": { -"eventEditRules": { -"description": "Required. EventEditRule resource names for the specified data stream, in the needed processing order. All EventEditRules for the stream must be present in the list.", -"items": { -"type": "string" -}, -"type": "array" -} -}, -"type": "object" -}, "GoogleAnalyticsAdminV1betaRunAccessReportRequest": { "description": "The request for a Data Access Record Report.", "id": "GoogleAnalyticsAdminV1betaRunAccessReportRequest", @@ -3522,7 +3479,7 @@ "type": "string" }, "property": { -"description": "Optional. Resource name for a child property. If set, only return changes made to this property or its child resources. Format: properties/{propertyId} Example: \"properties/100\"", +"description": "Optional. Resource name for a child property. If set, only return changes made to this property or its child resources. Format: properties/{propertyId} Example: `properties/100`", "type": "string" }, "resourceType": { diff --git a/googleapiclient/discovery_cache/documents/androidmanagement.v1.json b/googleapiclient/discovery_cache/documents/androidmanagement.v1.json index 8f92c22e6d5..a6be87257f6 100644 --- a/googleapiclient/discovery_cache/documents/androidmanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/androidmanagement.v1.json @@ -585,7 +585,7 @@ "enrollmentTokens": { "methods": { "create": { -"description": "Creates an enrollment token for a given enterprise. It's up to the caller's responsibility to manage the lifecycle of newly created tokens and deleting them when they're not intended to be used anymore. Once an enrollment token has been created, it's not possible to retrieve the token's content anymore using AM API. It is recommended for EMMs to securely store the token if it's intended to be reused.", +"description": "Creates an enrollment token for a given enterprise. It's up to the caller's responsibility to manage the lifecycle of newly created tokens and deleting them when they're not intended to be used anymore.", "flatPath": "v1/enterprises/{enterprisesId}/enrollmentTokens", "httpMethod": "POST", "id": "androidmanagement.enterprises.enrollmentTokens.create", @@ -1168,7 +1168,7 @@ } } }, -"revision": "20240708", +"revision": "20240724", "rootUrl": "https://androidmanagement.googleapis.com/", "schemas": { "AdbShellCommandEvent": { @@ -4248,9 +4248,9 @@ false "DEVICE_INCOMPATIBLE" ], "enumDescriptions": [ -"This value is disallowed.", +"This value is not used.", "The setting is not supported in the API level of the Android version running on the device.", -"The management mode (profile owner, device owner, etc.) doesn't support the setting.", +"The management mode (such as fully managed or work profile) doesn't support the setting.", "The user has not taken required action to comply with the setting.", "The setting has an invalid value.", "The app required to implement the policy is not installed.", @@ -4326,9 +4326,9 @@ false "DEVICE_INCOMPATIBLE" ], "enumDescriptions": [ -"This value is disallowed.", +"This value is not used.", "The setting is not supported in the API level of the Android version running on the device.", -"The management mode (profile owner, device owner, etc.) doesn't support the setting.", +"The management mode (such as fully managed or work profile) doesn't support the setting.", "The user has not taken required action to comply with the setting.", "The setting has an invalid value.", "The app required to implement the policy is not installed.", diff --git a/googleapiclient/discovery_cache/documents/apim.v1alpha.json b/googleapiclient/discovery_cache/documents/apim.v1alpha.json index 03cb5ee4a9d..88ba6e3aa2f 100644 --- a/googleapiclient/discovery_cache/documents/apim.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/apim.v1alpha.json @@ -174,6 +174,42 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +}, +"listApiObservationTags": { +"description": "ListApiObservationTags lists all extant tags on any observation in the given project.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}:listApiObservationTags", +"httpMethod": "GET", +"id": "apim.projects.locations.listApiObservationTags", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Optional. The maximum number of tags to return. The service may return fewer than this value. If unspecified, at most 10 tags will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A page token, received from a previous `ListApiObservationTags` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListApiObservationTags` must match the call that provided the page token.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent, which owns this collection of tags. Format: projects/{project}/locations/{location}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}:listApiObservationTags", +"response": { +"$ref": "ListApiObservationTagsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] } }, "resources": { @@ -324,7 +360,7 @@ ] }, "list": { -"description": "ListObservationJobs gets all ObservationJobs for a given project and location", +"description": "ListObservationJobs gets all ObservationJobs for a given project and location.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/observationJobs", "httpMethod": "GET", "id": "apim.projects.locations.observationJobs.list", @@ -363,6 +399,34 @@ "resources": { "apiObservations": { "methods": { +"batchEditTags": { +"description": "BatchEditTagsApiObservations adds or removes Tags for ApiObservations.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/observationJobs/{observationJobsId}/apiObservations:batchEditTags", +"httpMethod": "POST", +"id": "apim.projects.locations.observationJobs.apiObservations.batchEditTags", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent resource shared by all ApiObservations being edited. Format: projects/{project}/locations/{location}/observationJobs/{observation_job}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/observationJobs/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/apiObservations:batchEditTags", +"request": { +"$ref": "BatchEditTagsApiObservationsRequest" +}, +"response": { +"$ref": "BatchEditTagsApiObservationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "get": { "description": "GetApiObservation retrieves a single ApiObservation by name.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/observationJobs/{observationJobsId}/apiObservations/{apiObservationsId}", @@ -389,7 +453,7 @@ ] }, "list": { -"description": "ListApiObservations gets all ApiObservations for a given project and location and ObservationJob", +"description": "ListApiObservations gets all ApiObservations for a given project and location and ObservationJob.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/observationJobs/{observationJobsId}/apiObservations", "httpMethod": "GET", "id": "apim.projects.locations.observationJobs.apiObservations.list", @@ -454,7 +518,7 @@ ] }, "list": { -"description": "ListApiOperations gets all ApiOperations for a given project and location and ObservationJob and ApiObservation", +"description": "ListApiOperations gets all ApiOperations for a given project and location and ObservationJob and ApiObservation.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/observationJobs/{observationJobsId}/apiObservations/{apiObservationsId}/apiOperations", "httpMethod": "GET", "id": "apim.projects.locations.observationJobs.apiObservations.apiOperations.list", @@ -586,7 +650,7 @@ ] }, "list": { -"description": "ListObservationSources gets all ObservationSources for a given project and location", +"description": "ListObservationSources gets all ObservationSources for a given project and location.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/observationSources", "httpMethod": "GET", "id": "apim.projects.locations.observationSources.list", @@ -751,7 +815,7 @@ } } }, -"revision": "20240701", +"revision": "20240717", "rootUrl": "https://apim.googleapis.com/", "schemas": { "ApiObservation": { @@ -856,6 +920,34 @@ }, "type": "object" }, +"BatchEditTagsApiObservationsRequest": { +"description": "Message for requesting batch edit tags for ApiObservations", +"id": "BatchEditTagsApiObservationsRequest", +"properties": { +"requests": { +"description": "Required. The request message specifying the resources to update. A maximum of 1000 apiObservations can be modified in a batch.", +"items": { +"$ref": "EditTagsApiObservationsRequest" +}, +"type": "array" +} +}, +"type": "object" +}, +"BatchEditTagsApiObservationsResponse": { +"description": "Message for response to edit Tags for ApiObservations", +"id": "BatchEditTagsApiObservationsResponse", +"properties": { +"apiObservations": { +"description": "ApiObservations that were changed", +"items": { +"$ref": "ApiObservation" +}, +"type": "array" +} +}, +"type": "object" +}, "CancelOperationRequest": { "description": "The request message for Operations.CancelOperation.", "id": "CancelOperationRequest", @@ -868,6 +960,24 @@ "properties": {}, "type": "object" }, +"EditTagsApiObservationsRequest": { +"description": "Message for requesting edit tags for ApiObservation", +"id": "EditTagsApiObservationsRequest", +"properties": { +"apiObservationId": { +"description": "Required. Identifier of ApiObservation need to be edit tags Format example: \"apigee.googleapis.com|us-west1|443\"", +"type": "string" +}, +"tagActions": { +"description": "Required. Tag actions to be applied", +"items": { +"$ref": "TagAction" +}, +"type": "array" +} +}, +"type": "object" +}, "Empty": { "description": "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); }", "id": "Empty", @@ -1110,6 +1220,24 @@ }, "type": "object" }, +"ListApiObservationTagsResponse": { +"description": "Message for response to listing tags", +"id": "ListApiObservationTagsResponse", +"properties": { +"apiObservationTags": { +"description": "The tags from the specified project", +"items": { +"type": "string" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", +"type": "string" +} +}, +"type": "object" +}, "ListApiObservationsResponse": { "description": "Message for response to listing ApiObservations", "id": "ListApiObservationsResponse", @@ -1472,6 +1600,31 @@ } }, "type": "object" +}, +"TagAction": { +"description": "Message for edit tag action", +"id": "TagAction", +"properties": { +"action": { +"description": "Required. Action to be applied", +"enum": [ +"ACTION_UNSPECIFIED", +"ADD", +"REMOVE" +], +"enumDescriptions": [ +"Unspecified.", +"Addition of a Tag.", +"Removal of a Tag." +], +"type": "string" +}, +"tag": { +"description": "Required. Tag to be added or removed", +"type": "string" +} +}, +"type": "object" } }, "servicePath": "", diff --git a/googleapiclient/discovery_cache/documents/artifactregistry.v1.json b/googleapiclient/discovery_cache/documents/artifactregistry.v1.json index e998ab9e8e0..df88f3a7f3f 100644 --- a/googleapiclient/discovery_cache/documents/artifactregistry.v1.json +++ b/googleapiclient/discovery_cache/documents/artifactregistry.v1.json @@ -2013,7 +2013,7 @@ } } }, -"revision": "20240708", +"revision": "20240717", "rootUrl": "https://artifactregistry.googleapis.com/", "schemas": { "AptArtifact": { @@ -3351,6 +3351,11 @@ false "name": { "description": "The name of the project's settings. Always of the form: projects/{project-id}/projectSettings In update request: never set In response: always set", "type": "string" +}, +"pullPercent": { +"description": "The percentage of pull traffic to redirect from GCR to AR when using partial redirection.", +"format": "int32", +"type": "integer" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/artifactregistry.v1beta2.json b/googleapiclient/discovery_cache/documents/artifactregistry.v1beta2.json index 57e1457810b..b8461d2230a 100644 --- a/googleapiclient/discovery_cache/documents/artifactregistry.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/artifactregistry.v1beta2.json @@ -1414,7 +1414,7 @@ } } }, -"revision": "20240704", +"revision": "20240717", "rootUrl": "https://artifactregistry.googleapis.com/", "schemas": { "AptArtifact": { @@ -2028,6 +2028,11 @@ false "name": { "description": "The name of the project's settings. Always of the form: projects/{project-id}/projectSettings In update request: never set In response: always set", "type": "string" +}, +"pullPercent": { +"description": "The percentage of pull traffic to redirect from GCR to AR when using partial redirection.", +"format": "int32", +"type": "integer" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/assuredworkloads.v1.json b/googleapiclient/discovery_cache/documents/assuredworkloads.v1.json index 9cccf6b3651..90abe38fe59 100644 --- a/googleapiclient/discovery_cache/documents/assuredworkloads.v1.json +++ b/googleapiclient/discovery_cache/documents/assuredworkloads.v1.json @@ -591,7 +591,7 @@ } } }, -"revision": "20240703", +"revision": "20240712", "rootUrl": "https://assuredworkloads.googleapis.com/", "schemas": { "GoogleCloudAssuredworkloadsV1AcknowledgeViolationRequest": { @@ -719,7 +719,7 @@ "Information protection as per DoD IL5 requirements.", "Information protection as per DoD IL2 requirements.", "Assured Workloads for Japan Regions", -"KSA R5 Controls.", +"Assured Workloads Sovereign Controls KSA", "Assured Workloads for Regional Controls" ], "type": "string" @@ -1202,7 +1202,7 @@ "Information protection as per DoD IL5 requirements.", "Information protection as per DoD IL2 requirements.", "Assured Workloads for Japan Regions", -"KSA R5 Controls.", +"Assured Workloads Sovereign Controls KSA", "Assured Workloads for Regional Controls" ], "type": "string" diff --git a/googleapiclient/discovery_cache/documents/assuredworkloads.v1beta1.json b/googleapiclient/discovery_cache/documents/assuredworkloads.v1beta1.json index 36f40905192..3b9c27b760d 100644 --- a/googleapiclient/discovery_cache/documents/assuredworkloads.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/assuredworkloads.v1beta1.json @@ -588,7 +588,7 @@ } } }, -"revision": "20240703", +"revision": "20240712", "rootUrl": "https://assuredworkloads.googleapis.com/", "schemas": { "GoogleCloudAssuredworkloadsV1beta1AcknowledgeViolationRequest": { @@ -716,7 +716,7 @@ "Information protection as per DoD IL5 requirements.", "Information protection as per DoD IL2 requirements.", "Assured Workloads for Japan Regions", -"KSA R5 Controls.", +"Assured Workloads Sovereign Controls KSA", "Assured Workloads for Regional Controls" ], "type": "string" @@ -1197,7 +1197,7 @@ "Information protection as per DoD IL5 requirements.", "Information protection as per DoD IL2 requirements.", "Assured Workloads for Japan Regions", -"KSA R5 Controls.", +"Assured Workloads Sovereign Controls KSA", "Assured Workloads for Regional Controls" ], "type": "string" diff --git a/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1alpha.json b/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1alpha.json new file mode 100644 index 00000000000..db21257c0cb --- /dev/null +++ b/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1alpha.json @@ -0,0 +1,3513 @@ +{ +"auth": { +"oauth2": { +"scopes": { +"https://www.googleapis.com/auth/authorized-buyers-marketplace": { +"description": "See, create, edit, and delete your Authorized Buyers Marketplace entities." +} +} +} +}, +"basePath": "", +"baseUrl": "https://authorizedbuyersmarketplace.googleapis.com/", +"batchPath": "batch", +"canonicalName": "Authorized Buyers Marketplace", +"description": "The Authorized Buyers Marketplace API lets buyers programmatically discover inventory; propose, retrieve and negotiate deals with publishers.", +"discoveryVersion": "v1", +"documentationLink": "https://developers.google.com/authorized-buyers/apis/marketplace/reference/rest/", +"fullyEncodeReservedExpansion": true, +"icons": { +"x16": "http://www.google.com/images/icons/product/search-16.gif", +"x32": "http://www.google.com/images/icons/product/search-32.gif" +}, +"id": "authorizedbuyersmarketplace:v1alpha", +"kind": "discovery#restDescription", +"mtlsRootUrl": "https://authorizedbuyersmarketplace.mtls.googleapis.com/", +"name": "authorizedbuyersmarketplace", +"ownerDomain": "google.com", +"ownerName": "Google", +"parameters": { +"$.xgafv": { +"description": "V1 error format.", +"enum": [ +"1", +"2" +], +"enumDescriptions": [ +"v1 error format", +"v2 error format" +], +"location": "query", +"type": "string" +}, +"access_token": { +"description": "OAuth access token.", +"location": "query", +"type": "string" +}, +"alt": { +"default": "json", +"description": "Data format for response.", +"enum": [ +"json", +"media", +"proto" +], +"enumDescriptions": [ +"Responses with Content-Type of application/json", +"Media download with context-dependent Content-Type", +"Responses with Content-Type of application/x-protobuf" +], +"location": "query", +"type": "string" +}, +"callback": { +"description": "JSONP", +"location": "query", +"type": "string" +}, +"fields": { +"description": "Selector specifying which fields to include in a partial response.", +"location": "query", +"type": "string" +}, +"key": { +"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", +"location": "query", +"type": "string" +}, +"oauth_token": { +"description": "OAuth 2.0 token for the current user.", +"location": "query", +"type": "string" +}, +"prettyPrint": { +"default": "true", +"description": "Returns response with indentations and line breaks.", +"location": "query", +"type": "boolean" +}, +"quotaUser": { +"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", +"location": "query", +"type": "string" +}, +"uploadType": { +"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", +"location": "query", +"type": "string" +}, +"upload_protocol": { +"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", +"location": "query", +"type": "string" +} +}, +"protocol": "rest", +"resources": { +"bidders": { +"resources": { +"auctionPackages": { +"methods": { +"list": { +"description": "List the auction packages. Buyers can use the URL path \"/v1alpha/buyers/{accountId}/auctionPackages\" to list auction packages for the current buyer and its clients. Bidders can use the URL path \"/v1alpha/bidders/{accountId}/auctionPackages\" to list auction packages for the bidder, its media planners, its buyers, and all their clients.", +"flatPath": "v1alpha/bidders/{biddersId}/auctionPackages", +"httpMethod": "GET", +"id": "authorizedbuyersmarketplace.bidders.auctionPackages.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. Optional query string using the [Cloud API list filtering syntax](/authorized-buyers/apis/guides/list-filters). Only supported when parent is bidder. Supported columns for filtering are: * displayName * createTime * updateTime * eligibleSeatIds", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. An optional query string to sort auction packages using the [Cloud API sorting syntax](https://cloud.google.com/apis/design/design_patterns#sorting_order). If no sort order is specified, results will be returned in an arbitrary order. Only supported when parent is bidder. Supported columns for sorting are: * displayName * createTime * updateTime", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Requested page size. The server may return fewer results than requested. Max allowed page size is 500.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The page token as returned. ListAuctionPackagesResponse.nextPageToken", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Name of the parent buyer that can access the auction package. Format: `buyers/{accountId}`. When used with a bidder account, the auction packages that the bidder, its media planners, its buyers and clients are subscribed to will be listed, in the format `bidders/{accountId}`.", +"location": "path", +"pattern": "^bidders/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/auctionPackages", +"response": { +"$ref": "ListAuctionPackagesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +} +} +}, +"finalizedDeals": { +"methods": { +"list": { +"description": "Lists finalized deals. Use the URL path \"/v1alpha/buyers/{accountId}/finalizedDeals\" to list finalized deals for the current buyer and its clients. Bidders can use the URL path \"/v1alpha/bidders/{accountId}/finalizedDeals\" to list finalized deals for the bidder, its buyers and all their clients.", +"flatPath": "v1alpha/bidders/{biddersId}/finalizedDeals", +"httpMethod": "GET", +"id": "authorizedbuyersmarketplace.bidders.finalizedDeals.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional query string using the [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) Supported columns for filtering are: * deal.displayName * deal.dealType * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * deal.eligibleSeatIds * dealServingStatus", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "An optional query string to sort finalized deals using the [Cloud API sorting syntax](https://cloud.google.com/apis/design/design_patterns#sorting_order). If no sort order is specified, results will be returned in an arbitrary order. Supported columns for sorting are: * deal.displayName * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * rtbMetrics.bidRequests7Days * rtbMetrics.bids7Days * rtbMetrics.adImpressions7Days * rtbMetrics.bidRate7Days * rtbMetrics.filteredBidRate7Days * rtbMetrics.mustBidRateCurrentMonth", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Requested page size. The server may return fewer results than requested. If requested more than 500, the server will return 500 results per page. If unspecified, the server will pick a default page size of 100.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The page token as returned from ListFinalizedDealsResponse.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The buyer to list the finalized deals for, in the format: `buyers/{accountId}`. When used to list finalized deals for a bidder, its buyers and clients, in the format `bidders/{accountId}`.", +"location": "path", +"pattern": "^bidders/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/finalizedDeals", +"response": { +"$ref": "ListFinalizedDealsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +} +} +} +} +}, +"buyers": { +"resources": { +"auctionPackages": { +"methods": { +"get": { +"description": "Gets an auction package given its name.", +"flatPath": "v1alpha/buyers/{buyersId}/auctionPackages/{auctionPackagesId}", +"httpMethod": "GET", +"id": "authorizedbuyersmarketplace.buyers.auctionPackages.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of auction package to get. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}`", +"location": "path", +"pattern": "^buyers/[^/]+/auctionPackages/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "AuctionPackage" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +}, +"list": { +"description": "List the auction packages. Buyers can use the URL path \"/v1alpha/buyers/{accountId}/auctionPackages\" to list auction packages for the current buyer and its clients. Bidders can use the URL path \"/v1alpha/bidders/{accountId}/auctionPackages\" to list auction packages for the bidder, its media planners, its buyers, and all their clients.", +"flatPath": "v1alpha/buyers/{buyersId}/auctionPackages", +"httpMethod": "GET", +"id": "authorizedbuyersmarketplace.buyers.auctionPackages.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. Optional query string using the [Cloud API list filtering syntax](/authorized-buyers/apis/guides/list-filters). Only supported when parent is bidder. Supported columns for filtering are: * displayName * createTime * updateTime * eligibleSeatIds", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. An optional query string to sort auction packages using the [Cloud API sorting syntax](https://cloud.google.com/apis/design/design_patterns#sorting_order). If no sort order is specified, results will be returned in an arbitrary order. Only supported when parent is bidder. Supported columns for sorting are: * displayName * createTime * updateTime", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Requested page size. The server may return fewer results than requested. Max allowed page size is 500.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The page token as returned. ListAuctionPackagesResponse.nextPageToken", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Name of the parent buyer that can access the auction package. Format: `buyers/{accountId}`. When used with a bidder account, the auction packages that the bidder, its media planners, its buyers and clients are subscribed to will be listed, in the format `bidders/{accountId}`.", +"location": "path", +"pattern": "^buyers/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/auctionPackages", +"response": { +"$ref": "ListAuctionPackagesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +}, +"subscribe": { +"description": "Subscribe to the auction package for the specified buyer. Once subscribed, the bidder will receive a call out for inventory matching the auction package targeting criteria with the auction package deal ID and the specified buyer.", +"flatPath": "v1alpha/buyers/{buyersId}/auctionPackages/{auctionPackagesId}:subscribe", +"httpMethod": "POST", +"id": "authorizedbuyersmarketplace.buyers.auctionPackages.subscribe", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}`", +"location": "path", +"pattern": "^buyers/[^/]+/auctionPackages/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}:subscribe", +"request": { +"$ref": "SubscribeAuctionPackageRequest" +}, +"response": { +"$ref": "AuctionPackage" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +}, +"subscribeClients": { +"description": "Subscribe the specified clients of the buyer to the auction package. If a client in the list does not belong to the buyer, an error response will be returned, and all of the following clients in the list will not be subscribed. Subscribing an already subscribed client will have no effect.", +"flatPath": "v1alpha/buyers/{buyersId}/auctionPackages/{auctionPackagesId}:subscribeClients", +"httpMethod": "POST", +"id": "authorizedbuyersmarketplace.buyers.auctionPackages.subscribeClients", +"parameterOrder": [ +"auctionPackage" +], +"parameters": { +"auctionPackage": { +"description": "Required. Name of the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}`", +"location": "path", +"pattern": "^buyers/[^/]+/auctionPackages/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+auctionPackage}:subscribeClients", +"request": { +"$ref": "SubscribeClientsRequest" +}, +"response": { +"$ref": "AuctionPackage" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +}, +"unsubscribe": { +"description": "Unsubscribe from the auction package for the specified buyer. Once unsubscribed, the bidder will no longer receive a call out for the auction package deal ID and the specified buyer.", +"flatPath": "v1alpha/buyers/{buyersId}/auctionPackages/{auctionPackagesId}:unsubscribe", +"httpMethod": "POST", +"id": "authorizedbuyersmarketplace.buyers.auctionPackages.unsubscribe", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}`", +"location": "path", +"pattern": "^buyers/[^/]+/auctionPackages/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}:unsubscribe", +"request": { +"$ref": "UnsubscribeAuctionPackageRequest" +}, +"response": { +"$ref": "AuctionPackage" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +}, +"unsubscribeClients": { +"description": "Unsubscribe from the auction package for the specified clients of the buyer. Unsubscribing a client that is not subscribed will have no effect.", +"flatPath": "v1alpha/buyers/{buyersId}/auctionPackages/{auctionPackagesId}:unsubscribeClients", +"httpMethod": "POST", +"id": "authorizedbuyersmarketplace.buyers.auctionPackages.unsubscribeClients", +"parameterOrder": [ +"auctionPackage" +], +"parameters": { +"auctionPackage": { +"description": "Required. Name of the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}`", +"location": "path", +"pattern": "^buyers/[^/]+/auctionPackages/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+auctionPackage}:unsubscribeClients", +"request": { +"$ref": "UnsubscribeClientsRequest" +}, +"response": { +"$ref": "AuctionPackage" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +} +} +}, +"clients": { +"methods": { +"activate": { +"description": "Activates an existing client. The state of the client will be updated to \"ACTIVE\". This method has no effect if the client is already in \"ACTIVE\" state.", +"flatPath": "v1alpha/buyers/{buyersId}/clients/{clientsId}:activate", +"httpMethod": "POST", +"id": "authorizedbuyersmarketplace.buyers.clients.activate", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}`", +"location": "path", +"pattern": "^buyers/[^/]+/clients/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}:activate", +"request": { +"$ref": "ActivateClientRequest" +}, +"response": { +"$ref": "Client" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +}, +"create": { +"description": "Creates a new client.", +"flatPath": "v1alpha/buyers/{buyersId}/clients", +"httpMethod": "POST", +"id": "authorizedbuyersmarketplace.buyers.clients.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The name of the buyer. Format: `buyers/{accountId}`", +"location": "path", +"pattern": "^buyers/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/clients", +"request": { +"$ref": "Client" +}, +"response": { +"$ref": "Client" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +}, +"deactivate": { +"description": "Deactivates an existing client. The state of the client will be updated to \"INACTIVE\". This method has no effect if the client is already in \"INACTIVE\" state.", +"flatPath": "v1alpha/buyers/{buyersId}/clients/{clientsId}:deactivate", +"httpMethod": "POST", +"id": "authorizedbuyersmarketplace.buyers.clients.deactivate", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}`", +"location": "path", +"pattern": "^buyers/[^/]+/clients/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}:deactivate", +"request": { +"$ref": "DeactivateClientRequest" +}, +"response": { +"$ref": "Client" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +}, +"get": { +"description": "Gets a client with a given resource name.", +"flatPath": "v1alpha/buyers/{buyersId}/clients/{clientsId}", +"httpMethod": "GET", +"id": "authorizedbuyersmarketplace.buyers.clients.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Format: `buyers/{accountId}/clients/{clientAccountId}`", +"location": "path", +"pattern": "^buyers/[^/]+/clients/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "Client" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +}, +"list": { +"description": "Lists all the clients for the current buyer.", +"flatPath": "v1alpha/buyers/{buyersId}/clients", +"httpMethod": "GET", +"id": "authorizedbuyersmarketplace.buyers.clients.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Query string using the [Filtering Syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) Supported fields for filtering are: * partnerClientId Use this field to filter the clients by the partnerClientId. For example, if the partnerClientId of the client is \"1234\", the value of this field should be `partnerClientId = \"1234\"`, in order to get only the client whose partnerClientId is \"1234\" in the response.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Requested page size. If left blank, a default page size of 500 will be applied.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A token identifying a page of results the server should return. Typically, this is the value of ListClientsResponse.nextPageToken returned from the previous call to the list method.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The name of the buyer. Format: `buyers/{accountId}`", +"location": "path", +"pattern": "^buyers/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/clients", +"response": { +"$ref": "ListClientsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +}, +"patch": { +"description": "Updates an existing client.", +"flatPath": "v1alpha/buyers/{buyersId}/clients/{clientsId}", +"httpMethod": "PATCH", +"id": "authorizedbuyersmarketplace.buyers.clients.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Output only. The resource name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}`", +"location": "path", +"pattern": "^buyers/[^/]+/clients/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "List of fields to be updated. If empty or unspecified, the service will update all fields populated in the update request excluding the output only fields and primitive fields with default value. Note that explicit field mask is required in order to reset a primitive field back to its default value, for example, false for boolean fields, 0 for integer fields. A special field mask consisting of a single path \"*\" can be used to indicate full replacement(the equivalent of PUT method), updatable fields unset or unspecified in the input will be cleared or set to default value. Output only fields will be ignored regardless of the value of updateMask.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"request": { +"$ref": "Client" +}, +"response": { +"$ref": "Client" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +} +}, +"resources": { +"users": { +"methods": { +"activate": { +"description": "Activates an existing client user. The state of the client user will be updated from \"INACTIVE\" to \"ACTIVE\". This method has no effect if the client user is already in \"ACTIVE\" state. An error will be returned if the client user to activate is still in \"INVITED\" state.", +"flatPath": "v1alpha/buyers/{buyersId}/clients/{clientsId}/users/{usersId}:activate", +"httpMethod": "POST", +"id": "authorizedbuyersmarketplace.buyers.clients.users.activate", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}/clientUsers/{userId}`", +"location": "path", +"pattern": "^buyers/[^/]+/clients/[^/]+/users/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}:activate", +"request": { +"$ref": "ActivateClientUserRequest" +}, +"response": { +"$ref": "ClientUser" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +}, +"create": { +"description": "Creates a new client user in \"INVITED\" state. An email invitation will be sent to the new user, once accepted the user will become active.", +"flatPath": "v1alpha/buyers/{buyersId}/clients/{clientsId}/users", +"httpMethod": "POST", +"id": "authorizedbuyersmarketplace.buyers.clients.users.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}`", +"location": "path", +"pattern": "^buyers/[^/]+/clients/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/users", +"request": { +"$ref": "ClientUser" +}, +"response": { +"$ref": "ClientUser" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +}, +"deactivate": { +"description": "Deactivates an existing client user. The state of the client user will be updated from \"ACTIVE\" to \"INACTIVE\". This method has no effect if the client user is already in \"INACTIVE\" state. An error will be returned if the client user to deactivate is still in \"INVITED\" state.", +"flatPath": "v1alpha/buyers/{buyersId}/clients/{clientsId}/users/{usersId}:deactivate", +"httpMethod": "POST", +"id": "authorizedbuyersmarketplace.buyers.clients.users.deactivate", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}/clientUsers/{userId}`", +"location": "path", +"pattern": "^buyers/[^/]+/clients/[^/]+/users/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}:deactivate", +"request": { +"$ref": "DeactivateClientUserRequest" +}, +"response": { +"$ref": "ClientUser" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +}, +"delete": { +"description": "Deletes an existing client user. The client user will lose access to the Authorized Buyers UI. Note that if a client user is deleted, the user's access to the UI can't be restored unless a new client user is created and activated.", +"flatPath": "v1alpha/buyers/{buyersId}/clients/{clientsId}/users/{usersId}", +"httpMethod": "DELETE", +"id": "authorizedbuyersmarketplace.buyers.clients.users.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}/clientUsers/{userId}`", +"location": "path", +"pattern": "^buyers/[^/]+/clients/[^/]+/users/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +}, +"get": { +"description": "Retrieves an existing client user.", +"flatPath": "v1alpha/buyers/{buyersId}/clients/{clientsId}/users/{usersId}", +"httpMethod": "GET", +"id": "authorizedbuyersmarketplace.buyers.clients.users.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}/clientUsers/{userId}`", +"location": "path", +"pattern": "^buyers/[^/]+/clients/[^/]+/users/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "ClientUser" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +}, +"list": { +"description": "Lists all client users for a specified client.", +"flatPath": "v1alpha/buyers/{buyersId}/clients/{clientsId}/users", +"httpMethod": "GET", +"id": "authorizedbuyersmarketplace.buyers.clients.users.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Requested page size. If left blank, a default page size of 500 will be applied.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A token identifying a page of results the server should return. Typically, this is the value of ListClientUsersResponse.nextPageToken returned from the previous call to the list method.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The name of the client. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}`", +"location": "path", +"pattern": "^buyers/[^/]+/clients/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/users", +"response": { +"$ref": "ListClientUsersResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +} +} +} +} +}, +"dataSegments": { +"methods": { +"activate": { +"description": "Activates a data segment.", +"flatPath": "v1alpha/buyers/{buyersId}/dataSegments/{dataSegmentsId}:activate", +"httpMethod": "POST", +"id": "authorizedbuyersmarketplace.buyers.dataSegments.activate", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of data segment to activate. Format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}`", +"location": "path", +"pattern": "^buyers/[^/]+/dataSegments/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}:activate", +"request": { +"$ref": "ActivateDataSegmentRequest" +}, +"response": { +"$ref": "DataSegment" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +}, +"create": { +"description": "Creates a data segment owned by the listed curator. The data segment will be created in the `ACTIVE` state, meaning it will be immediately available for buyers to use in preferred deals, private auction deals, and auction packages.", +"flatPath": "v1alpha/buyers/{buyersId}/dataSegments", +"httpMethod": "POST", +"id": "authorizedbuyersmarketplace.buyers.dataSegments.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent resource where this data segment will be created. Format: `buyers/{accountId}`", +"location": "path", +"pattern": "^buyers/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/dataSegments", +"request": { +"$ref": "DataSegment" +}, +"response": { +"$ref": "DataSegment" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +}, +"deactivate": { +"description": "Deactivates a data segment.", +"flatPath": "v1alpha/buyers/{buyersId}/dataSegments/{dataSegmentsId}:deactivate", +"httpMethod": "POST", +"id": "authorizedbuyersmarketplace.buyers.dataSegments.deactivate", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of data segment to deactivate. Format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}`", +"location": "path", +"pattern": "^buyers/[^/]+/dataSegments/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}:deactivate", +"request": { +"$ref": "DeactivateDataSegmentRequest" +}, +"response": { +"$ref": "DataSegment" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +}, +"get": { +"description": "Gets a data segment given its name.", +"flatPath": "v1alpha/buyers/{buyersId}/dataSegments/{dataSegmentsId}", +"httpMethod": "GET", +"id": "authorizedbuyersmarketplace.buyers.dataSegments.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of data segment to get. Format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}`", +"location": "path", +"pattern": "^buyers/[^/]+/dataSegments/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "DataSegment" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +}, +"list": { +"description": "List the data segments owned by a curator.", +"flatPath": "v1alpha/buyers/{buyersId}/dataSegments", +"httpMethod": "GET", +"id": "authorizedbuyersmarketplace.buyers.dataSegments.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Optional. Requested page size. The server may return fewer results than requested. Max allowed page size is 500. If unspecified, the server will default to 500.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. The page token as returned. ListDataSegmentsResponse.nextPageToken", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Name of the parent buyer that can access the data segment. Format: `buyers/{accountId}`", +"location": "path", +"pattern": "^buyers/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/dataSegments", +"response": { +"$ref": "ListDataSegmentsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +}, +"patch": { +"description": "Updates a data segment.", +"flatPath": "v1alpha/buyers/{buyersId}/dataSegments/{dataSegmentsId}", +"httpMethod": "PATCH", +"id": "authorizedbuyersmarketplace.buyers.dataSegments.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Immutable. Identifier. The unique identifier for the data segment. Account ID corresponds to the account ID that created the segment. Format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}`", +"location": "path", +"pattern": "^buyers/[^/]+/dataSegments/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Optional. List of fields to be updated. If empty or unspecified, the service will update all fields populated in the update request excluding the output only fields and primitive fields with default value. Note that explicit field mask is required in order to reset a primitive field back to its default value, for example, false for boolean fields, 0 for integer fields. A special field mask consisting of a single path \"*\" can be used to indicate full replacement(the equivalent of PUT method), updatable fields unset or unspecified in the input will be cleared or set to default value. Output only fields will be ignored regardless of the value of updateMask.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"request": { +"$ref": "DataSegment" +}, +"response": { +"$ref": "DataSegment" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +} +} +}, +"finalizedDeals": { +"methods": { +"addCreative": { +"description": "Add creative to be used in the bidding process for a finalized deal. For programmatic guaranteed deals, it's recommended that you associate at least one approved creative with the deal before calling SetReadyToServe, to help reduce the number of bid responses filtered because they don't contain approved creatives. Creatives successfully added to a deal can be found in the Realtime-bidding Creatives API creative.deal_ids. This method only applies to programmatic guaranteed deals. Maximum number of 1000 creatives can be added to a finalized deal.", +"flatPath": "v1alpha/buyers/{buyersId}/finalizedDeals/{finalizedDealsId}:addCreative", +"httpMethod": "POST", +"id": "authorizedbuyersmarketplace.buyers.finalizedDeals.addCreative", +"parameterOrder": [ +"deal" +], +"parameters": { +"deal": { +"description": "Required. Name of the finalized deal in the format of: `buyers/{accountId}/finalizedDeals/{dealId}`", +"location": "path", +"pattern": "^buyers/[^/]+/finalizedDeals/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+deal}:addCreative", +"request": { +"$ref": "AddCreativeRequest" +}, +"response": { +"$ref": "FinalizedDeal" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +}, +"get": { +"description": "Gets a finalized deal given its name.", +"flatPath": "v1alpha/buyers/{buyersId}/finalizedDeals/{finalizedDealsId}", +"httpMethod": "GET", +"id": "authorizedbuyersmarketplace.buyers.finalizedDeals.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Format: `buyers/{accountId}/finalizedDeals/{dealId}`", +"location": "path", +"pattern": "^buyers/[^/]+/finalizedDeals/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "FinalizedDeal" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +}, +"list": { +"description": "Lists finalized deals. Use the URL path \"/v1alpha/buyers/{accountId}/finalizedDeals\" to list finalized deals for the current buyer and its clients. Bidders can use the URL path \"/v1alpha/bidders/{accountId}/finalizedDeals\" to list finalized deals for the bidder, its buyers and all their clients.", +"flatPath": "v1alpha/buyers/{buyersId}/finalizedDeals", +"httpMethod": "GET", +"id": "authorizedbuyersmarketplace.buyers.finalizedDeals.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional query string using the [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) Supported columns for filtering are: * deal.displayName * deal.dealType * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * deal.eligibleSeatIds * dealServingStatus", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "An optional query string to sort finalized deals using the [Cloud API sorting syntax](https://cloud.google.com/apis/design/design_patterns#sorting_order). If no sort order is specified, results will be returned in an arbitrary order. Supported columns for sorting are: * deal.displayName * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * rtbMetrics.bidRequests7Days * rtbMetrics.bids7Days * rtbMetrics.adImpressions7Days * rtbMetrics.bidRate7Days * rtbMetrics.filteredBidRate7Days * rtbMetrics.mustBidRateCurrentMonth", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Requested page size. The server may return fewer results than requested. If requested more than 500, the server will return 500 results per page. If unspecified, the server will pick a default page size of 100.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The page token as returned from ListFinalizedDealsResponse.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The buyer to list the finalized deals for, in the format: `buyers/{accountId}`. When used to list finalized deals for a bidder, its buyers and clients, in the format `bidders/{accountId}`.", +"location": "path", +"pattern": "^buyers/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/finalizedDeals", +"response": { +"$ref": "ListFinalizedDealsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +}, +"pause": { +"description": "Pauses serving of the given finalized deal. This call only pauses the serving status, and does not affect other fields of the finalized deal. Calling this method for an already paused deal has no effect. This method only applies to programmatic guaranteed deals and preferred deals.", +"flatPath": "v1alpha/buyers/{buyersId}/finalizedDeals/{finalizedDealsId}:pause", +"httpMethod": "POST", +"id": "authorizedbuyersmarketplace.buyers.finalizedDeals.pause", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Format: `buyers/{accountId}/finalizedDeals/{dealId}`", +"location": "path", +"pattern": "^buyers/[^/]+/finalizedDeals/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}:pause", +"request": { +"$ref": "PauseFinalizedDealRequest" +}, +"response": { +"$ref": "FinalizedDeal" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +}, +"resume": { +"description": "Resumes serving of the given finalized deal. Calling this method for an running deal has no effect. If a deal is initially paused by the seller, calling this method will not resume serving of the deal until the seller also resumes the deal. This method only applies to programmatic guaranteed deals and preferred deals.", +"flatPath": "v1alpha/buyers/{buyersId}/finalizedDeals/{finalizedDealsId}:resume", +"httpMethod": "POST", +"id": "authorizedbuyersmarketplace.buyers.finalizedDeals.resume", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Format: `buyers/{accountId}/finalizedDeals/{dealId}`", +"location": "path", +"pattern": "^buyers/[^/]+/finalizedDeals/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}:resume", +"request": { +"$ref": "ResumeFinalizedDealRequest" +}, +"response": { +"$ref": "FinalizedDeal" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +}, +"setReadyToServe": { +"description": "Sets the given finalized deal as ready to serve. By default, deals are set as ready to serve as soon as they're finalized. If you want to opt out of the default behavior, and manually indicate that deals are ready to serve, ask your Technical Account Manager to add you to the allowlist. If you choose to use this method, finalized deals belonging to the bidder and its child seats don't start serving until after you call `setReadyToServe`, and after the deals become active. For example, you can use this method to delay receiving bid requests until your creative is ready. This method only applies to programmatic guaranteed deals.", +"flatPath": "v1alpha/buyers/{buyersId}/finalizedDeals/{finalizedDealsId}:setReadyToServe", +"httpMethod": "POST", +"id": "authorizedbuyersmarketplace.buyers.finalizedDeals.setReadyToServe", +"parameterOrder": [ +"deal" +], +"parameters": { +"deal": { +"description": "Required. Format: `buyers/{accountId}/finalizedDeals/{dealId}`", +"location": "path", +"pattern": "^buyers/[^/]+/finalizedDeals/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+deal}:setReadyToServe", +"request": { +"$ref": "SetReadyToServeRequest" +}, +"response": { +"$ref": "FinalizedDeal" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +} +} +}, +"proposals": { +"methods": { +"accept": { +"description": "Accepts the proposal at the given revision number. If the revision number in the request is behind the latest from the server, an error message will be returned. This call updates the Proposal.state from `BUYER_ACCEPTANCE_REQUESTED` to `FINALIZED`; it has no side effect if the Proposal.state is already `FINALIZED` and throws exception if the Proposal.state is not either `BUYER_ACCEPTANCE_REQUESTED` or `FINALIZED`. Accepting a proposal means the buyer understands and accepts the Proposal.terms_and_conditions proposed by the seller.", +"flatPath": "v1alpha/buyers/{buyersId}/proposals/{proposalsId}:accept", +"httpMethod": "POST", +"id": "authorizedbuyersmarketplace.buyers.proposals.accept", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Name of the proposal. Format: `buyers/{accountId}/proposals/{proposalId}`", +"location": "path", +"pattern": "^buyers/[^/]+/proposals/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}:accept", +"request": { +"$ref": "AcceptProposalRequest" +}, +"response": { +"$ref": "Proposal" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +}, +"addNote": { +"description": "Creates a note for this proposal and sends to the seller. This method is not supported for proposals with DealType set to 'PRIVATE_AUCTION'.", +"flatPath": "v1alpha/buyers/{buyersId}/proposals/{proposalsId}:addNote", +"httpMethod": "POST", +"id": "authorizedbuyersmarketplace.buyers.proposals.addNote", +"parameterOrder": [ +"proposal" +], +"parameters": { +"proposal": { +"description": "Name of the proposal. Format: `buyers/{accountId}/proposals/{proposalId}`", +"location": "path", +"pattern": "^buyers/[^/]+/proposals/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+proposal}:addNote", +"request": { +"$ref": "AddNoteRequest" +}, +"response": { +"$ref": "Proposal" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +}, +"cancelNegotiation": { +"description": "Cancels an ongoing negotiation on a proposal. This does not cancel or end serving for the deals if the proposal has been finalized. If the proposal has not been finalized before, calling this method will set the Proposal.state to `TERMINATED` and increment the Proposal.proposal_revision. If the proposal has been finalized before and is under renegotiation now, calling this method will reset the Proposal.state to `FINALIZED` and increment the Proposal.proposal_revision. This method does not support private auction proposals whose Proposal.deal_type is 'PRIVATE_AUCTION'.", +"flatPath": "v1alpha/buyers/{buyersId}/proposals/{proposalsId}:cancelNegotiation", +"httpMethod": "POST", +"id": "authorizedbuyersmarketplace.buyers.proposals.cancelNegotiation", +"parameterOrder": [ +"proposal" +], +"parameters": { +"proposal": { +"description": "Name of the proposal. Format: `buyers/{accountId}/proposals/{proposalId}`", +"location": "path", +"pattern": "^buyers/[^/]+/proposals/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+proposal}:cancelNegotiation", +"request": { +"$ref": "CancelNegotiationRequest" +}, +"response": { +"$ref": "Proposal" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +}, +"get": { +"description": "Gets a proposal using its resource name. The proposal is returned at the latest revision.", +"flatPath": "v1alpha/buyers/{buyersId}/proposals/{proposalsId}", +"httpMethod": "GET", +"id": "authorizedbuyersmarketplace.buyers.proposals.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the proposal. Format: `buyers/{accountId}/proposals/{proposalId}`", +"location": "path", +"pattern": "^buyers/[^/]+/proposals/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "Proposal" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +}, +"list": { +"description": "Lists proposals. A filter expression using [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) may be specified to filter the results.", +"flatPath": "v1alpha/buyers/{buyersId}/proposals", +"httpMethod": "GET", +"id": "authorizedbuyersmarketplace.buyers.proposals.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional query string using the [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) Supported columns for filtering are: * displayName * dealType * updateTime * state", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will put a size of 500.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The page token as returned from ListProposalsResponse.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Parent that owns the collection of proposals Format: `buyers/{accountId}`", +"location": "path", +"pattern": "^buyers/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/proposals", +"response": { +"$ref": "ListProposalsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +}, +"patch": { +"description": "Updates the proposal at the given revision number. If the revision number in the request is behind the latest one kept in the server, an error message will be returned. See FieldMask for how to use FieldMask. Only fields specified in the UpdateProposalRequest.update_mask will be updated; Fields noted as 'Immutable' or 'Output only' yet specified in the UpdateProposalRequest.update_mask will be ignored and left unchanged. Updating a private auction proposal is not allowed and will result in an error.", +"flatPath": "v1alpha/buyers/{buyersId}/proposals/{proposalsId}", +"httpMethod": "PATCH", +"id": "authorizedbuyersmarketplace.buyers.proposals.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Immutable. The name of the proposal serving as a unique identifier. Format: buyers/{accountId}/proposals/{proposalId}", +"location": "path", +"pattern": "^buyers/[^/]+/proposals/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "List of fields to be updated. If empty or unspecified, the service will update all fields populated in the update request excluding the output only fields and primitive fields with default value. Note that explicit field mask is required in order to reset a primitive field back to its default value, for example, false for boolean fields, 0 for integer fields. A special field mask consisting of a single path \"*\" can be used to indicate full replacement(the equivalent of PUT method), updatable fields unset or unspecified in the input will be cleared or set to default value. Output only fields will be ignored regardless of the value of updateMask.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"request": { +"$ref": "Proposal" +}, +"response": { +"$ref": "Proposal" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +}, +"sendRfp": { +"description": "Sends a request for proposal (RFP) to a publisher to initiate the negotiation regarding certain inventory. In the RFP, buyers can specify the deal type, deal terms, start and end dates, targeting, and a message to the publisher. Once the RFP is sent, a proposal in `SELLER_REVIEW_REQUESTED` state will be created and returned in the response. The publisher may review your request and respond with detailed deals in the proposal.", +"flatPath": "v1alpha/buyers/{buyersId}/proposals:sendRfp", +"httpMethod": "POST", +"id": "authorizedbuyersmarketplace.buyers.proposals.sendRfp", +"parameterOrder": [ +"buyer" +], +"parameters": { +"buyer": { +"description": "Required. The current buyer who is sending the RFP in the format: `buyers/{accountId}`.", +"location": "path", +"pattern": "^buyers/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+buyer}/proposals:sendRfp", +"request": { +"$ref": "SendRfpRequest" +}, +"response": { +"$ref": "Proposal" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +} +}, +"resources": { +"deals": { +"methods": { +"batchUpdate": { +"description": "Batch updates multiple deals in the same proposal.", +"flatPath": "v1alpha/buyers/{buyersId}/proposals/{proposalsId}/deals:batchUpdate", +"httpMethod": "POST", +"id": "authorizedbuyersmarketplace.buyers.proposals.deals.batchUpdate", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The name of the proposal containing the deals to batch update. Format: buyers/{accountId}/proposals/{proposalId}", +"location": "path", +"pattern": "^buyers/[^/]+/proposals/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/deals:batchUpdate", +"request": { +"$ref": "BatchUpdateDealsRequest" +}, +"response": { +"$ref": "BatchUpdateDealsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +}, +"get": { +"description": "Gets a deal given its name. The deal is returned at its head revision.", +"flatPath": "v1alpha/buyers/{buyersId}/proposals/{proposalsId}/deals/{dealsId}", +"httpMethod": "GET", +"id": "authorizedbuyersmarketplace.buyers.proposals.deals.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}", +"location": "path", +"pattern": "^buyers/[^/]+/proposals/[^/]+/deals/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "Deal" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +}, +"list": { +"description": "Lists all deals in a proposal. To retrieve only the finalized revision deals regardless if a deal is being renegotiated, see the FinalizedDeals resource.", +"flatPath": "v1alpha/buyers/{buyersId}/proposals/{proposalsId}/deals", +"httpMethod": "GET", +"id": "authorizedbuyersmarketplace.buyers.proposals.deals.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Requested page size. The server may return fewer results than requested. If requested more than 500, the server will return 500 results per page. If unspecified, the server will pick a default page size of 100.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The page token as returned from ListDealsResponse.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The name of the proposal containing the deals to retrieve. Format: buyers/{accountId}/proposals/{proposalId}", +"location": "path", +"pattern": "^buyers/[^/]+/proposals/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/deals", +"response": { +"$ref": "ListDealsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +}, +"patch": { +"description": "Updates the given deal at the buyer known revision number. If the server revision has advanced since the passed-in proposal.proposal_revision an ABORTED error message will be returned. The revision number is incremented by the server whenever the proposal or its constituent deals are updated. Note: The revision number is kept at a proposal level. The buyer of the API is expected to keep track of the revision number after the last update operation and send it in as part of the next update request. This way, if there are further changes on the server (for example, seller making new updates), then the server can detect conflicts and reject the proposed changes.", +"flatPath": "v1alpha/buyers/{buyersId}/proposals/{proposalsId}/deals/{dealsId}", +"httpMethod": "PATCH", +"id": "authorizedbuyersmarketplace.buyers.proposals.deals.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}", +"location": "path", +"pattern": "^buyers/[^/]+/proposals/[^/]+/deals/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "List of fields to be updated. If empty or unspecified, the service will update all fields populated in the update request excluding the output only fields and primitive fields with default value. Note that explicit field mask is required in order to reset a primitive field back to its default value, for example, false for boolean fields, 0 for integer fields. A special field mask consisting of a single path \"*\" can be used to indicate full replacement(the equivalent of PUT method), updatable fields unset or unspecified in the input will be cleared or set to default value. Output only fields will be ignored regardless of the value of updateMask.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"request": { +"$ref": "Deal" +}, +"response": { +"$ref": "Deal" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +} +} +} +} +}, +"publisherProfiles": { +"methods": { +"get": { +"description": "Gets the requested publisher profile by name.", +"flatPath": "v1alpha/buyers/{buyersId}/publisherProfiles/{publisherProfilesId}", +"httpMethod": "GET", +"id": "authorizedbuyersmarketplace.buyers.publisherProfiles.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the publisher profile. Format: `buyers/{buyerId}/publisherProfiles/{publisherProfileId}`", +"location": "path", +"pattern": "^buyers/[^/]+/publisherProfiles/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "PublisherProfile" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +}, +"list": { +"description": "Lists publisher profiles. The returned publisher profiles aren't in any defined order. The order of the results might change. A new publisher profile can appear in any place in the list of returned results.", +"flatPath": "v1alpha/buyers/{buyersId}/publisherProfiles", +"httpMethod": "GET", +"id": "authorizedbuyersmarketplace.buyers.publisherProfiles.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional query string using the [Cloud API list filtering] (https://developers.google.com/authorized-buyers/apis/guides/list-filters) syntax.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Requested page size. The server may return fewer results than requested. If requested more than 500, the server will return 500 results per page. If unspecified, the server will pick a default page size of 100.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The page token as returned from a previous ListPublisherProfilesResponse.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Parent that owns the collection of publisher profiles Format: `buyers/{buyerId}`", +"location": "path", +"pattern": "^buyers/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/publisherProfiles", +"response": { +"$ref": "ListPublisherProfilesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +} +} +} +} +} +}, +"revision": "20240718", +"rootUrl": "https://authorizedbuyersmarketplace.googleapis.com/", +"schemas": { +"AcceptProposalRequest": { +"description": "Request to accept a proposal. Accepting a proposal implies acceptance of the publisher terms_and_conditions, if any.", +"id": "AcceptProposalRequest", +"properties": { +"proposalRevision": { +"description": "The last known client revision number of the proposal.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"ActivateClientRequest": { +"description": "Request message for activating a client.", +"id": "ActivateClientRequest", +"properties": {}, +"type": "object" +}, +"ActivateClientUserRequest": { +"description": "Request message for activating a client user.", +"id": "ActivateClientUserRequest", +"properties": {}, +"type": "object" +}, +"ActivateDataSegmentRequest": { +"description": "Request message for activating a data segment", +"id": "ActivateDataSegmentRequest", +"properties": {}, +"type": "object" +}, +"AdSize": { +"description": "Represents size of a single ad slot, or a creative.", +"id": "AdSize", +"properties": { +"height": { +"description": "The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.", +"format": "int64", +"type": "string" +}, +"type": { +"description": "The type of the ad slot size.", +"enum": [ +"TYPE_UNSPECIFIED", +"PIXEL", +"INTERSTITIAL", +"NATIVE", +"FLUID" +], +"enumDescriptions": [ +"A placeholder for an undefined size type.", +"Ad slot with size specified by height and width in pixels.", +"Special size to describe an interstitial ad slot.", +"Native (mobile) ads rendered by the publisher.", +"Fluid size (responsive size) can be resized automatically with the change of outside environment." +], +"type": "string" +}, +"width": { +"description": "The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"AddCreativeRequest": { +"description": "Request message for adding creative to be used in the bidding process for the finalized deal.", +"id": "AddCreativeRequest", +"properties": { +"creative": { +"description": "Name of the creative to add to the finalized deal, in the format `buyers/{buyerAccountId}/creatives/{creativeId}`. See creative.name.", +"type": "string" +} +}, +"type": "object" +}, +"AddNoteRequest": { +"description": "Request to add a note.", +"id": "AddNoteRequest", +"properties": { +"note": { +"$ref": "Note", +"description": "The note to add." +} +}, +"type": "object" +}, +"AuctionPackage": { +"description": "Defines a segment of inventory that buyer wants to buy. It's created by buyer and could be shared with multiple buyers.", +"id": "AuctionPackage", +"properties": { +"createTime": { +"description": "Output only. Time the auction package was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"creator": { +"description": "Output only. The buyer that created this auction package. Format: `buyers/{buyerAccountId}`", +"readOnly": true, +"type": "string" +}, +"description": { +"description": "Output only. A description of the auction package.", +"readOnly": true, +"type": "string" +}, +"displayName": { +"description": "The display_name assigned to the auction package.", +"type": "string" +}, +"eligibleSeatIds": { +"description": "Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"name": { +"description": "Immutable. The unique identifier for the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}` The auction_package_id part of name is sent in the BidRequest to all RTB bidders and is returned as deal_id by the bidder in the BidResponse.", +"type": "string" +}, +"subscribedBuyers": { +"description": "Output only. The list of buyers that are subscribed to the AuctionPackage. This field is only populated when calling as a bidder. Format: `buyers/{buyerAccountId}`", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"subscribedClients": { +"description": "Output only. When calling as a buyer, the list of clients of the current buyer that are subscribed to the AuctionPackage. When calling as a bidder, the list of clients that are subscribed to the AuctionPackage owned by the bidder or its buyers. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}`", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"subscribedMediaPlanners": { +"description": "Output only. The list of media planners that are subscribed to the AuctionPackage. This field is only populated when calling as a bidder.", +"items": { +"$ref": "MediaPlanner" +}, +"readOnly": true, +"type": "array" +}, +"updateTime": { +"description": "Output only. Time the auction package was last updated. This value is only increased when this auction package is updated but never when a buyer subscribed.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"BatchUpdateDealsRequest": { +"description": "Request message for batch updating deals.", +"id": "BatchUpdateDealsRequest", +"properties": { +"requests": { +"description": "Required. List of request messages to update deals.", +"items": { +"$ref": "UpdateDealRequest" +}, +"type": "array" +} +}, +"type": "object" +}, +"BatchUpdateDealsResponse": { +"description": "Response message for batch updating deals.", +"id": "BatchUpdateDealsResponse", +"properties": { +"deals": { +"description": "Deals updated.", +"items": { +"$ref": "Deal" +}, +"type": "array" +} +}, +"type": "object" +}, +"CancelNegotiationRequest": { +"description": "Request to cancel an ongoing negotiation.", +"id": "CancelNegotiationRequest", +"properties": {}, +"type": "object" +}, +"Client": { +"description": "A client represents an agency, a brand, or an advertiser customer of the buyer. Based on the client's role, its client users will have varying levels of restricted access to the Marketplace and certain other sections of the Authorized Buyers UI.", +"id": "Client", +"properties": { +"displayName": { +"description": "Required. Display name shown to publishers. Must be unique for clients without partnerClientId specified. Maximum length of 255 characters is allowed.", +"type": "string" +}, +"name": { +"description": "Output only. The resource name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}`", +"readOnly": true, +"type": "string" +}, +"partnerClientId": { +"description": "Arbitrary unique identifier provided by the buyer. This field can be used to associate a client with an identifier in the namespace of the buyer, lookup clients by that identifier and verify whether an Authorized Buyers account of the client already exists. If present, must be unique across all the clients.", +"type": "string" +}, +"role": { +"description": "Required. The role assigned to the client. Each role implies a set of permissions granted to the client.", +"enum": [ +"CLIENT_ROLE_UNSPECIFIED", +"CLIENT_DEAL_VIEWER", +"CLIENT_DEAL_NEGOTIATOR", +"CLIENT_DEAL_APPROVER" +], +"enumDescriptions": [ +"A placeholder for an undefined client role. This value should never be specified in user input for create or update method, otherwise an error will be returned.", +"Users associated with this client role can only view proposals and deals in the Marketplace UI. They cannot negotiate or approve proposals and deals sent from publishers or send RFP to publishers.", +"Users associated with this client role can view and negotiate on the proposals and deals in the Marketplace UI sent from publishers and send RFP to publishers, but cannot approve the proposals and deals by themselves. The buyer can approve the proposals and deals on behalf of the client.", +"Users associated with this client role can view, negotiate and approve proposals and deals in the Marketplace UI and send RFP to publishers." +], +"type": "string" +}, +"sellerVisible": { +"description": "Whether the client will be visible to sellers.", +"type": "boolean" +}, +"state": { +"description": "Output only. The state of the client.", +"enum": [ +"STATE_UNSPECIFIED", +"ACTIVE", +"INACTIVE" +], +"enumDescriptions": [ +"A placeholder for an undefined client state. Should not be used.", +"A client that is currently active and allowed to access the Authorized Buyers UI.", +"A client that is currently inactive and not allowed to access the Authorized Buyers UI." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"ClientUser": { +"description": "A user of a client who has restricted access to the Marketplace and certain other sections of the Authorized Buyers UI based on the role granted to the associated client.", +"id": "ClientUser", +"properties": { +"email": { +"description": "Required. The client user's email address that has to be unique across all users for the same client.", +"type": "string" +}, +"name": { +"description": "Output only. The resource name of the client user. Format: `buyers/{accountId}/clients/{clientAccountId}/users/{userId}`", +"readOnly": true, +"type": "string" +}, +"state": { +"description": "Output only. The state of the client user.", +"enum": [ +"STATE_UNSPECIFIED", +"INVITED", +"ACTIVE", +"INACTIVE" +], +"enumDescriptions": [ +"A placeholder for an undefined user state.", +"A user who was created but hasn't accepted the invitation yet, not allowed to access the Authorized Buyers UI.", +"A user that is currently active and allowed to access the Authorized Buyers UI.", +"A user that is currently inactive and not allowed to access the Authorized Buyers UI." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"Contact": { +"description": "Contains information on how a buyer or seller can be reached.", +"id": "Contact", +"properties": { +"displayName": { +"description": "The display_name of the contact.", +"type": "string" +}, +"email": { +"description": "Email address for the contact.", +"type": "string" +} +}, +"type": "object" +}, +"CreativeRequirements": { +"description": "Message captures data about the creatives in the deal.", +"id": "CreativeRequirements", +"properties": { +"creativeFormat": { +"description": "Output only. The format of the creative, only applicable for programmatic guaranteed and preferred deals.", +"enum": [ +"CREATIVE_FORMAT_UNSPECIFIED", +"DISPLAY", +"VIDEO", +"AUDIO" +], +"enumDescriptions": [ +"A placeholder for an unspecified creative format.", +"Banner creatives such as image or HTML5 assets.", +"Video creatives that can be played in a video player.", +"Audio creatives that can play during audio content or point to a third party ad server." +], +"readOnly": true, +"type": "string" +}, +"creativePreApprovalPolicy": { +"description": "Output only. Specifies the creative pre-approval policy.", +"enum": [ +"CREATIVE_PRE_APPROVAL_POLICY_UNSPECIFIED", +"SELLER_PRE_APPROVAL_REQUIRED", +"SELLER_PRE_APPROVAL_NOT_REQUIRED" +], +"enumDescriptions": [ +"A placeholder for an undefined creative pre-approval policy.", +"The seller needs to approve each creative before it can serve.", +"The seller does not need to approve each creative before it can serve." +], +"readOnly": true, +"type": "string" +}, +"creativeSafeFrameCompatibility": { +"description": "Output only. Specifies whether the creative is safeFrame compatible.", +"enum": [ +"CREATIVE_SAFE_FRAME_COMPATIBILITY_UNSPECIFIED", +"COMPATIBLE", +"INCOMPATIBLE" +], +"enumDescriptions": [ +"A placeholder for an undefined creative safe-frame compatibility.", +"The creatives need to be compatible with the safe frame option.", +"The creatives can be incompatible with the safe frame option." +], +"readOnly": true, +"type": "string" +}, +"maxAdDurationMs": { +"description": "Output only. The max duration of the video creative in milliseconds. only applicable for deals with video creatives.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"programmaticCreativeSource": { +"description": "Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by the buyer.", +"enum": [ +"PROGRAMMATIC_CREATIVE_SOURCE_UNSPECIFIED", +"ADVERTISER", +"PUBLISHER" +], +"enumDescriptions": [ +"A placeholder for an undefined programmatic creative source.", +"The advertiser provides the creatives.", +"The publisher provides the creatives to be served." +], +"readOnly": true, +"type": "string" +}, +"skippableAdType": { +"description": "Output only. Skippable video ads allow viewers to skip ads after 5 seconds. Only applicable for deals with video creatives.", +"enum": [ +"SKIPPABLE_AD_TYPE_UNSPECIFIED", +"SKIPPABLE", +"INSTREAM_SELECT", +"NOT_SKIPPABLE", +"ANY" +], +"enumDescriptions": [ +"A placeholder for an unspecified skippable ad type.", +"Video ad that can be skipped after 5 seconds. This value will appear in RTB bid requests as SkippableBidRequestType::REQUIRE_SKIPPABLE.", +"Video ad that can be skipped after 5 seconds, and is counted as engaged view after 30 seconds. The creative is hosted on YouTube only, and viewcount of the YouTube video increments after the engaged view. This value will appear in RTB bid requests as SkippableBidRequestType::REQUIRE_SKIPPABLE.", +"This video ad is not skippable. This value will appear in RTB bid requests as SkippableBidRequestType::BLOCK_SKIPPABLE.", +"This video ad can be skipped after 5 seconds or not-skippable. This value will appear in RTB bid requests as SkippableBidRequestType::ALLOW_SKIPPABLE." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"CriteriaTargeting": { +"description": "Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax.", +"id": "CriteriaTargeting", +"properties": { +"excludedCriteriaIds": { +"description": "A list of numeric IDs to be excluded.", +"items": { +"format": "int64", +"type": "string" +}, +"type": "array" +}, +"targetedCriteriaIds": { +"description": "A list of numeric IDs to be included.", +"items": { +"format": "int64", +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"DataSegment": { +"description": "Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms.", +"id": "DataSegment", +"properties": { +"cpmFee": { +"$ref": "Money", +"description": "Optional. This will be charged when other accounts use this data segment. For example, when other accounts add this data segment to a deal or auction package." +}, +"createTime": { +"description": "Output only. Time the data segment was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Immutable. Identifier. The unique identifier for the data segment. Account ID corresponds to the account ID that created the segment. Format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}`", +"type": "string" +}, +"state": { +"description": "Output only. The state of the data segment.", +"enum": [ +"STATE_UNSPECIFIED", +"ACTIVE", +"INACTIVE" +], +"enumDescriptions": [ +"Default value.", +"The data segment is active.", +"The data segment is inactive." +], +"readOnly": true, +"type": "string" +}, +"updateTime": { +"description": "Output only. Time the data segment was last updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"DayPart": { +"description": "Defines targeting for a period of time on a specific week day.", +"id": "DayPart", +"properties": { +"dayOfWeek": { +"description": "Day of week for the period.", +"enum": [ +"DAY_OF_WEEK_UNSPECIFIED", +"MONDAY", +"TUESDAY", +"WEDNESDAY", +"THURSDAY", +"FRIDAY", +"SATURDAY", +"SUNDAY" +], +"enumDescriptions": [ +"The day of the week is unspecified.", +"Monday", +"Tuesday", +"Wednesday", +"Thursday", +"Friday", +"Saturday", +"Sunday" +], +"type": "string" +}, +"endTime": { +"$ref": "TimeOfDay", +"description": "Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored." +}, +"startTime": { +"$ref": "TimeOfDay", +"description": "Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored." +} +}, +"type": "object" +}, +"DayPartTargeting": { +"description": "Represents Daypart targeting.", +"id": "DayPartTargeting", +"properties": { +"dayParts": { +"description": "The targeted weekdays and times", +"items": { +"$ref": "DayPart" +}, +"type": "array" +}, +"timeZoneType": { +"description": "The time zone type of the day parts", +"enum": [ +"TIME_ZONE_TYPE_UNSPECIFIED", +"SELLER", +"USER" +], +"enumDescriptions": [ +"Default value. This field is unused.", +"The publisher's time zone", +"The user's time zone" +], +"type": "string" +} +}, +"type": "object" +}, +"DeactivateClientRequest": { +"description": "Request message for disabling a client.", +"id": "DeactivateClientRequest", +"properties": {}, +"type": "object" +}, +"DeactivateClientUserRequest": { +"description": "Request message for deactivating a client user.", +"id": "DeactivateClientUserRequest", +"properties": {}, +"type": "object" +}, +"DeactivateDataSegmentRequest": { +"description": "Request message for deactivating a data segment", +"id": "DeactivateDataSegmentRequest", +"properties": {}, +"type": "object" +}, +"Deal": { +"description": "A deal represents a segment of inventory for displaying ads that contains the terms and targeting information that is used for serving as well as the deal stats and status. Note: A proposal may contain multiple deals.", +"id": "Deal", +"properties": { +"billedBuyer": { +"description": "Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer; when the deal belongs to a media planner account, this field will be empty. Format : `buyers/{buyerAccountId}`", +"readOnly": true, +"type": "string" +}, +"buyer": { +"description": "Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. Format: `buyers/{buyerAccountId}`", +"readOnly": true, +"type": "string" +}, +"client": { +"description": "Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`", +"readOnly": true, +"type": "string" +}, +"createTime": { +"description": "Output only. The time of the deal creation.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"creativeRequirements": { +"$ref": "CreativeRequirements", +"description": "Output only. Metadata about the creatives of this deal.", +"readOnly": true +}, +"dealType": { +"description": "Output only. Type of deal.", +"enum": [ +"DEAL_TYPE_UNSPECIFIED", +"PREFERRED_DEAL", +"PRIVATE_AUCTION", +"PROGRAMMATIC_GUARANTEED" +], +"enumDescriptions": [ +"Default, unspecified deal type.", +"Preferred deals.", +"Private auction deals.", +"Programmatic guaranteed deals." +], +"readOnly": true, +"type": "string" +}, +"deliveryControl": { +"$ref": "DeliveryControl", +"description": "Output only. Specifies the pacing set by the publisher.", +"readOnly": true +}, +"description": { +"description": "Output only. Free text description for the deal terms.", +"readOnly": true, +"type": "string" +}, +"displayName": { +"description": "Output only. The name of the deal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the deal.", +"readOnly": true, +"type": "string" +}, +"eligibleSeatIds": { +"description": "Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"estimatedGrossSpend": { +"$ref": "Money", +"description": "Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly." +}, +"flightEndTime": { +"description": "Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not necessary for Private Auction deals.", +"format": "google-datetime", +"type": "string" +}, +"flightStartTime": { +"description": "Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (for example, in milliseconds) will be truncated towards the start of time in seconds.", +"format": "google-datetime", +"type": "string" +}, +"mediaPlanner": { +"$ref": "MediaPlanner", +"description": "Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. This field represents a media planner (For example, agency or big advertiser).", +"readOnly": true +}, +"name": { +"description": "Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}", +"type": "string" +}, +"preferredDealTerms": { +"$ref": "PreferredDealTerms", +"description": "The terms for preferred deals." +}, +"privateAuctionTerms": { +"$ref": "PrivateAuctionTerms", +"description": "The terms for private auction deals." +}, +"programmaticGuaranteedTerms": { +"$ref": "ProgrammaticGuaranteedTerms", +"description": "The terms for programmatic guaranteed deals." +}, +"proposalRevision": { +"description": "Output only. The revision number for the proposal and is the same value as proposal.proposal_revision. Each update to deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"publisherProfile": { +"description": "Immutable. Reference to the seller on the deal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}`", +"type": "string" +}, +"sellerTimeZone": { +"$ref": "TimeZone", +"description": "Output only. Time zone of the seller used to mark the boundaries of a day for daypart targeting and CPD billing.", +"readOnly": true +}, +"targeting": { +"$ref": "MarketplaceTargeting", +"description": "Specifies the subset of inventory targeted by the deal. Can be updated by the buyer before the deal is finalized." +}, +"updateTime": { +"description": "Output only. The time when the deal was last updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"DealPausingInfo": { +"description": "Information related to deal pausing.", +"id": "DealPausingInfo", +"properties": { +"pauseReason": { +"description": "The reason for the pausing of the deal; empty for active deals.", +"type": "string" +}, +"pauseRole": { +"description": "The party that first paused the deal; unspecified for active deals.", +"enum": [ +"BUYER_SELLER_ROLE_UNSPECIFIED", +"BUYER", +"SELLER" +], +"enumDescriptions": [ +"A placeholder for an undefined buyer/seller role.", +"Specifies the role as buyer.", +"Specifies the role as seller." +], +"type": "string" +}, +"pausingConsented": { +"description": "Whether pausing is consented between buyer and seller for the deal.", +"type": "boolean" +} +}, +"type": "object" +}, +"DeliveryControl": { +"description": "Message contains details about how the deal will be paced.", +"id": "DeliveryControl", +"properties": { +"companionDeliveryType": { +"description": "Output only. Specifies roadblocking in a main companion lineitem.", +"enum": [ +"COMPANION_DELIVERY_TYPE_UNSPECIFIED", +"DELIVERY_OPTIONAL", +"DELIVERY_AT_LEAST_ONE", +"DELIVERY_ALL" +], +"enumDescriptions": [ +"A placeholder for an unspecified companion delivery type.", +"Companions are not required to serve a creative set. The creative set can serve an inventory that has zero or more matching companions.", +"At least one companion must be served in order for the creative set to be used.", +"All companions in the set must be served in order for the creative set to be used. This can still serve to inventory that has more companions than can be filled." +], +"readOnly": true, +"type": "string" +}, +"creativeRotationType": { +"description": "Output only. Specifies strategy to use for selecting a creative when multiple creatives of the same size are available.", +"enum": [ +"CREATIVE_ROTATION_TYPE_UNSPECIFIED", +"ROTATION_EVEN", +"ROTATION_OPTIMIZED", +"ROTATION_MANUAL", +"ROTATION_SEQUENTIAL" +], +"enumDescriptions": [ +"Creatives are displayed roughly the same number of times over the duration of the deal.", +"Creatives are displayed roughly the same number of times over the duration of the deal.", +"Creatives are served roughly proportionally to their performance.", +"Creatives are served roughly proportionally to their weights.", +"Creatives are served exactly in sequential order, also known as Storyboarding." +], +"readOnly": true, +"type": "string" +}, +"deliveryRateType": { +"description": "Output only. Specifies how the impression delivery will be paced.", +"enum": [ +"DELIVERY_RATE_TYPE_UNSPECIFIED", +"EVENLY", +"FRONT_LOADED", +"AS_FAST_AS_POSSIBLE" +], +"enumDescriptions": [ +"A placeholder for an undefined delivery rate type.", +"Impressions are served uniformly over the life of the deal.", +"Impressions are served front-loaded.", +"Impressions are served as fast as possible." +], +"readOnly": true, +"type": "string" +}, +"frequencyCap": { +"description": "Output only. Specifies any frequency caps. Cannot be filtered within ListDealsRequest.", +"items": { +"$ref": "FrequencyCap" +}, +"readOnly": true, +"type": "array" +}, +"roadblockingType": { +"description": "Output only. Specifies the roadblocking type in display creatives.", +"enum": [ +"ROADBLOCKING_TYPE_UNSPECIFIED", +"ONLY_ONE", +"ONE_OR_MORE", +"AS_MANY_AS_POSSIBLE", +"ALL_ROADBLOCK", +"CREATIVE_SET" +], +"enumDescriptions": [ +"A placeholder for an unspecified roadblocking type.", +"Only one creative from a deal can serve per ad request. https://support.google.com/admanager/answer/177277.", +"Any number of creatives from a deal can serve together per ad request.", +"As many creatives from a deal as can fit on a page will serve. This could mean anywhere from one to all of a deal's creatives given the size constraints of ad slots on a page.", +"All or none of the creatives from a deal will serve.", +"A main/companion creative set roadblocking type." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"Empty": { +"description": "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); }", +"id": "Empty", +"properties": {}, +"type": "object" +}, +"FinalizedDeal": { +"description": "A finalized deal is a snapshot of the deal when both buyer and seller accept the deal. The buyer or seller can update the deal after it's been finalized and renegotiate on the deal targeting, terms and other fields, while at the same time the finalized snapshot of the deal can still be retrieved using this API. The finalized deal contains a copy of the deal as it existed when most recently finalized, as well as fields related to deal serving such as pause/resume status, RTB metrics, and more.", +"id": "FinalizedDeal", +"properties": { +"deal": { +"$ref": "Deal", +"description": "A copy of the Deal made upon finalization. During renegotiation, this will reflect the last finalized deal before renegotiation was initiated." +}, +"dealPausingInfo": { +"$ref": "DealPausingInfo", +"description": "Information related to deal pausing for the deal." +}, +"dealServingStatus": { +"description": "Serving status of the deal.", +"enum": [ +"DEAL_SERVING_STATUS_UNSPECIFIED", +"ACTIVE", +"ENDED", +"PAUSED_BY_BUYER", +"PAUSED_BY_SELLER" +], +"enumDescriptions": [ +"Unspecified.", +"The deal is actively serving or ready to serve when the start date is reached.", +"The deal serving has ended.", +"The deal serving is paused by buyer.", +"The deal serving is paused by seller." +], +"type": "string" +}, +"name": { +"description": "The resource name of the finalized deal. Format: `buyers/{accountId}/finalizedDeals/{finalizedDealId}`", +"type": "string" +}, +"readyToServe": { +"description": "Whether the Programmatic Guaranteed deal is ready for serving.", +"type": "boolean" +}, +"rtbMetrics": { +"$ref": "RtbMetrics", +"description": "Real-time bidding metrics for this deal." +} +}, +"type": "object" +}, +"FirstPartyMobileApplicationTargeting": { +"description": "Represents a list of targeted and excluded mobile application IDs that publishers own. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded.", +"id": "FirstPartyMobileApplicationTargeting", +"properties": { +"excludedAppIds": { +"description": "A list of application IDs to be excluded.", +"items": { +"type": "string" +}, +"type": "array" +}, +"targetedAppIds": { +"description": "A list of application IDs to be included.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"FrequencyCap": { +"description": "Message contains details about publisher-set frequency caps of the delivery.", +"id": "FrequencyCap", +"properties": { +"maxImpressions": { +"description": "The maximum number of impressions that can be served to a user within the specified time period.", +"format": "int32", +"type": "integer" +}, +"timeUnitType": { +"description": "The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped.", +"enum": [ +"TIME_UNIT_TYPE_UNSPECIFIED", +"MINUTE", +"HOUR", +"DAY", +"WEEK", +"MONTH", +"LIFETIME", +"POD", +"STREAM" +], +"enumDescriptions": [ +"A placeholder for an undefined time unit type. This just indicates the variable with this value hasn't been initialized.", +"Minute unit.", +"Hour unit.", +"Day unit.", +"Week unit.", +"Month unit.", +"Lifecycle/Lifetime unit.", +"Pod unit.", +"Stream unit." +], +"type": "string" +}, +"timeUnitsCount": { +"description": "The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"InventorySizeTargeting": { +"description": "Represents the size of an ad unit that can be targeted on a bid request.", +"id": "InventorySizeTargeting", +"properties": { +"excludedInventorySizes": { +"description": "A list of inventory sizes to be excluded.", +"items": { +"$ref": "AdSize" +}, +"type": "array" +}, +"targetedInventorySizes": { +"description": "A list of inventory sizes to be included.", +"items": { +"$ref": "AdSize" +}, +"type": "array" +} +}, +"type": "object" +}, +"InventoryTypeTargeting": { +"description": "Targeting of the inventory types a bid request can originate from.", +"id": "InventoryTypeTargeting", +"properties": { +"inventoryTypes": { +"description": "The list of targeted inventory types for the bid request.", +"items": { +"enum": [ +"INVENTORY_TYPE_UNSPECIFIED", +"BROWSER", +"MOBILE_APP", +"VIDEO_PLAYER" +], +"enumDescriptions": [ +"Unspecified inventory type", +"Desktop or mobile web browser excluding ads inside a video player", +"Mobile apps other than video players and web browsers", +"Instream video and audio" +], +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"ListAuctionPackagesResponse": { +"description": "Response message for listing auction packages.", +"id": "ListAuctionPackagesResponse", +"properties": { +"auctionPackages": { +"description": "The list of auction packages.", +"items": { +"$ref": "AuctionPackage" +}, +"type": "array" +}, +"nextPageToken": { +"description": "Continuation token for fetching the next page of results. Pass this value in the ListAuctionPackagesRequest.pageToken field in the subsequent call to the `ListAuctionPackages` method to retrieve the next page of results.", +"type": "string" +} +}, +"type": "object" +}, +"ListClientUsersResponse": { +"description": "Response message for the list method.", +"id": "ListClientUsersResponse", +"properties": { +"clientUsers": { +"description": "The returned list of client users.", +"items": { +"$ref": "ClientUser" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token to retrieve the next page of results. Pass this value in the ListClientUsersRequest.pageToken field in the subsequent call to the list method to retrieve the next page of results.", +"type": "string" +} +}, +"type": "object" +}, +"ListClientsResponse": { +"description": "Response message for the list method.", +"id": "ListClientsResponse", +"properties": { +"clients": { +"description": "The returned list of clients.", +"items": { +"$ref": "Client" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token to retrieve the next page of results. Pass this value in the ListClientsRequest.pageToken field in the subsequent call to the list method to retrieve the next page of results.", +"type": "string" +} +}, +"type": "object" +}, +"ListDataSegmentsResponse": { +"description": "Response message for listing data segments.", +"id": "ListDataSegmentsResponse", +"properties": { +"dataSegments": { +"description": "The list of data segments.", +"items": { +"$ref": "DataSegment" +}, +"type": "array" +}, +"nextPageToken": { +"description": "Continuation token for fetching the next page of results. Pass this value in the ListDataSegmentsRequest.pageToken field in the subsequent call to the `ListDataSegments` method to retrieve the next page of results.", +"type": "string" +} +}, +"type": "object" +}, +"ListDealsResponse": { +"description": "Response message for listing deals in a proposal.", +"id": "ListDealsResponse", +"properties": { +"deals": { +"description": "The list of deals.", +"items": { +"$ref": "Deal" +}, +"type": "array" +}, +"nextPageToken": { +"description": "Token to fetch the next page of results.", +"type": "string" +} +}, +"type": "object" +}, +"ListFinalizedDealsResponse": { +"description": "Response message for listing finalized deals.", +"id": "ListFinalizedDealsResponse", +"properties": { +"finalizedDeals": { +"description": "The list of finalized deals.", +"items": { +"$ref": "FinalizedDeal" +}, +"type": "array" +}, +"nextPageToken": { +"description": "Token to fetch the next page of results.", +"type": "string" +} +}, +"type": "object" +}, +"ListProposalsResponse": { +"description": "Response message for listing proposals.", +"id": "ListProposalsResponse", +"properties": { +"nextPageToken": { +"description": "Continuation token for fetching the next page of results.", +"type": "string" +}, +"proposals": { +"description": "The list of proposals.", +"items": { +"$ref": "Proposal" +}, +"type": "array" +} +}, +"type": "object" +}, +"ListPublisherProfilesResponse": { +"description": "Response message for profiles visible to the buyer.", +"id": "ListPublisherProfilesResponse", +"properties": { +"nextPageToken": { +"description": "Token to fetch the next page of results.", +"type": "string" +}, +"publisherProfiles": { +"description": "The list of matching publisher profiles.", +"items": { +"$ref": "PublisherProfile" +}, +"type": "array" +} +}, +"type": "object" +}, +"MarketplaceTargeting": { +"description": "Targeting represents different criteria that can be used to target deals or auction packages. For example, they can choose to target inventory only if the user is in the US. Multiple types of targeting are always applied as a logical AND, unless noted otherwise.", +"id": "MarketplaceTargeting", +"properties": { +"daypartTargeting": { +"$ref": "DayPartTargeting", +"description": "Daypart targeting information." +}, +"excludedSensitiveCategoryIds": { +"description": "Output only. The sensitive content category label IDs excluded. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs.", +"items": { +"format": "int64", +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"geoTargeting": { +"$ref": "CriteriaTargeting", +"description": "Output only. Geo criteria IDs to be included/excluded.", +"readOnly": true +}, +"inventorySizeTargeting": { +"$ref": "InventorySizeTargeting", +"description": "Output only. Inventory sizes to be included/excluded.", +"readOnly": true +}, +"inventoryTypeTargeting": { +"$ref": "InventoryTypeTargeting", +"description": "Output only. Inventory type targeting information.", +"readOnly": true +}, +"placementTargeting": { +"$ref": "PlacementTargeting", +"description": "Output only. Placement targeting information, for example, URL, mobile applications.", +"readOnly": true +}, +"technologyTargeting": { +"$ref": "TechnologyTargeting", +"description": "Output only. Technology targeting information, for example, operating system, device category.", +"readOnly": true +}, +"userListTargeting": { +"$ref": "CriteriaTargeting", +"description": "Buyer user list targeting information. User lists can be uploaded using https://developers.google.com/authorized-buyers/rtb/bulk-uploader." +}, +"verticalTargeting": { +"$ref": "CriteriaTargeting", +"description": "Output only. The verticals included or excluded as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals", +"readOnly": true +}, +"videoTargeting": { +"$ref": "VideoTargeting", +"description": "Output only. Video targeting information.", +"readOnly": true +} +}, +"type": "object" +}, +"MediaPlanner": { +"description": "Describes a single Media Planner account.", +"id": "MediaPlanner", +"properties": { +"accountId": { +"description": "Output only. Account ID of the media planner.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"MobileApplicationTargeting": { +"description": "Mobile application targeting settings.", +"id": "MobileApplicationTargeting", +"properties": { +"firstPartyTargeting": { +"$ref": "FirstPartyMobileApplicationTargeting", +"description": "Publisher owned apps to be targeted or excluded by the publisher to display the ads in." +} +}, +"type": "object" +}, +"Money": { +"description": "Represents an amount of money with its currency type.", +"id": "Money", +"properties": { +"currencyCode": { +"description": "The three-letter currency code defined in ISO 4217.", +"type": "string" +}, +"nanos": { +"description": "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.", +"format": "int32", +"type": "integer" +}, +"units": { +"description": "The whole units of the amount. For example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"Note": { +"description": "A text note attached to the proposal to facilitate the communication between buyers and sellers.", +"id": "Note", +"properties": { +"createTime": { +"description": "Output only. When this note was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"creatorRole": { +"description": "Output only. The role who created the note.", +"enum": [ +"BUYER_SELLER_ROLE_UNSPECIFIED", +"BUYER", +"SELLER" +], +"enumDescriptions": [ +"A placeholder for an undefined buyer/seller role.", +"Specifies the role as buyer.", +"Specifies the role as seller." +], +"readOnly": true, +"type": "string" +}, +"note": { +"description": "The text of the note. Maximum length is 1024 characters.", +"type": "string" +} +}, +"type": "object" +}, +"OperatingSystemTargeting": { +"description": "Represents targeting information for operating systems.", +"id": "OperatingSystemTargeting", +"properties": { +"operatingSystemCriteria": { +"$ref": "CriteriaTargeting", +"description": "IDs of operating systems to be included/excluded." +}, +"operatingSystemVersionCriteria": { +"$ref": "CriteriaTargeting", +"description": "IDs of operating system versions to be included/excluded." +} +}, +"type": "object" +}, +"PauseFinalizedDealRequest": { +"description": "Request message for pausing a finalized deal.", +"id": "PauseFinalizedDealRequest", +"properties": { +"reason": { +"description": "The reason to pause the finalized deal, will be displayed to the seller. Maximum length is 1000 characters.", +"type": "string" +} +}, +"type": "object" +}, +"PlacementTargeting": { +"description": "Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR'ed.", +"id": "PlacementTargeting", +"properties": { +"mobileApplicationTargeting": { +"$ref": "MobileApplicationTargeting", +"description": "Mobile application targeting information in a deal. This doesn't apply to Auction Packages." +}, +"uriTargeting": { +"$ref": "UriTargeting", +"description": "URLs to be included/excluded." +} +}, +"type": "object" +}, +"PreferredDealTerms": { +"description": "Pricing terms for Preferred Deals.", +"id": "PreferredDealTerms", +"properties": { +"fixedPrice": { +"$ref": "Price", +"description": "Fixed price for the deal." +} +}, +"type": "object" +}, +"Price": { +"description": "Represents a price and a pricing type for a deal.", +"id": "Price", +"properties": { +"amount": { +"$ref": "Money", +"description": "The actual price with currency specified." +}, +"type": { +"description": "The pricing type for the deal.", +"enum": [ +"TYPE_UNSPECIFIED", +"CPM", +"CPD" +], +"enumDescriptions": [ +"A placeholder for an undefined pricing type. If the pricing type is unspecified, CPM will be used instead.", +"Cost per thousand impressions.", +"Cost per day." +], +"type": "string" +} +}, +"type": "object" +}, +"PrivateAuctionTerms": { +"description": "Pricing terms for Private Auctions.", +"id": "PrivateAuctionTerms", +"properties": { +"floorPrice": { +"$ref": "Price", +"description": "The minimum price buyer has to bid to compete in the private auction." +}, +"openAuctionAllowed": { +"description": "Output only. True if open auction buyers are allowed to compete with invited buyers in this private auction.", +"readOnly": true, +"type": "boolean" +} +}, +"type": "object" +}, +"PrivateData": { +"description": "Buyers are allowed to store certain types of private data in a proposal or deal.", +"id": "PrivateData", +"properties": { +"referenceId": { +"description": "A buyer specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units).", +"type": "string" +} +}, +"type": "object" +}, +"ProgrammaticGuaranteedTerms": { +"description": "Pricing terms for Programmatic Guaranteed Deals.", +"id": "ProgrammaticGuaranteedTerms", +"properties": { +"fixedPrice": { +"$ref": "Price", +"description": "Fixed price for the deal." +}, +"guaranteedLooks": { +"description": "Count of guaranteed looks. For CPD deals, buyer changes to guaranteed_looks will be ignored.", +"format": "int64", +"type": "string" +}, +"impressionCap": { +"description": "The lifetime impression cap for CPM Sponsorship deals. Deal will stop serving when cap is reached.", +"format": "int64", +"type": "string" +}, +"minimumDailyLooks": { +"description": "Daily minimum looks for CPD deal types. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.", +"format": "int64", +"type": "string" +}, +"percentShareOfVoice": { +"description": "For sponsorship deals, this is the percentage of the seller's eligible impressions that the deal will serve until the cap is reached. Valid value is within range 0~100.", +"format": "int64", +"type": "string" +}, +"reservationType": { +"description": "The reservation type for a Programmatic Guaranteed deal. This indicates whether the number of impressions is fixed, or a percent of available impressions. If not specified, the default reservation type is STANDARD.", +"enum": [ +"RESERVATION_TYPE_UNSPECIFIED", +"STANDARD", +"SPONSORSHIP" +], +"enumDescriptions": [ +"An unspecified reservation type.", +"Non-sponsorship deal.", +"Sponsorship deals don't have impression goal (guaranteed_looks) and they are served based on the flight dates. For CPM Sponsorship deals, impression_cap is the lifetime impression limit." +], +"type": "string" +} +}, +"type": "object" +}, +"Proposal": { +"description": "Represents a proposal in the Marketplace. A proposal is the unit of negotiation between a seller and a buyer.", +"id": "Proposal", +"properties": { +"billedBuyer": { +"description": "Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer. Format : `buyers/{buyerAccountId}`", +"readOnly": true, +"type": "string" +}, +"buyer": { +"description": "Output only. Refers to a buyer in The Realtime-bidding API. Format: `buyers/{buyerAccountId}`", +"readOnly": true, +"type": "string" +}, +"buyerContacts": { +"description": "Contact information for the buyer.", +"items": { +"$ref": "Contact" +}, +"type": "array" +}, +"buyerPrivateData": { +"$ref": "PrivateData", +"description": "Buyer private data (hidden from seller)." +}, +"client": { +"description": "Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`", +"readOnly": true, +"type": "string" +}, +"dealType": { +"description": "Output only. Type of deal the proposal contains.", +"enum": [ +"DEAL_TYPE_UNSPECIFIED", +"PREFERRED_DEAL", +"PRIVATE_AUCTION", +"PROGRAMMATIC_GUARANTEED" +], +"enumDescriptions": [ +"Default, unspecified deal type.", +"Preferred deals.", +"Private auction deals.", +"Programmatic guaranteed deals." +], +"readOnly": true, +"type": "string" +}, +"displayName": { +"description": "Output only. The descriptive name for the proposal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the proposal.", +"readOnly": true, +"type": "string" +}, +"isRenegotiating": { +"description": "Output only. True if the proposal was previously finalized and is now being renegotiated.", +"readOnly": true, +"type": "boolean" +}, +"lastUpdaterOrCommentorRole": { +"description": "Output only. The role of the last user that either updated the proposal or left a comment.", +"enum": [ +"BUYER_SELLER_ROLE_UNSPECIFIED", +"BUYER", +"SELLER" +], +"enumDescriptions": [ +"A placeholder for an undefined buyer/seller role.", +"Specifies the role as buyer.", +"Specifies the role as seller." +], +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Immutable. The name of the proposal serving as a unique identifier. Format: buyers/{accountId}/proposals/{proposalId}", +"type": "string" +}, +"notes": { +"description": "A list of notes from the buyer and the seller attached to this proposal.", +"items": { +"$ref": "Note" +}, +"type": "array" +}, +"originatorRole": { +"description": "Output only. Indicates whether the buyer/seller created the proposal.", +"enum": [ +"BUYER_SELLER_ROLE_UNSPECIFIED", +"BUYER", +"SELLER" +], +"enumDescriptions": [ +"A placeholder for an undefined buyer/seller role.", +"Specifies the role as buyer.", +"Specifies the role as seller." +], +"readOnly": true, +"type": "string" +}, +"pausingConsented": { +"description": "Whether pausing is allowed for the proposal. This is a negotiable term between buyers and publishers.", +"type": "boolean" +}, +"proposalRevision": { +"description": "Output only. The revision number for the proposal. Each update to the proposal or deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"publisherProfile": { +"description": "Immutable. Reference to the seller on the proposal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}` Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error.", +"type": "string" +}, +"sellerContacts": { +"description": "Output only. Contact information for the seller.", +"items": { +"$ref": "Contact" +}, +"readOnly": true, +"type": "array" +}, +"state": { +"description": "Output only. Indicates the state of the proposal.", +"enum": [ +"STATE_UNSPECIFIED", +"BUYER_REVIEW_REQUESTED", +"SELLER_REVIEW_REQUESTED", +"BUYER_ACCEPTANCE_REQUESTED", +"FINALIZED", +"TERMINATED" +], +"enumDescriptions": [ +"Unspecified proposal state", +"When a proposal is waiting for buyer to review.", +"When the proposal is waiting for the seller to review.", +"When the seller accepted the proposal and sent it to the buyer for review.", +"When both buyer and seller has accepted the proposal", +"When either buyer or seller has cancelled the proposal" +], +"readOnly": true, +"type": "string" +}, +"termsAndConditions": { +"description": "Output only. The terms and conditions associated with this proposal. Accepting a proposal implies acceptance of this field. This is created by the seller, the buyer can only view it.", +"readOnly": true, +"type": "string" +}, +"updateTime": { +"description": "Output only. The time when the proposal was last revised.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"PublisherProfile": { +"description": "The values in the publisher profile are supplied by the publisher. All fields are not filterable unless stated otherwise.", +"id": "PublisherProfile", +"properties": { +"audienceDescription": { +"description": "Description on the publisher's audience.", +"type": "string" +}, +"directDealsContact": { +"description": "Contact information for direct reservation deals. This is free text entered by the publisher and may include information like names, phone numbers and email addresses.", +"type": "string" +}, +"displayName": { +"description": "Display name of the publisher profile. Can be used to filter the response of the publisherProfiles.list method.", +"type": "string" +}, +"domains": { +"description": "The list of domains represented in this publisher profile. Empty if this is a parent profile. These are top private domains, meaning that these will not contain a string like \"photos.google.co.uk/123\", but will instead contain \"google.co.uk\". Can be used to filter the response of the publisherProfiles.list method.", +"items": { +"type": "string" +}, +"type": "array" +}, +"isParent": { +"description": "Indicates if this profile is the parent profile of the seller. A parent profile represents all the inventory from the seller, as opposed to child profile that is created to brand a portion of inventory. One seller has only one parent publisher profile, and can have multiple child profiles. See https://support.google.com/admanager/answer/6035806 for details. Can be used to filter the response of the publisherProfiles.list method by setting the filter to \"is_parent: true\".", +"type": "boolean" +}, +"logoUrl": { +"description": "A Google public URL to the logo for this publisher profile. The logo is stored as a PNG, JPG, or GIF image.", +"type": "string" +}, +"mediaKitUrl": { +"description": "URL to additional marketing and sales materials.", +"type": "string" +}, +"mobileApps": { +"description": "The list of apps represented in this publisher profile. Empty if this is a parent profile.", +"items": { +"$ref": "PublisherProfileMobileApplication" +}, +"type": "array" +}, +"name": { +"description": "Name of the publisher profile. Format: `buyers/{buyer}/publisherProfiles/{publisher_profile}`", +"type": "string" +}, +"overview": { +"description": "Overview of the publisher.", +"type": "string" +}, +"pitchStatement": { +"description": "Statement explaining what's unique about publisher's business, and why buyers should partner with the publisher.", +"type": "string" +}, +"programmaticDealsContact": { +"description": "Contact information for programmatic deals. This is free text entered by the publisher and may include information like names, phone numbers and email addresses.", +"type": "string" +}, +"publisherCode": { +"description": "A unique identifying code for the seller. This value is the same for all of the seller's parent and child publisher profiles. Can be used to filter the response of the publisherProfiles.list method.", +"type": "string" +}, +"samplePageUrl": { +"description": "URL to a sample content page.", +"type": "string" +}, +"topHeadlines": { +"description": "Up to three key metrics and rankings. For example, \"#1 Mobile News Site for 20 Straight Months\".", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"PublisherProfileMobileApplication": { +"description": "A mobile application that contains a external app ID, name, and app store.", +"id": "PublisherProfileMobileApplication", +"properties": { +"appStore": { +"description": "The app store the app belongs to. Can be used to filter the response of the publisherProfiles.list method.", +"enum": [ +"APP_STORE_TYPE_UNSPECIFIED", +"APPLE_ITUNES", +"GOOGLE_PLAY", +"ROKU", +"AMAZON_FIRE_TV", +"PLAYSTATION", +"XBOX", +"SAMSUNG_TV", +"AMAZON", +"OPPO", +"SAMSUNG", +"VIVO", +"XIAOMI", +"LG_TV" +], +"enumDescriptions": [ +"A placeholder for an unknown app store.", +"Apple iTunes", +"Google Play", +"Roku", +"Amazon Fire TV", +"PlayStation", +"Xbox", +"Samsung TV", +"Amazon Appstore", +"OPPO App Market", +"Samsung Galaxy Store", +"VIVO App Store", +"Xiaomi GetApps", +"LG TV" +], +"type": "string" +}, +"externalAppId": { +"description": "The external ID for the app from its app store. Can be used to filter the response of the publisherProfiles.list method.", +"type": "string" +}, +"name": { +"description": "The name of the app.", +"type": "string" +} +}, +"type": "object" +}, +"ResumeFinalizedDealRequest": { +"description": "Request message for resuming a finalized deal.", +"id": "ResumeFinalizedDealRequest", +"properties": {}, +"type": "object" +}, +"RtbMetrics": { +"description": "Real-time bidding metrics. For what each metric means refer to [Report metrics](https://support.google.com/adxbuyer/answer/6115195#report-metrics)", +"id": "RtbMetrics", +"properties": { +"adImpressions7Days": { +"description": "Ad impressions in last 7 days.", +"format": "int64", +"type": "string" +}, +"bidRate7Days": { +"description": "Bid rate in last 7 days, calculated by (bids / bid requests).", +"format": "double", +"type": "number" +}, +"bidRequests7Days": { +"description": "Bid requests in last 7 days.", +"format": "int64", +"type": "string" +}, +"bids7Days": { +"description": "Bids in last 7 days.", +"format": "int64", +"type": "string" +}, +"filteredBidRate7Days": { +"description": "Filtered bid rate in last 7 days, calculated by (filtered bids / bids).", +"format": "double", +"type": "number" +}, +"mustBidRateCurrentMonth": { +"description": "Must bid rate for current month.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"SendRfpRequest": { +"description": "Request to send an RFP. All fields in this request are proposed to publisher and subject to changes by publisher during later negotiation.", +"id": "SendRfpRequest", +"properties": { +"buyerContacts": { +"description": "Contact information for the buyer.", +"items": { +"$ref": "Contact" +}, +"type": "array" +}, +"client": { +"description": "If the current buyer is sending the RFP on behalf of its client, use this field to specify the name of the client in the format: `buyers/{accountId}/clients/{clientAccountid}`.", +"type": "string" +}, +"displayName": { +"description": "Required. The display name of the proposal being created by this RFP.", +"type": "string" +}, +"estimatedGrossSpend": { +"$ref": "Money", +"description": "Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly." +}, +"flightEndTime": { +"description": "Required. Proposed flight end time of the RFP. A timestamp in RFC3339 UTC \"Zulu\" format. Note that the specified value will be truncated to a granularity of one second.", +"format": "google-datetime", +"type": "string" +}, +"flightStartTime": { +"description": "Required. Proposed flight start time of the RFP. A timestamp in RFC3339 UTC \"Zulu\" format. Note that the specified value will be truncated to a granularity of one second.", +"format": "google-datetime", +"type": "string" +}, +"geoTargeting": { +"$ref": "CriteriaTargeting", +"description": "Geo criteria IDs to be targeted. Refer to Geo tables." +}, +"inventorySizeTargeting": { +"$ref": "InventorySizeTargeting", +"description": "Inventory sizes to be targeted." +}, +"note": { +"description": "A message that is sent to the publisher. Maximum length is 1024 characters.", +"type": "string" +}, +"preferredDealTerms": { +"$ref": "PreferredDealTerms", +"description": "The terms for preferred deals." +}, +"programmaticGuaranteedTerms": { +"$ref": "ProgrammaticGuaranteedTerms", +"description": "The terms for programmatic guaranteed deals." +}, +"publisherProfile": { +"description": "Required. The profile of the publisher who will receive this RFP in the format: `buyers/{accountId}/publisherProfiles/{publisherProfileId}`.", +"type": "string" +} +}, +"type": "object" +}, +"SetReadyToServeRequest": { +"description": "Request message for setting ready to serve for a finalized deal.", +"id": "SetReadyToServeRequest", +"properties": {}, +"type": "object" +}, +"SubscribeAuctionPackageRequest": { +"description": "Request message for SubscribeAuctionPackage.", +"id": "SubscribeAuctionPackageRequest", +"properties": {}, +"type": "object" +}, +"SubscribeClientsRequest": { +"description": "Request message for SubscribeAuctionPackageClients.", +"id": "SubscribeClientsRequest", +"properties": { +"clients": { +"description": "Optional. A list of client buyers to subscribe to the auction package, with client buyer in the format `buyers/{accountId}/clients/{clientAccountId}`. The current buyer will be subscribed to the auction package regardless of the list contents if not already.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"TechnologyTargeting": { +"description": "Represents targeting about various types of technology.", +"id": "TechnologyTargeting", +"properties": { +"deviceCapabilityTargeting": { +"$ref": "CriteriaTargeting", +"description": "IDs of device capabilities to be included/excluded." +}, +"deviceCategoryTargeting": { +"$ref": "CriteriaTargeting", +"description": "IDs of device categories to be included/excluded." +}, +"operatingSystemTargeting": { +"$ref": "OperatingSystemTargeting", +"description": "Operating system related targeting information." +} +}, +"type": "object" +}, +"TimeOfDay": { +"description": "Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.", +"id": "TimeOfDay", +"properties": { +"hours": { +"description": "Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.", +"format": "int32", +"type": "integer" +}, +"minutes": { +"description": "Minutes of hour of day. Must be from 0 to 59.", +"format": "int32", +"type": "integer" +}, +"nanos": { +"description": "Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.", +"format": "int32", +"type": "integer" +}, +"seconds": { +"description": "Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"TimeZone": { +"description": "Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones).", +"id": "TimeZone", +"properties": { +"id": { +"description": "IANA Time Zone Database time zone, e.g. \"America/New_York\".", +"type": "string" +}, +"version": { +"description": "Optional. IANA Time Zone Database version number, e.g. \"2019a\".", +"type": "string" +} +}, +"type": "object" +}, +"UnsubscribeAuctionPackageRequest": { +"description": "Request message for UnsubscribeAuctionPackage.", +"id": "UnsubscribeAuctionPackageRequest", +"properties": {}, +"type": "object" +}, +"UnsubscribeClientsRequest": { +"description": "Request message for UnsubscribeAuctionPackage.", +"id": "UnsubscribeClientsRequest", +"properties": { +"clients": { +"description": "Optional. A list of client buyers to unsubscribe from the auction package, with client buyer in the format `buyers/{accountId}/clients/{clientAccountId}`.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"UpdateDealRequest": { +"description": "Request message for updating the deal at the given revision number.", +"id": "UpdateDealRequest", +"properties": { +"deal": { +"$ref": "Deal", +"description": "Required. The deal to update. The deal's `name` field is used to identify the deal to be updated. Note: proposal_revision will have to be provided within the resource or else an error will be thrown. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}" +}, +"updateMask": { +"description": "List of fields to be updated. If empty or unspecified, the service will update all fields populated in the update request excluding the output only fields and primitive fields with default value. Note that explicit field mask is required in order to reset a primitive field back to its default value, for example, false for boolean fields, 0 for integer fields. A special field mask consisting of a single path \"*\" can be used to indicate full replacement(the equivalent of PUT method), updatable fields unset or unspecified in the input will be cleared or set to default value. Output only fields will be ignored regardless of the value of updateMask.", +"format": "google-fieldmask", +"type": "string" +} +}, +"type": "object" +}, +"UriTargeting": { +"description": "Represents a list of targeted and excluded URLs (for example, google.com). For Private Auction Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply.", +"id": "UriTargeting", +"properties": { +"excludedUris": { +"description": "A list of URLs to be excluded.", +"items": { +"type": "string" +}, +"type": "array" +}, +"targetedUris": { +"description": "A list of URLs to be included.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"VideoTargeting": { +"description": "Represents targeting information about video.", +"id": "VideoTargeting", +"properties": { +"excludedPositionTypes": { +"description": "A list of video positions to be excluded. When this field is populated, the targeted_position_types field must be empty.", +"items": { +"enum": [ +"POSITION_TYPE_UNSPECIFIED", +"PREROLL", +"MIDROLL", +"POSTROLL" +], +"enumDescriptions": [ +"A placeholder for an undefined video position.", +"Ad is played before the video.", +"Ad is played during the video.", +"Ad is played after the video." +], +"type": "string" +}, +"type": "array" +}, +"targetedPositionTypes": { +"description": "A list of video positions to be included. When this field is populated, the excluded_position_types field must be empty.", +"items": { +"enum": [ +"POSITION_TYPE_UNSPECIFIED", +"PREROLL", +"MIDROLL", +"POSTROLL" +], +"enumDescriptions": [ +"A placeholder for an undefined video position.", +"Ad is played before the video.", +"Ad is played during the video.", +"Ad is played after the video." +], +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +} +}, +"servicePath": "", +"title": "Authorized Buyers Marketplace API", +"version": "v1alpha", +"version_module": true +} \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/backupdr.v1.json b/googleapiclient/discovery_cache/documents/backupdr.v1.json index 45821ea16fd..33855b01456 100644 --- a/googleapiclient/discovery_cache/documents/backupdr.v1.json +++ b/googleapiclient/discovery_cache/documents/backupdr.v1.json @@ -398,6 +398,11 @@ "name" ], "parameters": { +"force": { +"description": "Optional. If set to true, will not check plan duration against backup vault enforcement duration. Non-standard field.", +"location": "query", +"type": "boolean" +}, "name": { "description": "Output only. The resource name.", "location": "path", @@ -1256,7 +1261,7 @@ } } }, -"revision": "20240626", +"revision": "20240711", "rootUrl": "https://backupdr.googleapis.com/", "schemas": { "AbandonBackupRequest": { @@ -1418,6 +1423,11 @@ ], "type": "string" }, +"diskTypeUri": { +"description": "Optional. Output only. The URI of the disk type resource. For example: projects/project/zones/zone/diskTypes/pd-standard or pd-ssd", +"readOnly": true, +"type": "string" +}, "guestOsFeature": { "description": "Optional. A list of features to enable on the guest operating system. Applicable only for bootable images.", "items": { @@ -2022,8 +2032,8 @@ }, "type": "array" }, -"sourceInstanceName": { -"description": "Name of the source instance at the time of backup. The name is 1-63 characters long, and complies with RFC1035.", +"sourceInstance": { +"description": "The source instance used to create this backup. This can be a partial or full URL to the resource. For example, the following are valid values: -https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance -projects/project/zones/zone/instances/instance", "type": "string" }, "tags": { diff --git a/googleapiclient/discovery_cache/documents/certificatemanager.v1.json b/googleapiclient/discovery_cache/documents/certificatemanager.v1.json index e397153f393..49e4154b5e2 100644 --- a/googleapiclient/discovery_cache/documents/certificatemanager.v1.json +++ b/googleapiclient/discovery_cache/documents/certificatemanager.v1.json @@ -1280,7 +1280,7 @@ } } }, -"revision": "20240626", +"revision": "20240710", "rootUrl": "https://certificatemanager.googleapis.com/", "schemas": { "AllowlistedCertificate": { @@ -1658,7 +1658,7 @@ "type": "string" }, "type": { -"description": "Immutable. Type of DnsAuthorization. If unset during resource creation the following default will be used: - in location global: FIXED_RECORD.", +"description": "Immutable. Type of DnsAuthorization. If unset during resource creation the following default will be used: - in location `global`: FIXED_RECORD, - in other locations: PER_PROJECT_RECORD.", "enum": [ "TYPE_UNSPECIFIED", "FIXED_RECORD", diff --git a/googleapiclient/discovery_cache/documents/classroom.v1.json b/googleapiclient/discovery_cache/documents/classroom.v1.json index e8fdd4b8fad..1a68e8e8396 100644 --- a/googleapiclient/discovery_cache/documents/classroom.v1.json +++ b/googleapiclient/discovery_cache/documents/classroom.v1.json @@ -564,7 +564,7 @@ "type": "string" }, "attachmentId": { -"description": "Optional. The identifier of the attachment. This field is required for student users and optional for teacher users. If not provided in the student case, an error is returned.", +"description": "Optional. The identifier of the attachment. This field is required for all requests except when the user is in the [Attachment Discovery iframe](https://developers.google.com/classroom/add-ons/get-started/iframes/attachment-discovery-iframe).", "location": "query", "type": "string" }, @@ -1061,7 +1061,7 @@ "type": "string" }, "attachmentId": { -"description": "Optional. The identifier of the attachment. This field is required for student users and optional for teacher users. If not provided in the student case, an error is returned.", +"description": "Optional. The identifier of the attachment. This field is required for all requests except when the user is in the [Attachment Discovery iframe](https://developers.google.com/classroom/add-ons/get-started/iframes/attachment-discovery-iframe).", "location": "query", "type": "string" }, @@ -2021,7 +2021,7 @@ "type": "string" }, "attachmentId": { -"description": "Optional. The identifier of the attachment. This field is required for student users and optional for teacher users. If not provided in the student case, an error is returned.", +"description": "Optional. The identifier of the attachment. This field is required for all requests except when the user is in the [Attachment Discovery iframe](https://developers.google.com/classroom/add-ons/get-started/iframes/attachment-discovery-iframe).", "location": "query", "type": "string" }, @@ -2402,7 +2402,7 @@ "type": "string" }, "attachmentId": { -"description": "Optional. The identifier of the attachment. This field is required for student users and optional for teacher users. If not provided in the student case, an error is returned.", +"description": "Optional. The identifier of the attachment. This field is required for all requests except when the user is in the [Attachment Discovery iframe](https://developers.google.com/classroom/add-ons/get-started/iframes/attachment-discovery-iframe).", "location": "query", "type": "string" }, @@ -3695,7 +3695,7 @@ } } }, -"revision": "20240701", +"revision": "20240713", "rootUrl": "https://classroom.googleapis.com/", "schemas": { "AddOnAttachment": { diff --git a/googleapiclient/discovery_cache/documents/cloudasset.v1.json b/googleapiclient/discovery_cache/documents/cloudasset.v1.json index c7ce5e4c567..75025b54193 100644 --- a/googleapiclient/discovery_cache/documents/cloudasset.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudasset.v1.json @@ -1095,7 +1095,7 @@ } } }, -"revision": "20240629", +"revision": "20240717", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "AccessSelector": { @@ -2836,7 +2836,7 @@ "type": "string" }, "sources": { -"description": "Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out.", +"description": "Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`.", "items": { "$ref": "GoogleIdentityAccesscontextmanagerV1EgressSource" }, @@ -2865,7 +2865,7 @@ "id": "GoogleIdentityAccesscontextmanagerV1EgressSource", "properties": { "accessLevel": { -"description": "An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out.", +"description": "An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed.", "type": "string" } }, @@ -3152,7 +3152,7 @@ "properties": { "vpcSubnetwork": { "$ref": "GoogleIdentityAccesscontextmanagerV1VpcSubNetwork", -"description": "Sub-segment ranges of a VPC network. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out." +"description": "Sub-segment ranges of a VPC network." } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/cloudasset.v1beta1.json b/googleapiclient/discovery_cache/documents/cloudasset.v1beta1.json index 94b32728da7..d52821e86ff 100644 --- a/googleapiclient/discovery_cache/documents/cloudasset.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudasset.v1beta1.json @@ -411,7 +411,7 @@ } } }, -"revision": "20240629", +"revision": "20240717", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "AnalyzeIamPolicyLongrunningMetadata": { @@ -1161,7 +1161,7 @@ "type": "string" }, "sources": { -"description": "Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out.", +"description": "Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`.", "items": { "$ref": "GoogleIdentityAccesscontextmanagerV1EgressSource" }, @@ -1190,7 +1190,7 @@ "id": "GoogleIdentityAccesscontextmanagerV1EgressSource", "properties": { "accessLevel": { -"description": "An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out.", +"description": "An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed.", "type": "string" } }, @@ -1477,7 +1477,7 @@ "properties": { "vpcSubnetwork": { "$ref": "GoogleIdentityAccesscontextmanagerV1VpcSubNetwork", -"description": "Sub-segment ranges of a VPC network. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out." +"description": "Sub-segment ranges of a VPC network." } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/cloudasset.v1p1beta1.json b/googleapiclient/discovery_cache/documents/cloudasset.v1p1beta1.json index 7f5415feaf7..f9b4acc88d0 100644 --- a/googleapiclient/discovery_cache/documents/cloudasset.v1p1beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudasset.v1p1beta1.json @@ -207,7 +207,7 @@ } } }, -"revision": "20240629", +"revision": "20240717", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "AnalyzeIamPolicyLongrunningMetadata": { @@ -863,7 +863,7 @@ "type": "string" }, "sources": { -"description": "Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out.", +"description": "Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`.", "items": { "$ref": "GoogleIdentityAccesscontextmanagerV1EgressSource" }, @@ -892,7 +892,7 @@ "id": "GoogleIdentityAccesscontextmanagerV1EgressSource", "properties": { "accessLevel": { -"description": "An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out.", +"description": "An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed.", "type": "string" } }, @@ -1179,7 +1179,7 @@ "properties": { "vpcSubnetwork": { "$ref": "GoogleIdentityAccesscontextmanagerV1VpcSubNetwork", -"description": "Sub-segment ranges of a VPC network. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out." +"description": "Sub-segment ranges of a VPC network." } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/cloudasset.v1p5beta1.json b/googleapiclient/discovery_cache/documents/cloudasset.v1p5beta1.json index 9a6c03f94b8..4fadb3de712 100644 --- a/googleapiclient/discovery_cache/documents/cloudasset.v1p5beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudasset.v1p5beta1.json @@ -177,7 +177,7 @@ } } }, -"revision": "20240629", +"revision": "20240717", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "AnalyzeIamPolicyLongrunningMetadata": { @@ -868,7 +868,7 @@ "type": "string" }, "sources": { -"description": "Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out.", +"description": "Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`.", "items": { "$ref": "GoogleIdentityAccesscontextmanagerV1EgressSource" }, @@ -897,7 +897,7 @@ "id": "GoogleIdentityAccesscontextmanagerV1EgressSource", "properties": { "accessLevel": { -"description": "An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out.", +"description": "An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed.", "type": "string" } }, @@ -1184,7 +1184,7 @@ "properties": { "vpcSubnetwork": { "$ref": "GoogleIdentityAccesscontextmanagerV1VpcSubNetwork", -"description": "Sub-segment ranges of a VPC network. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out." +"description": "Sub-segment ranges of a VPC network." } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/cloudasset.v1p7beta1.json b/googleapiclient/discovery_cache/documents/cloudasset.v1p7beta1.json index e96628409df..f72df1ee70c 100644 --- a/googleapiclient/discovery_cache/documents/cloudasset.v1p7beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudasset.v1p7beta1.json @@ -167,7 +167,7 @@ } } }, -"revision": "20240629", +"revision": "20240717", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "AnalyzeIamPolicyLongrunningMetadata": { @@ -937,7 +937,7 @@ "type": "string" }, "sources": { -"description": "Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out.", +"description": "Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`.", "items": { "$ref": "GoogleIdentityAccesscontextmanagerV1EgressSource" }, @@ -966,7 +966,7 @@ "id": "GoogleIdentityAccesscontextmanagerV1EgressSource", "properties": { "accessLevel": { -"description": "An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out.", +"description": "An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed.", "type": "string" } }, @@ -1253,7 +1253,7 @@ "properties": { "vpcSubnetwork": { "$ref": "GoogleIdentityAccesscontextmanagerV1VpcSubNetwork", -"description": "Sub-segment ranges of a VPC network. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out." +"description": "Sub-segment ranges of a VPC network." } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/cloudcontrolspartner.v1.json b/googleapiclient/discovery_cache/documents/cloudcontrolspartner.v1.json index b97f33623b8..1e7cc8d260c 100644 --- a/googleapiclient/discovery_cache/documents/cloudcontrolspartner.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudcontrolspartner.v1.json @@ -484,7 +484,7 @@ } } }, -"revision": "20240626", +"revision": "20240717", "rootUrl": "https://cloudcontrolspartner.googleapis.com/", "schemas": { "AccessApprovalRequest": { @@ -594,14 +594,17 @@ "properties": { "customerOnboardingState": { "$ref": "CustomerOnboardingState", -"description": "Container for customer onboarding steps" +"description": "Output only. Container for customer onboarding steps", +"readOnly": true }, "displayName": { -"description": "The customer organization's display name. E.g. \"google.com\".", +"description": "Output only. The customer organization's display name. E.g. \"google.com\".", +"readOnly": true, "type": "string" }, "isOnboarded": { -"description": "Indicates whether a customer is fully onboarded", +"description": "Output only. Indicates whether a customer is fully onboarded", +"readOnly": true, "type": "boolean" }, "name": { diff --git a/googleapiclient/discovery_cache/documents/cloudcontrolspartner.v1beta.json b/googleapiclient/discovery_cache/documents/cloudcontrolspartner.v1beta.json index 083e2781044..e528c59d16f 100644 --- a/googleapiclient/discovery_cache/documents/cloudcontrolspartner.v1beta.json +++ b/googleapiclient/discovery_cache/documents/cloudcontrolspartner.v1beta.json @@ -484,7 +484,7 @@ } } }, -"revision": "20240626", +"revision": "20240717", "rootUrl": "https://cloudcontrolspartner.googleapis.com/", "schemas": { "AccessApprovalRequest": { @@ -594,14 +594,17 @@ "properties": { "customerOnboardingState": { "$ref": "CustomerOnboardingState", -"description": "Container for customer onboarding steps" +"description": "Output only. Container for customer onboarding steps", +"readOnly": true }, "displayName": { -"description": "The customer organization's display name. E.g. \"google.com\".", +"description": "Output only. The customer organization's display name. E.g. \"google.com\".", +"readOnly": true, "type": "string" }, "isOnboarded": { -"description": "Indicates whether a customer is fully onboarded", +"description": "Output only. Indicates whether a customer is fully onboarded", +"readOnly": true, "type": "boolean" }, "name": { diff --git a/googleapiclient/discovery_cache/documents/cloudfunctions.v1.json b/googleapiclient/discovery_cache/documents/cloudfunctions.v1.json index 92464a677bf..12aadba8b33 100644 --- a/googleapiclient/discovery_cache/documents/cloudfunctions.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudfunctions.v1.json @@ -552,7 +552,7 @@ } } }, -"revision": "20240627", +"revision": "20240711", "rootUrl": "https://cloudfunctions.googleapis.com/", "schemas": { "AuditConfig": { @@ -1942,7 +1942,7 @@ "type": "string" }, "url": { -"description": "The URL pointing to the hosted repository where the function is defined. There are supported Cloud Source Repository URLs in the following formats: To refer to a specific commit: `https://source.developers.google.com/projects/*/repos/*/revisions/*/paths/*` To refer to a moveable alias (branch): `https://source.developers.google.com/projects/*/repos/*/moveable-aliases/*/paths/*` In particular, to refer to HEAD use `master` moveable alias. To refer to a specific fixed alias (tag): `https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*` You may omit `paths/*` if you want to use the main directory.", +"description": "The URL pointing to the hosted repository where the function is defined. There are supported Cloud Source Repository URLs in the following formats: To refer to a specific commit: `https://source.developers.google.com/projects/*/repos/*/revisions/*/paths/*` To refer to a moveable alias (branch): `https://source.developers.google.com/projects/*/repos/*/moveable-aliases/*/paths/*` In particular, to refer to HEAD use `master` moveable alias. To refer to a specific fixed alias (tag): `https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*` You may omit `paths/*` if you want to use the main directory. The function response may add an empty `/paths/` to the URL.", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/cloudtrace.v2beta1.json b/googleapiclient/discovery_cache/documents/cloudtrace.v2beta1.json index fa73648ce0d..375ec179296 100644 --- a/googleapiclient/discovery_cache/documents/cloudtrace.v2beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudtrace.v2beta1.json @@ -273,7 +273,7 @@ } } }, -"revision": "20240621", +"revision": "20240712", "rootUrl": "https://cloudtrace.googleapis.com/", "schemas": { "Empty": { @@ -305,7 +305,7 @@ "id": "OutputConfig", "properties": { "destination": { -"description": "The destination for writing trace data. Supported formats include: \"bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]\"", +"description": "Required. The destination for writing trace data. Supported formats include: \"bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]\"", "type": "string" } }, @@ -316,7 +316,7 @@ "id": "TraceSink", "properties": { "name": { -"description": "Required. The canonical sink resource name, unique within the project. Must be of the form: projects/[PROJECT_NUMBER]/traceSinks/[SINK_ID]. E.g.: `\"projects/12345/traceSinks/my-project-trace-sink\"`. Sink identifiers are limited to 256 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods.", +"description": "Identifier. The canonical sink resource name, unique within the project. Must be of the form: projects/[PROJECT_NUMBER]/traceSinks/[SINK_ID]. E.g.: `\"projects/12345/traceSinks/my-project-trace-sink\"`. Sink identifiers are limited to 256 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods.", "type": "string" }, "outputConfig": { diff --git a/googleapiclient/discovery_cache/documents/composer.v1.json b/googleapiclient/discovery_cache/documents/composer.v1.json index 3785758992b..950c3465b3b 100644 --- a/googleapiclient/discovery_cache/documents/composer.v1.json +++ b/googleapiclient/discovery_cache/documents/composer.v1.json @@ -966,7 +966,7 @@ } } }, -"revision": "20240703", +"revision": "20240716", "rootUrl": "https://composer.googleapis.com/", "schemas": { "AirflowMetadataRetentionPolicyConfig": { @@ -1304,6 +1304,11 @@ "description": "The resource name of the environment, in the form: \"projects/{projectId}/locations/{locationId}/environments/{environmentId}\" EnvironmentId must start with a lowercase letter followed by up to 63 lowercase letters, numbers, or hyphens, and cannot end with a hyphen.", "type": "string" }, +"satisfiesPzi": { +"description": "Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" +}, "satisfiesPzs": { "description": "Output only. Reserved for future use.", "readOnly": true, diff --git a/googleapiclient/discovery_cache/documents/composer.v1beta1.json b/googleapiclient/discovery_cache/documents/composer.v1beta1.json index c8099d587d7..65b4fdfb791 100644 --- a/googleapiclient/discovery_cache/documents/composer.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/composer.v1beta1.json @@ -994,7 +994,7 @@ } } }, -"revision": "20240703", +"revision": "20240716", "rootUrl": "https://composer.googleapis.com/", "schemas": { "AirflowMetadataRetentionPolicyConfig": { @@ -1339,6 +1339,11 @@ "description": "The resource name of the environment, in the form: \"projects/{projectId}/locations/{locationId}/environments/{environmentId}\" EnvironmentId must start with a lowercase letter followed by up to 63 lowercase letters, numbers, or hyphens, and cannot end with a hyphen.", "type": "string" }, +"satisfiesPzi": { +"description": "Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" +}, "satisfiesPzs": { "description": "Output only. Reserved for future use.", "readOnly": true, diff --git a/googleapiclient/discovery_cache/documents/compute.alpha.json b/googleapiclient/discovery_cache/documents/compute.alpha.json index 0ce64289e33..2c7211ea865 100644 --- a/googleapiclient/discovery_cache/documents/compute.alpha.json +++ b/googleapiclient/discovery_cache/documents/compute.alpha.json @@ -14084,6 +14084,210 @@ } } }, +"instantSnapshotGroups": { +"methods": { +"delete": { +"description": "deletes a Zonal InstantSnapshotGroup resource", +"flatPath": "projects/{project}/zones/{zone}/instantSnapshotGroups/{instantSnapshotGroup}", +"httpMethod": "DELETE", +"id": "compute.instantSnapshotGroups.delete", +"parameterOrder": [ +"project", +"zone", +"instantSnapshotGroup" +], +"parameters": { +"instantSnapshotGroup": { +"description": "Name of the InstantSnapshot resource to delete.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional 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. 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).", +"location": "query", +"type": "string" +}, +"zone": { +"description": "The name of the zone for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/zones/{zone}/instantSnapshotGroups/{instantSnapshotGroup}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"get": { +"description": "returns the specified InstantSnapshotGroup resource in the specified zone.", +"flatPath": "projects/{project}/zones/{zone}/instantSnapshotGroups/{instantSnapshotGroup}", +"httpMethod": "GET", +"id": "compute.instantSnapshotGroups.get", +"parameterOrder": [ +"project", +"zone", +"instantSnapshotGroup" +], +"parameters": { +"instantSnapshotGroup": { +"description": "Name of the instantSnapshotGroup resource to return.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"zone": { +"description": "The name of the zone for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/zones/{zone}/instantSnapshotGroups/{instantSnapshotGroup}", +"response": { +"$ref": "InstantSnapshotGroup" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"insert": { +"description": "inserts a Zonal InstantSnapshotGroup resource", +"flatPath": "projects/{project}/zones/{zone}/instantSnapshotGroups", +"httpMethod": "POST", +"id": "compute.instantSnapshotGroups.insert", +"parameterOrder": [ +"project", +"zone" +], +"parameters": { +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional 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. 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).", +"location": "query", +"type": "string" +}, +"sourceConsistencyGroup": { +"description": "begin_interface: MixerMutationRequestBuilder", +"location": "query", +"type": "string" +}, +"zone": { +"description": "Name of the zone for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/zones/{zone}/instantSnapshotGroups", +"request": { +"$ref": "InstantSnapshotGroup" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"list": { +"description": "retrieves the list of InstantSnapshotGroup resources contained within the specified zone.", +"flatPath": "projects/{project}/zones/{zone}/instantSnapshotGroups", +"httpMethod": "GET", +"id": "compute.instantSnapshotGroups.list", +"parameterOrder": [ +"project", +"zone" +], +"parameters": { +"filter": { +"description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", +"location": "query", +"type": "string" +}, +"maxResults": { +"default": "500", +"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", +"format": "uint32", +"location": "query", +"minimum": "0", +"type": "integer" +}, +"orderBy": { +"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", +"location": "query", +"type": "string" +}, +"pageToken": { +"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", +"location": "query", +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"returnPartialSuccess": { +"description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", +"location": "query", +"type": "boolean" +}, +"zone": { +"description": "The name of the zone for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/zones/{zone}/instantSnapshotGroups", +"response": { +"$ref": "ListInstantSnapshotGroups" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +} +} +}, "instantSnapshots": { "methods": { "aggregatedList": { @@ -26304,6 +26508,106 @@ } } }, +"regionInstanceGroupManagerResizeRequests": { +"methods": { +"get": { +"description": "Returns all of the details about the specified resize request.", +"flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}", +"httpMethod": "GET", +"id": "compute.regionInstanceGroupManagerResizeRequests.get", +"parameterOrder": [ +"project", +"region", +"instanceGroupManager", +"resizeRequest" +], +"parameters": { +"instanceGroupManager": { +"description": "The name of the managed instance group. Name should conform to RFC1035 or be a resource ID.", +"location": "path", +"required": true, +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "The name of the region scoping this request. Name should conform to RFC1035.", +"location": "path", +"required": true, +"type": "string" +}, +"resizeRequest": { +"description": "The name of the resize request. Name should conform to RFC1035 or be a resource ID.", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}", +"response": { +"$ref": "InstanceGroupManagerResizeRequest" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"insert": { +"description": "Creates a new Resize Request that starts provisioning VMs immediately or queues VM creation.", +"flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests", +"httpMethod": "POST", +"id": "compute.regionInstanceGroupManagerResizeRequests.insert", +"parameterOrder": [ +"project", +"region", +"instanceGroupManager" +], +"parameters": { +"instanceGroupManager": { +"description": "Name of the managed instance group to which the resize request is scoped. Name should conform to RFC1035 or be a resource ID.", +"location": "path", +"required": true, +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "Name of the region scoping this request. Name should conform to RFC1035.", +"location": "path", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional 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. 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).", +"location": "query", +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests", +"request": { +"$ref": "InstanceGroupManagerResizeRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +} +} +}, "regionInstanceGroupManagers": { "methods": { "abandonInstances": { @@ -28207,6 +28511,210 @@ } } }, +"regionInstantSnapshotGroups": { +"methods": { +"delete": { +"description": "deletes a Regional InstantSnapshotGroup resource", +"flatPath": "projects/{project}/regions/{region}/instantSnapshotGroups/{instantSnapshotGroup}", +"httpMethod": "DELETE", +"id": "compute.regionInstantSnapshotGroups.delete", +"parameterOrder": [ +"project", +"region", +"instantSnapshotGroup" +], +"parameters": { +"instantSnapshotGroup": { +"description": "Name of the InstantSnapshotGroup resource to delete.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "The name of the region for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional 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. 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).", +"location": "query", +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/instantSnapshotGroups/{instantSnapshotGroup}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"get": { +"description": "returns the specified InstantSnapshotGroup resource in the specified region.", +"flatPath": "projects/{project}/regions/{region}/instantSnapshotGroups/{instantSnapshot}", +"httpMethod": "GET", +"id": "compute.regionInstantSnapshotGroups.get", +"parameterOrder": [ +"project", +"region", +"instantSnapshot" +], +"parameters": { +"instantSnapshot": { +"description": "Name of the InstantSnapshotGroup resource to return.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "The name of the region for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/instantSnapshotGroups/{instantSnapshot}", +"response": { +"$ref": "InstantSnapshotGroup" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"insert": { +"description": "creates a Regional InstantSnapshotGroup resource", +"flatPath": "projects/{project}/regions/{region}/instantSnapshotGroups", +"httpMethod": "POST", +"id": "compute.regionInstantSnapshotGroups.insert", +"parameterOrder": [ +"project", +"region" +], +"parameters": { +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "Name of the region for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional 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. 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).", +"location": "query", +"type": "string" +}, +"sourceConsistencyGroup": { +"description": "begin_interface: MixerMutationRequestBuilder", +"location": "query", +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/instantSnapshotGroups", +"request": { +"$ref": "InstantSnapshotGroup" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"list": { +"description": "retrieves the list of InstantSnapshotGroup resources contained within the specified region.", +"flatPath": "projects/{project}/regions/{region}/instantSnapshotGroups", +"httpMethod": "GET", +"id": "compute.regionInstantSnapshotGroups.list", +"parameterOrder": [ +"project", +"region" +], +"parameters": { +"filter": { +"description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", +"location": "query", +"type": "string" +}, +"maxResults": { +"default": "500", +"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", +"format": "uint32", +"location": "query", +"minimum": "0", +"type": "integer" +}, +"orderBy": { +"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", +"location": "query", +"type": "string" +}, +"pageToken": { +"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", +"location": "query", +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "The name of the region for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, +"returnPartialSuccess": { +"description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", +"location": "query", +"type": "boolean" +} +}, +"path": "projects/{project}/regions/{region}/instantSnapshotGroups", +"response": { +"$ref": "ListInstantSnapshotGroups" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +} +} +}, "regionInstantSnapshots": { "methods": { "delete": { @@ -44715,7 +45223,7 @@ } } }, -"revision": "20240702", +"revision": "20240707", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -59757,6 +60265,10 @@ false "description": "[Output Only] The URL of the region where the managed instance group resides (for regional resources).", "type": "string" }, +"resourcePolicies": { +"$ref": "InstanceGroupManagerResourcePolicies", +"description": "Resource policies for this managed instance group." +}, "satisfiesPzi": { "description": "[Output Only] Reserved for future use.", "type": "boolean" @@ -60799,6 +61311,16 @@ false }, "type": "object" }, +"InstanceGroupManagerResourcePolicies": { +"id": "InstanceGroupManagerResourcePolicies", +"properties": { +"workloadPolicy": { +"description": "The URL of the workload policy that is specified for this managed instance group. It can be a full or partial URL. For example, the following are all valid URLs to a workload policy: - https://www.googleapis.com/compute/v1/projects/project/regions/region /resourcePolicies/resourcePolicy - projects/project/regions/region/resourcePolicies/resourcePolicy - regions/region/resourcePolicies/resourcePolicy ", +"type": "string" +} +}, +"type": "object" +}, "InstanceGroupManagerStandbyPolicy": { "id": "InstanceGroupManagerStandbyPolicy", "properties": { @@ -63847,6 +64369,101 @@ false }, "type": "object" }, +"InstantSnapshotGroup": { +"id": "InstantSnapshotGroup", +"properties": { +"creationTimestamp": { +"description": "[Output Only] Creation timestamp in RFC3339 text format.", +"type": "string" +}, +"description": { +"description": "Optional. An optional description of this resource. Provide this property when you create the resource.", +"type": "string" +}, +"id": { +"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", +"format": "uint64", +"type": "string" +}, +"kind": { +"default": "compute#instantSnapshotGroup", +"description": "[Output Only] Type of the resource. Always compute#instantSnapshotGroup for InstantSnapshotGroup resources.", +"type": "string" +}, +"name": { +"description": "Identifier. Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"type": "string" +}, +"region": { +"description": "[Output Only] URL of the region where the instant snapshot group resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.", +"type": "string" +}, +"resourceStatus": { +"$ref": "InstantSnapshotGroupResourceStatus" +}, +"selfLink": { +"description": "[Output Only] Server-defined URL for the resource.", +"type": "string" +}, +"selfLinkWithId": { +"description": "[Output Only] Server-defined URL for this resource's resource id.", +"type": "string" +}, +"status": { +"description": "[Output Only]", +"enum": [ +"CREATING", +"DELETING", +"FAILED", +"INVALID", +"READY", +"UNKNOWN" +], +"enumDescriptions": [ +"", +"", +"", +"", +"", +"" +], +"type": "string" +}, +"zone": { +"description": "[Output Only] URL of the zone where the instant snapshot group resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.", +"type": "string" +} +}, +"type": "object" +}, +"InstantSnapshotGroupResourceStatus": { +"id": "InstantSnapshotGroupResourceStatus", +"properties": { +"consistencyMembershipResolutionTime": { +"description": "[Output Only]", +"format": "google-datetime", +"type": "string" +}, +"sourceInfo": { +"$ref": "InstantSnapshotGroupSourceInfo", +"description": "[Output Only]" +} +}, +"type": "object" +}, +"InstantSnapshotGroupSourceInfo": { +"id": "InstantSnapshotGroupSourceInfo", +"properties": { +"consistencyGroup": { +"type": "string" +}, +"consistencyGroupId": { +"type": "string" +} +}, +"type": "object" +}, "InstantSnapshotList": { "description": "Contains a list of InstantSnapshot resources.", "id": "InstantSnapshotList", @@ -64382,6 +64999,9 @@ false "bandwidthPercentagePolicy": { "$ref": "InterconnectApplicationAwareInterconnectBandwidthPercentagePolicy" }, +"egressMinBandwidthPercentagePolicy": { +"$ref": "InterconnectApplicationAwareInterconnectBandwidthPercentagePolicy" +}, "profileDescription": { "description": "A description for the AAI profile on this interconnect.", "type": "string" @@ -67176,6 +67796,168 @@ false }, "type": "object" }, +"ListInstantSnapshotGroups": { +"description": "Contains a list of InstantSnapshotGroup resources.", +"id": "ListInstantSnapshotGroups", +"properties": { +"etag": { +"type": "string" +}, +"id": { +"description": "[Output Only] Unique identifier for the resource; defined by the server.", +"type": "string" +}, +"items": { +"description": "A list of InstantSnapshotGroup resources.", +"items": { +"$ref": "InstantSnapshotGroup" +}, +"type": "array" +}, +"kind": { +"default": "compute#instantSnapshotGroupsList", +"description": "Type of resource.", +"type": "string" +}, +"nextPageToken": { +"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", +"type": "string" +}, +"selfLink": { +"description": "[Output Only] Server-defined URL for this resource.", +"type": "string" +}, +"unreachables": { +"description": "[Output Only] Unreachable resources. end_interface: MixerListResponseWithEtagBuilder", +"items": { +"type": "string" +}, +"type": "array" +}, +"warning": { +"description": "[Output Only] Informational warning message.", +"properties": { +"code": { +"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", +"enum": [ +"CLEANUP_FAILED", +"DEPRECATED_RESOURCE_USED", +"DEPRECATED_TYPE_USED", +"DISK_SIZE_LARGER_THAN_IMAGE_SIZE", +"EXPERIMENTAL_TYPE_USED", +"EXTERNAL_API_WARNING", +"FIELD_VALUE_OVERRIDEN", +"INJECTED_KERNELS_DEPRECATED", +"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", +"LARGE_DEPLOYMENT_WARNING", +"LIST_OVERHEAD_QUOTA_EXCEED", +"MISSING_TYPE_DEPENDENCY", +"NEXT_HOP_ADDRESS_NOT_ASSIGNED", +"NEXT_HOP_CANNOT_IP_FORWARD", +"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", +"NEXT_HOP_INSTANCE_NOT_FOUND", +"NEXT_HOP_INSTANCE_NOT_ON_NETWORK", +"NEXT_HOP_NOT_RUNNING", +"NOT_CRITICAL_ERROR", +"NO_RESULTS_ON_PAGE", +"PARTIAL_SUCCESS", +"REQUIRED_TOS_AGREEMENT", +"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", +"RESOURCE_NOT_DELETED", +"SCHEMA_VALIDATION_IGNORED", +"SINGLE_INSTANCE_PROPERTY_TEMPLATE", +"UNDECLARED_PROPERTIES", +"UNREACHABLE" +], +"enumDeprecated": [ +false, +false, +false, +false, +false, +false, +true, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false +], +"enumDescriptions": [ +"Warning about failed cleanup of transient changes made by a failed operation.", +"A link to a deprecated resource was created.", +"When deploying and at least one of the resources has a type marked as deprecated", +"The user created a boot disk that is larger than image size.", +"When deploying and at least one of the resources has a type marked as experimental", +"Warning that is present in an external api call", +"Warning that value of a field has been overridden. Deprecated unused field.", +"The operation involved use of an injected kernel, which is deprecated.", +"A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", +"When deploying a deployment with a exceedingly large number of resources", +"Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", +"A resource depends on a missing type", +"The route's nextHopIp address is not assigned to an instance on the network.", +"The route's next hop instance cannot ip forward.", +"The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", +"The route's nextHopInstance URL refers to an instance that does not exist.", +"The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", +"The route's next hop instance does not have a status of RUNNING.", +"Error which is not critical. We decided to continue the process despite the mentioned error.", +"No results are present on a particular list page.", +"Success is reported, but some results may be missing due to errors", +"The user attempted to use a resource that requires a TOS they have not accepted.", +"Warning that a resource is in use.", +"One or more of the resources set to auto-delete could not be deleted because they were in use.", +"When a resource schema validation is ignored.", +"Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", +"When undeclared properties in the schema are present", +"A given scope cannot be reached." +], +"type": "string" +}, +"data": { +"description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", +"items": { +"properties": { +"key": { +"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", +"type": "string" +}, +"value": { +"description": "[Output Only] A warning data value corresponding to the key.", +"type": "string" +} +}, +"type": "object" +}, +"type": "array" +}, +"message": { +"description": "[Output Only] A human-readable description of the warning code.", +"type": "string" +} +}, +"type": "object" +} +}, +"type": "object" +}, "LocalDisk": { "id": "LocalDisk", "properties": { @@ -68694,6 +69476,9 @@ false "selfLinkWithId": { "description": "[Output Only] Server-defined URL for this resource with the resource id.", "type": "string" +}, +"status": { +"$ref": "MultiMigStatus" } }, "type": "object" @@ -68746,6 +69531,18 @@ false }, "type": "object" }, +"MultiMigStatus": { +"id": "MultiMigStatus", +"properties": { +"memberInstanceGroupManagers": { +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "MultiMigsList": { "id": "MultiMigsList", "properties": { diff --git a/googleapiclient/discovery_cache/documents/config.v1.json b/googleapiclient/discovery_cache/documents/config.v1.json index 2838e46435a..22bb67a239a 100644 --- a/googleapiclient/discovery_cache/documents/config.v1.json +++ b/googleapiclient/discovery_cache/documents/config.v1.json @@ -1187,7 +1187,7 @@ } } }, -"revision": "20240626", +"revision": "20240710", "rootUrl": "https://config.googleapis.com/", "schemas": { "ApplyResults": { @@ -2545,12 +2545,12 @@ "id": "TerraformBlueprint", "properties": { "gcsSource": { -"description": "Required. URI of an object in Google Cloud Storage. Format: `gs://{bucket}/{object}` URI may also specify an object version for zipped objects. Format: `gs://{bucket}/{object}#{version}`", +"description": "URI of an object in Google Cloud Storage. Format: `gs://{bucket}/{object}` URI may also specify an object version for zipped objects. Format: `gs://{bucket}/{object}#{version}`", "type": "string" }, "gitSource": { "$ref": "GitSource", -"description": "Required. URI of a public Git repo." +"description": "URI of a public Git repo." }, "inputValues": { "additionalProperties": { diff --git a/googleapiclient/discovery_cache/documents/connectors.v1.json b/googleapiclient/discovery_cache/documents/connectors.v1.json index bb83e86d4b9..8965e5ddb8f 100644 --- a/googleapiclient/discovery_cache/documents/connectors.v1.json +++ b/googleapiclient/discovery_cache/documents/connectors.v1.json @@ -2427,7 +2427,7 @@ } } }, -"revision": "20240708", +"revision": "20240715", "rootUrl": "https://connectors.googleapis.com/", "schemas": { "AuditConfig": { @@ -2826,6 +2826,10 @@ "description": "Connection represents an instance of connector.", "id": "Connection", "properties": { +"asyncOperationsEnabled": { +"description": "Optional. Async operations enabled for the connection. If Async Operations is enabled, Connection allows the customers to initiate async long running operations using the actions API.", +"type": "boolean" +}, "authConfig": { "$ref": "AuthConfig", "description": "Optional. Configuration for establishing the connection's authentication with an external system." @@ -3252,6 +3256,10 @@ "format": "int64", "type": "string" }, +"migrateDeploymentModel": { +"description": "Indicate whether connector is being migrated to cloud run deployment model.", +"type": "boolean" +}, "ratelimitThreshold": { "description": "Max QPS supported by the connector version before throttling of requests.", "format": "int64", @@ -3448,6 +3456,23 @@ ], "type": "string" }, +"deploymentModelMigrationState": { +"description": "Output only. Status of the deployment model migration.", +"enum": [ +"DEPLOYMENT_MODEL_MIGRATION_STATE_UNSPECIFIED", +"IN_PROGRESS", +"COMPLETED", +"ROLLEDBACK" +], +"enumDescriptions": [ +"Deployment model migration state is not specified.", +"Deployment model migration is in progress.", +"Deployment model migration is completed.", +"Deployment model migration rolledback." +], +"readOnly": true, +"type": "string" +}, "hpaConfig": { "$ref": "HPAConfig", "description": "Output only. HPA autoscaling config.", diff --git a/googleapiclient/discovery_cache/documents/container.v1.json b/googleapiclient/discovery_cache/documents/container.v1.json index 8323b398c1d..9a247a5d31d 100644 --- a/googleapiclient/discovery_cache/documents/container.v1.json +++ b/googleapiclient/discovery_cache/documents/container.v1.json @@ -2540,7 +2540,7 @@ } } }, -"revision": "20240619", +"revision": "20240708", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -2610,7 +2610,7 @@ "id": "AdditionalPodRangesConfig", "properties": { "podRangeInfo": { -"description": "Output only. [Output only] Information for additional pod range.", +"description": "Output only. Information for additional pod range.", "items": { "$ref": "RangeInfo" }, @@ -2754,11 +2754,13 @@ "id": "AutoUpgradeOptions", "properties": { "autoUpgradeStartTime": { -"description": "[Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", +"description": "Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", +"readOnly": true, "type": "string" }, "description": { -"description": "[Output only] This field is set when upgrades are about to commence with the description of the upgrade.", +"description": "Output only. This field is set when upgrades are about to commence with the description of the upgrade.", +"readOnly": true, "type": "string" } }, @@ -3161,22 +3163,26 @@ "description": "Configuration for the fine-grained cost management feature." }, "createTime": { -"description": "[Output only] The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", +"description": "Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", +"readOnly": true, "type": "string" }, "currentMasterVersion": { -"description": "[Output only] The current software version of the master endpoint.", +"description": "Output only. The current software version of the master endpoint.", +"readOnly": true, "type": "string" }, "currentNodeCount": { "deprecated": true, -"description": "[Output only] The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information.", +"description": "Output only. The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information.", "format": "int32", +"readOnly": true, "type": "integer" }, "currentNodeVersion": { "deprecated": true, -"description": "[Output only] Deprecated, use [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.", +"description": "Output only. Deprecated, use [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.", +"readOnly": true, "type": "string" }, "databaseEncryption": { @@ -3204,7 +3210,8 @@ "type": "boolean" }, "endpoint": { -"description": "[Output only] The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information.", +"description": "Output only. The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information.", +"readOnly": true, "type": "string" }, "enterpriseConfig": { @@ -3216,7 +3223,8 @@ "type": "string" }, "expireTime": { -"description": "[Output only] The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", +"description": "Output only. The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", +"readOnly": true, "type": "string" }, "fleet": { @@ -3244,10 +3252,11 @@ }, "instanceGroupUrls": { "deprecated": true, -"description": "Deprecated. Use node_pools.instance_group_urls.", +"description": "Output only. Deprecated. Use node_pools.instance_group_urls.", "items": { "type": "string" }, +"readOnly": true, "type": "array" }, "ipAllocationPolicy": { @@ -3263,7 +3272,8 @@ "description": "Configuration for the legacy ABAC authorization mode." }, "location": { -"description": "[Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.", +"description": "Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.", +"readOnly": true, "type": "string" }, "locations": { @@ -3327,8 +3337,9 @@ "description": "Parameters used in creating the cluster's nodes. For requests, this field should only be used in lieu of a \"node_pool\" object, since this configuration (along with the \"initial_node_count\") will be used to create a \"NodePool\" object with an auto-generated name. Do not use this and a node_pool at the same time. For responses, this field will be populated with the node configuration of the first node pool. (For configuration of each node pool, see `node_pool.config`) If unspecified, the defaults are used. This field is deprecated, use node_pool.config instead." }, "nodeIpv4CidrSize": { -"description": "[Output only] The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode.", +"description": "Output only. The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode.", "format": "int32", +"readOnly": true, "type": "integer" }, "nodePoolAutoConfig": { @@ -3388,11 +3399,13 @@ "description": "Enable/Disable Security Posture API features for the cluster." }, "selfLink": { -"description": "[Output only] Server-defined URL for the resource.", +"description": "Output only. Server-defined URL for the resource.", +"readOnly": true, "type": "string" }, "servicesIpv4Cidr": { -"description": "[Output only] The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR.", +"description": "Output only. The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR.", +"readOnly": true, "type": "string" }, "shieldedNodes": { @@ -3400,7 +3413,7 @@ "description": "Shielded Nodes configuration." }, "status": { -"description": "[Output only] The current status of this cluster.", +"description": "Output only. The current status of this cluster.", "enum": [ "STATUS_UNSPECIFIED", "PROVISIONING", @@ -3419,11 +3432,13 @@ "The ERROR state indicates the cluster is unusable. It will be automatically deleted. Details can be found in the `statusMessage` field.", "The DEGRADED state indicates the cluster requires user action to restore full functionality. Details can be found in the `statusMessage` field." ], +"readOnly": true, "type": "string" }, "statusMessage": { "deprecated": true, -"description": "[Output only] Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available.", +"description": "Output only. Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available.", +"readOnly": true, "type": "string" }, "subnetwork": { @@ -3431,7 +3446,8 @@ "type": "string" }, "tpuIpv4CidrBlock": { -"description": "[Output only] The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`).", +"description": "Output only. The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`).", +"readOnly": true, "type": "string" }, "verticalPodAutoscaling": { @@ -3444,7 +3460,8 @@ }, "zone": { "deprecated": true, -"description": "[Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead.", +"description": "Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead.", +"readOnly": true, "type": "string" } }, @@ -3984,7 +4001,8 @@ "id": "DailyMaintenanceWindow", "properties": { "duration": { -"description": "[Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format \"PTnHnMnS\".", +"description": "Output only. Duration of the time window, automatically chosen to be smallest possible in the given scenario. Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format \"PTnHnMnS\".", +"readOnly": true, "type": "string" }, "startTime": { @@ -4091,7 +4109,7 @@ "id": "EnterpriseConfig", "properties": { "clusterTier": { -"description": "Output only. [Output only] cluster_tier specifies the premium tier of the cluster.", +"description": "Output only. cluster_tier specifies the premium tier of the cluster.", "enum": [ "CLUSTER_TIER_UNSPECIFIED", "STANDARD", @@ -4162,11 +4180,13 @@ "id": "Fleet", "properties": { "membership": { -"description": "[Output only] The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`.", +"description": "Output only. The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`.", +"readOnly": true, "type": "string" }, "preRegistered": { -"description": "[Output only] Whether the cluster has been registered through the fleet API.", +"description": "Output only. Whether the cluster has been registered through the fleet API.", +"readOnly": true, "type": "boolean" }, "project": { @@ -4468,7 +4488,7 @@ false "properties": { "additionalPodRangesConfig": { "$ref": "AdditionalPodRangesConfig", -"description": "Output only. [Output only] The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy.", +"description": "Output only. The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy.", "readOnly": true }, "clusterIpv4Cidr": { @@ -4489,7 +4509,7 @@ false "type": "boolean" }, "defaultPodIpv4RangeUtilization": { -"description": "Output only. [Output only] The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.", +"description": "Output only. The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.", "format": "double", "readOnly": true, "type": "number" @@ -4531,7 +4551,7 @@ false "type": "string" }, "servicesIpv6CidrBlock": { -"description": "Output only. [Output only] The services IPv6 CIDR block for the cluster.", +"description": "Output only. The services IPv6 CIDR block for the cluster.", "readOnly": true, "type": "string" }, @@ -4554,7 +4574,7 @@ false "type": "string" }, "subnetIpv6CidrBlock": { -"description": "Output only. [Output only] The subnet's IPv6 CIDR block used by nodes and pods.", +"description": "Output only. The subnet's IPv6 CIDR block used by nodes and pods.", "readOnly": true, "type": "string" }, @@ -4932,7 +4952,8 @@ false "id": "MasterAuth", "properties": { "clientCertificate": { -"description": "[Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint.", +"description": "Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint.", +"readOnly": true, "type": "string" }, "clientCertificateConfig": { @@ -4940,11 +4961,13 @@ false "description": "Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued." }, "clientKey": { -"description": "[Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint.", +"description": "Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint.", +"readOnly": true, "type": "string" }, "clusterCaCertificate": { -"description": "[Output only] Base64-encoded public certificate that is the root of trust for the cluster.", +"description": "Output only. Base64-encoded public certificate that is the root of trust for the cluster.", +"readOnly": true, "type": "string" }, "password": { @@ -5161,6 +5184,7 @@ false }, "network": { "description": "Output only. The relative name of the Google Compute Engine network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network", +"readOnly": true, "type": "string" }, "networkPerformanceConfig": { @@ -5189,6 +5213,7 @@ false }, "subnetwork": { "description": "Output only. The relative name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet", +"readOnly": true, "type": "string" } }, @@ -5605,7 +5630,7 @@ false "type": "string" }, "podIpv4RangeUtilization": { -"description": "Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.", +"description": "Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.", "format": "double", "readOnly": true, "type": "number" @@ -5650,10 +5675,11 @@ false "type": "integer" }, "instanceGroupUrls": { -"description": "[Output only] The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.", +"description": "Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.", "items": { "type": "string" }, +"readOnly": true, "type": "array" }, "locations": { @@ -5684,8 +5710,9 @@ false "description": "Specifies the node placement policy." }, "podIpv4CidrSize": { -"description": "[Output only] The pod CIDR block size per node in this node pool.", +"description": "Output only. The pod CIDR block size per node in this node pool.", "format": "int32", +"readOnly": true, "type": "integer" }, "queuedProvisioning": { @@ -5693,11 +5720,12 @@ false "description": "Specifies the configuration of queued provisioning." }, "selfLink": { -"description": "[Output only] Server-defined URL for the resource.", +"description": "Output only. Server-defined URL for the resource.", +"readOnly": true, "type": "string" }, "status": { -"description": "[Output only] The status of the nodes in this pool instance.", +"description": "Output only. The status of the nodes in this pool instance.", "enum": [ "STATUS_UNSPECIFIED", "PROVISIONING", @@ -5716,16 +5744,18 @@ false "The STOPPING state indicates the node pool is being deleted.", "The ERROR state indicates the node pool may be unusable. Details can be found in the `statusMessage` field." ], +"readOnly": true, "type": "string" }, "statusMessage": { "deprecated": true, -"description": "[Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available.", +"description": "Output only. Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available.", +"readOnly": true, "type": "string" }, "updateInfo": { "$ref": "UpdateInfo", -"description": "Output only. [Output only] Update info contains relevant information during a node pool update.", +"description": "Output only. Update info contains relevant information during a node pool update.", "readOnly": true }, "upgradeSettings": { @@ -5898,11 +5928,13 @@ false "type": "array" }, "detail": { -"description": "Detailed operation progress, if available.", +"description": "Output only. Detailed operation progress, if available.", +"readOnly": true, "type": "string" }, "endTime": { -"description": "[Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", +"description": "Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", +"readOnly": true, "type": "string" }, "error": { @@ -5910,11 +5942,13 @@ false "description": "The error result of the operation in case of failure." }, "location": { -"description": "[Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.", +"description": "Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.", +"readOnly": true, "type": "string" }, "name": { -"description": "The server-assigned ID for the operation.", +"description": "Output only. The server-assigned ID for the operation.", +"readOnly": true, "type": "string" }, "nodepoolConditions": { @@ -5926,7 +5960,7 @@ false "type": "array" }, "operationType": { -"description": "The operation type.", +"description": "Output only. The operation type.", "enum": [ "TYPE_UNSPECIFIED", "CREATE_CLUSTER", @@ -5990,23 +6024,26 @@ false "The control plane is being resized. This operation type is initiated by GKE. These operations are often performed preemptively to ensure that the control plane has sufficient resources and is not typically an indication of issues. For more details, see [documentation on resizes](https://cloud.google.com/kubernetes-engine/docs/concepts/maintenance-windows-and-exclusions#repairs).", "Fleet features of GKE Enterprise are being upgraded. The cluster should be assumed to be blocked for other upgrades until the operation finishes." ], +"readOnly": true, "type": "string" }, "progress": { "$ref": "OperationProgress", -"description": "Output only. [Output only] Progress information for an operation.", +"description": "Output only. Progress information for an operation.", "readOnly": true }, "selfLink": { -"description": "Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`.", +"description": "Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`.", +"readOnly": true, "type": "string" }, "startTime": { -"description": "[Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", +"description": "Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", +"readOnly": true, "type": "string" }, "status": { -"description": "The current status of the operation.", +"description": "Output only. The current status of the operation.", "enum": [ "STATUS_UNSPECIFIED", "PENDING", @@ -6021,6 +6058,7 @@ false "The operation is done, either cancelled or completed.", "The operation is aborting." ], +"readOnly": true, "type": "string" }, "statusMessage": { @@ -6030,12 +6068,14 @@ false "type": "string" }, "targetLink": { -"description": "Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`", +"description": "Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`", +"readOnly": true, "type": "string" }, "zone": { "deprecated": true, -"description": "The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.", +"description": "Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.", +"readOnly": true, "type": "string" } }, @@ -6182,10 +6222,12 @@ false }, "peeringName": { "description": "Output only. The peering name in the customer VPC used by this cluster.", +"readOnly": true, "type": "string" }, "privateEndpoint": { "description": "Output only. The internal IP address of this cluster's master endpoint.", +"readOnly": true, "type": "string" }, "privateEndpointSubnetwork": { @@ -6194,6 +6236,7 @@ false }, "publicEndpoint": { "description": "Output only. The external IP address of this cluster's master endpoint.", +"readOnly": true, "type": "string" } }, @@ -6263,12 +6306,12 @@ false "id": "RangeInfo", "properties": { "rangeName": { -"description": "Output only. [Output only] Name of a range.", +"description": "Output only. Name of a range.", "readOnly": true, "type": "string" }, "utilization": { -"description": "Output only. [Output only] The utilization of the range.", +"description": "Output only. The utilization of the range.", "format": "double", "readOnly": true, "type": "number" @@ -6342,13 +6385,15 @@ false "UNSPECIFIED", "RAPID", "REGULAR", -"STABLE" +"STABLE", +"EXTENDED" ], "enumDescriptions": [ "No channel specified.", "RAPID channel is offered on an early access basis for customers who want to test new releases. WARNING: Versions available in the RAPID Channel may be subject to unresolved issues with no known workaround and are not subject to any SLAs.", "Clusters subscribed to REGULAR receive versions that are considered GA quality. REGULAR is intended for production users who want to take advantage of new features.", -"Clusters subscribed to STABLE receive versions that are known to be stable and reliable in production." +"Clusters subscribed to STABLE receive versions that are known to be stable and reliable in production.", +"Clusters subscribed to EXTENDED receive extended support and availability for versions which are known to be stable and reliable in production." ], "type": "string" } @@ -6365,13 +6410,15 @@ false "UNSPECIFIED", "RAPID", "REGULAR", -"STABLE" +"STABLE", +"EXTENDED" ], "enumDescriptions": [ "No channel specified.", "RAPID channel is offered on an early access basis for customers who want to test new releases. WARNING: Versions available in the RAPID Channel may be subject to unresolved issues with no known workaround and are not subject to any SLAs.", "Clusters subscribed to REGULAR receive versions that are considered GA quality. REGULAR is intended for production users who want to take advantage of new features.", -"Clusters subscribed to STABLE receive versions that are known to be stable and reliable in production." +"Clusters subscribed to STABLE receive versions that are known to be stable and reliable in production.", +"Clusters subscribed to EXTENDED receive extended support and availability for versions which are known to be stable and reliable in production." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/container.v1beta1.json b/googleapiclient/discovery_cache/documents/container.v1beta1.json index 7917e6d74c5..985166d095b 100644 --- a/googleapiclient/discovery_cache/documents/container.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/container.v1beta1.json @@ -2565,7 +2565,7 @@ } } }, -"revision": "20240619", +"revision": "20240708", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -2641,7 +2641,7 @@ "id": "AdditionalPodRangesConfig", "properties": { "podRangeInfo": { -"description": "Output only. [Output only] Information for additional pod range.", +"description": "Output only. Information for additional pod range.", "items": { "$ref": "RangeInfo" }, @@ -2795,11 +2795,13 @@ "id": "AutoUpgradeOptions", "properties": { "autoUpgradeStartTime": { -"description": "[Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", +"description": "Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", +"readOnly": true, "type": "string" }, "description": { -"description": "[Output only] This field is set when upgrades are about to commence with the description of the upgrade.", +"description": "Output only. This field is set when upgrades are about to commence with the description of the upgrade.", +"readOnly": true, "type": "string" } }, @@ -3274,22 +3276,26 @@ "description": "Configuration for the fine-grained cost management feature." }, "createTime": { -"description": "[Output only] The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", +"description": "Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", +"readOnly": true, "type": "string" }, "currentMasterVersion": { -"description": "[Output only] The current software version of the master endpoint.", +"description": "Output only. The current software version of the master endpoint.", +"readOnly": true, "type": "string" }, "currentNodeCount": { "deprecated": true, -"description": "[Output only] The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information.", +"description": "Output only. The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information.", "format": "int32", +"readOnly": true, "type": "integer" }, "currentNodeVersion": { "deprecated": true, -"description": "[Output only] Deprecated, use [NodePool.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.", +"description": "Output only. Deprecated, use [NodePool.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.", +"readOnly": true, "type": "string" }, "databaseEncryption": { @@ -3317,7 +3323,8 @@ "type": "boolean" }, "endpoint": { -"description": "[Output only] The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information.", +"description": "Output only. The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information.", +"readOnly": true, "type": "string" }, "enterpriseConfig": { @@ -3329,7 +3336,8 @@ "type": "string" }, "expireTime": { -"description": "[Output only] The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", +"description": "Output only. The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", +"readOnly": true, "type": "string" }, "fleet": { @@ -3357,10 +3365,11 @@ }, "instanceGroupUrls": { "deprecated": true, -"description": "Deprecated. Use node_pools.instance_group_urls.", +"description": "Output only. Deprecated. Use node_pools.instance_group_urls.", "items": { "type": "string" }, +"readOnly": true, "type": "array" }, "ipAllocationPolicy": { @@ -3376,7 +3385,8 @@ "description": "Configuration for the legacy ABAC authorization mode." }, "location": { -"description": "[Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.", +"description": "Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.", +"readOnly": true, "type": "string" }, "locations": { @@ -3449,8 +3459,9 @@ "description": "Parameters used in creating the cluster's nodes. For requests, this field should only be used in lieu of a \"node_pool\" object, since this configuration (along with the \"initial_node_count\") will be used to create a \"NodePool\" object with an auto-generated name. Do not use this and a node_pool at the same time. For responses, this field will be populated with the node configuration of the first node pool. (For configuration of each node pool, see `node_pool.config`) If unspecified, the defaults are used. This field is deprecated, use node_pool.config instead." }, "nodeIpv4CidrSize": { -"description": "[Output only] The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode.", +"description": "Output only. The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode.", "format": "int32", +"readOnly": true, "type": "integer" }, "nodePoolAutoConfig": { @@ -3528,11 +3539,13 @@ "description": "Enable/Disable Security Posture API features for the cluster." }, "selfLink": { -"description": "[Output only] Server-defined URL for the resource.", +"description": "Output only. Server-defined URL for the resource.", +"readOnly": true, "type": "string" }, "servicesIpv4Cidr": { -"description": "[Output only] The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR.", +"description": "Output only. The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR.", +"readOnly": true, "type": "string" }, "shieldedNodes": { @@ -3540,7 +3553,7 @@ "description": "Shielded Nodes configuration." }, "status": { -"description": "[Output only] The current status of this cluster.", +"description": "Output only. The current status of this cluster.", "enum": [ "STATUS_UNSPECIFIED", "PROVISIONING", @@ -3559,11 +3572,13 @@ "The ERROR state indicates the cluster may be unusable. Details can be found in the `statusMessage` field.", "The DEGRADED state indicates the cluster requires user action to restore full functionality. Details can be found in the `statusMessage` field." ], +"readOnly": true, "type": "string" }, "statusMessage": { "deprecated": true, -"description": "[Output only] Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available.", +"description": "Output only. Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available.", +"readOnly": true, "type": "string" }, "subnetwork": { @@ -3575,7 +3590,8 @@ "description": "Configuration for Cloud TPU support;" }, "tpuIpv4CidrBlock": { -"description": "[Output only] The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`).", +"description": "Output only. The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`).", +"readOnly": true, "type": "string" }, "verticalPodAutoscaling": { @@ -3596,7 +3612,8 @@ }, "zone": { "deprecated": true, -"description": "[Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead.", +"description": "Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead.", +"readOnly": true, "type": "string" } }, @@ -4240,7 +4257,8 @@ "id": "DailyMaintenanceWindow", "properties": { "duration": { -"description": "[Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario.", +"description": "Output only. Duration of the time window, automatically chosen to be smallest possible in the given scenario.", +"readOnly": true, "type": "string" }, "startTime": { @@ -4369,7 +4387,7 @@ "id": "EnterpriseConfig", "properties": { "clusterTier": { -"description": "Output only. [Output only] cluster_tier specifies the premium tier of the cluster.", +"description": "Output only. cluster_tier specifies the premium tier of the cluster.", "enum": [ "CLUSTER_TIER_UNSPECIFIED", "STANDARD", @@ -4452,11 +4470,13 @@ "id": "Fleet", "properties": { "membership": { -"description": "[Output only] The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`.", +"description": "Output only. The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`.", +"readOnly": true, "type": "string" }, "preRegistered": { -"description": "[Output only] Whether the cluster has been registered through the fleet API.", +"description": "Output only. Whether the cluster has been registered through the fleet API.", +"readOnly": true, "type": "boolean" }, "project": { @@ -4783,7 +4803,7 @@ false "properties": { "additionalPodRangesConfig": { "$ref": "AdditionalPodRangesConfig", -"description": "Output only. [Output only] The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy.", +"description": "Output only. The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy.", "readOnly": true }, "allowRouteOverlap": { @@ -4808,7 +4828,7 @@ false "type": "boolean" }, "defaultPodIpv4RangeUtilization": { -"description": "Output only. [Output only] The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.", +"description": "Output only. The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.", "format": "double", "readOnly": true, "type": "number" @@ -4850,7 +4870,7 @@ false "type": "string" }, "servicesIpv6CidrBlock": { -"description": "Output only. [Output only] The services IPv6 CIDR block for the cluster.", +"description": "Output only. The services IPv6 CIDR block for the cluster.", "readOnly": true, "type": "string" }, @@ -4873,7 +4893,7 @@ false "type": "string" }, "subnetIpv6CidrBlock": { -"description": "Output only. [Output only] The subnet's IPv6 CIDR block used by nodes and pods.", +"description": "Output only. The subnet's IPv6 CIDR block used by nodes and pods.", "readOnly": true, "type": "string" }, @@ -5341,7 +5361,8 @@ false "id": "MasterAuth", "properties": { "clientCertificate": { -"description": "[Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint.", +"description": "Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint.", +"readOnly": true, "type": "string" }, "clientCertificateConfig": { @@ -5349,10 +5370,13 @@ false "description": "Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued." }, "clientKey": { -"description": "[Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint.", +"description": "Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint.", +"readOnly": true, "type": "string" }, "clusterCaCertificate": { +"description": "Output only. Base64-encoded public certificate that is the root of trust for the cluster.", +"readOnly": true, "type": "string" }, "password": { @@ -5588,6 +5612,7 @@ false }, "network": { "description": "Output only. The relative name of the Google Compute Engine network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network", +"readOnly": true, "type": "string" }, "networkPerformanceConfig": { @@ -5616,6 +5641,7 @@ false }, "subnetwork": { "description": "Output only. The relative name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet", +"readOnly": true, "type": "string" } }, @@ -6056,7 +6082,7 @@ false "type": "string" }, "podIpv4RangeUtilization": { -"description": "Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.", +"description": "Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.", "format": "double", "readOnly": true, "type": "number" @@ -6101,10 +6127,11 @@ false "type": "integer" }, "instanceGroupUrls": { -"description": "[Output only] The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.", +"description": "Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.", "items": { "type": "string" }, +"readOnly": true, "type": "array" }, "locations": { @@ -6135,8 +6162,9 @@ false "description": "Specifies the node placement policy." }, "podIpv4CidrSize": { -"description": "[Output only] The pod CIDR block size per node in this node pool.", +"description": "Output only. The pod CIDR block size per node in this node pool.", "format": "int32", +"readOnly": true, "type": "integer" }, "queuedProvisioning": { @@ -6144,11 +6172,12 @@ false "description": "Specifies the configuration of queued provisioning." }, "selfLink": { -"description": "[Output only] Server-defined URL for the resource.", +"description": "Output only. Server-defined URL for the resource.", +"readOnly": true, "type": "string" }, "status": { -"description": "[Output only] The status of the nodes in this pool instance.", +"description": "Output only. The status of the nodes in this pool instance.", "enum": [ "STATUS_UNSPECIFIED", "PROVISIONING", @@ -6167,16 +6196,18 @@ false "The STOPPING state indicates the node pool is being deleted.", "The ERROR state indicates the node pool may be unusable. Details can be found in the `statusMessage` field." ], +"readOnly": true, "type": "string" }, "statusMessage": { "deprecated": true, -"description": "[Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available.", +"description": "Output only. Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available.", +"readOnly": true, "type": "string" }, "updateInfo": { "$ref": "UpdateInfo", -"description": "Output only. [Output only] Update info contains relevant information during a node pool update.", +"description": "Output only. Update info contains relevant information during a node pool update.", "readOnly": true }, "upgradeSettings": { @@ -6349,11 +6380,13 @@ false "type": "array" }, "detail": { -"description": "Detailed operation progress, if available.", +"description": "Output only. Detailed operation progress, if available.", +"readOnly": true, "type": "string" }, "endTime": { -"description": "[Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", +"description": "Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", +"readOnly": true, "type": "string" }, "error": { @@ -6361,11 +6394,13 @@ false "description": "The error result of the operation in case of failure." }, "location": { -"description": "[Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.", +"description": "Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.", +"readOnly": true, "type": "string" }, "name": { -"description": "The server-assigned ID for the operation.", +"description": "Output only. The server-assigned ID for the operation.", +"readOnly": true, "type": "string" }, "nodepoolConditions": { @@ -6377,7 +6412,7 @@ false "type": "array" }, "operationType": { -"description": "The operation type.", +"description": "Output only. The operation type.", "enum": [ "TYPE_UNSPECIFIED", "CREATE_CLUSTER", @@ -6441,23 +6476,26 @@ false "The control plane is being resized. This operation type is initiated by GKE. These operations are often performed preemptively to ensure that the control plane has sufficient resources and is not typically an indication of issues. For more details, see [documentation on resizes](https://cloud.google.com/kubernetes-engine/docs/concepts/maintenance-windows-and-exclusions#repairs).", "Fleet features of GKE Enterprise are being upgraded. The cluster should be assumed to be blocked for other upgrades until the operation finishes." ], +"readOnly": true, "type": "string" }, "progress": { "$ref": "OperationProgress", -"description": "Output only. [Output only] Progress information for an operation.", +"description": "Output only. Progress information for an operation.", "readOnly": true }, "selfLink": { -"description": "Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`.", +"description": "Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`.", +"readOnly": true, "type": "string" }, "startTime": { -"description": "[Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", +"description": "Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", +"readOnly": true, "type": "string" }, "status": { -"description": "The current status of the operation.", +"description": "Output only. The current status of the operation.", "enum": [ "STATUS_UNSPECIFIED", "PENDING", @@ -6472,6 +6510,7 @@ false "The operation is done, either cancelled or completed.", "The operation is aborting." ], +"readOnly": true, "type": "string" }, "statusMessage": { @@ -6481,12 +6520,14 @@ false "type": "string" }, "targetLink": { -"description": "Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`", +"description": "Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`", +"readOnly": true, "type": "string" }, "zone": { "deprecated": true, -"description": "The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.", +"description": "Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.", +"readOnly": true, "type": "string" } }, @@ -6677,10 +6718,12 @@ false }, "peeringName": { "description": "Output only. The peering name in the customer VPC used by this cluster.", +"readOnly": true, "type": "string" }, "privateEndpoint": { "description": "Output only. The internal IP address of this cluster's master endpoint.", +"readOnly": true, "type": "string" }, "privateEndpointSubnetwork": { @@ -6689,6 +6732,7 @@ false }, "publicEndpoint": { "description": "Output only. The external IP address of this cluster's master endpoint.", +"readOnly": true, "type": "string" } }, @@ -6783,12 +6827,12 @@ false "id": "RangeInfo", "properties": { "rangeName": { -"description": "Output only. [Output only] Name of a range.", +"description": "Output only. Name of a range.", "readOnly": true, "type": "string" }, "utilization": { -"description": "Output only. [Output only] The utilization of the range.", +"description": "Output only. The utilization of the range.", "format": "double", "readOnly": true, "type": "number" @@ -6862,13 +6906,15 @@ false "UNSPECIFIED", "RAPID", "REGULAR", -"STABLE" +"STABLE", +"EXTENDED" ], "enumDescriptions": [ "No channel specified.", "RAPID channel is offered on an early access basis for customers who want to test new releases. WARNING: Versions available in the RAPID Channel may be subject to unresolved issues with no known workaround and are not subject to any SLAs.", "Clusters subscribed to REGULAR receive versions that are considered GA quality. REGULAR is intended for production users who want to take advantage of new features.", -"Clusters subscribed to STABLE receive versions that are known to be stable and reliable in production." +"Clusters subscribed to STABLE receive versions that are known to be stable and reliable in production.", +"Clusters subscribed to EXTENDED receive extended support and availability for versions which are known to be stable and reliable in production." ], "type": "string" } @@ -6893,13 +6939,15 @@ false "UNSPECIFIED", "RAPID", "REGULAR", -"STABLE" +"STABLE", +"EXTENDED" ], "enumDescriptions": [ "No channel specified.", "RAPID channel is offered on an early access basis for customers who want to test new releases. WARNING: Versions available in the RAPID Channel may be subject to unresolved issues with no known workaround and are not subject to any SLAs.", "Clusters subscribed to REGULAR receive versions that are considered GA quality. REGULAR is intended for production users who want to take advantage of new features.", -"Clusters subscribed to STABLE receive versions that are known to be stable and reliable in production." +"Clusters subscribed to STABLE receive versions that are known to be stable and reliable in production.", +"Clusters subscribed to EXTENDED receive extended support and availability for versions which are known to be stable and reliable in production." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/content.v2.1.json b/googleapiclient/discovery_cache/documents/content.v2.1.json index b4279a8319c..b742c78e08a 100644 --- a/googleapiclient/discovery_cache/documents/content.v2.1.json +++ b/googleapiclient/discovery_cache/documents/content.v2.1.json @@ -6219,7 +6219,7 @@ } } }, -"revision": "20240614", +"revision": "20240723", "rootUrl": "https://shoppingcontent.googleapis.com/", "schemas": { "Account": { @@ -10806,6 +10806,10 @@ false "format": "int64", "type": "string" }, +"memberPriceEffectiveDate": { +"description": "Optional. A date range during which the item is eligible for member price. If not specified, the member price is always applicable. The date range is represented by a pair of ISO 8601 dates separated by a space, comma, or slash.", +"type": "string" +}, "price": { "$ref": "Price", "description": "Optional. The price for members of the given tier (instant discount price). Must be smaller or equal to the regular price." @@ -14496,7 +14500,7 @@ false "type": "array" }, "source": { -"description": "The source of the offer, that is, how the offer was created. Acceptable values are: - \"`api`\" - \"`crawl`\" - \"`feed`\" ", +"description": "Output only. The source of the offer, that is, how the offer was created. Acceptable values are: - \"`api`\" - \"`crawl`\" - \"`feed`\" ", "type": "string" }, "structuredDescription": { diff --git a/googleapiclient/discovery_cache/documents/css.v1.json b/googleapiclient/discovery_cache/documents/css.v1.json index 94e5ccbf865..4330d0100cf 100644 --- a/googleapiclient/discovery_cache/documents/css.v1.json +++ b/googleapiclient/discovery_cache/documents/css.v1.json @@ -472,7 +472,7 @@ } } }, -"revision": "20240614", +"revision": "20240719", "rootUrl": "https://css.googleapis.com/", "schemas": { "Account": { @@ -820,19 +820,19 @@ "type": "object" }, "Certification": { -"description": "The certification for the product.", +"description": "The certification for the product. Use the this attribute to describe certifications, such as energy efficiency ratings, associated with a product.", "id": "Certification", "properties": { "authority": { -"description": "Name of the certification body.", +"description": "The authority or certification body responsible for issuing the certification. At this time, the most common value is \"EC\" or \u201cEuropean_Commission\u201d for energy labels in the EU.", "type": "string" }, "code": { -"description": "A unique code to identify the certification.", +"description": "The code of the certification. For example, for the EPREL certificate with the link https://eprel.ec.europa.eu/screen/product/dishwashers2019/123456 the code is 123456. The code is required for European Energy Labels.", "type": "string" }, "name": { -"description": "Name of the certification.", +"description": "The name of the certification. At this time, the most common value is \"EPREL\", which represents energy efficiency certifications in the EU European Registry for Energy Labeling (EPREL) database.", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json b/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json index 3d334b12234..4dd38b02dbe 100644 --- a/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json +++ b/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json @@ -8082,7 +8082,7 @@ } } }, -"revision": "20240704", +"revision": "20240716", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -15708,7 +15708,7 @@ true "id": "GoogleCloudDialogflowV2beta1AudioInput", "properties": { "audio": { -"description": "Required. The natural language speech audio to be processed. A single request can contain up to 1 minute of speech audio data. The transcribed text cannot contain more than 256 bytes for virtual agent interactions.", +"description": "Required. The natural language speech audio to be processed. A single request can contain up to 2 minutes of speech audio data. The transcribed text cannot contain more than 256 bytes for virtual agent interactions.", "format": "byte", "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1.json index 333411ed03b..a8cc9cb0323 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1.json @@ -5428,6 +5428,80 @@ } } }, +"identity_mapping_stores": { +"resources": { +"operations": { +"methods": { +"get": { +"description": "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.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/identity_mapping_stores/{identity_mapping_storesId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.identity_mapping_stores.operations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/identity_mapping_stores/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/identity_mapping_stores/{identity_mapping_storesId}/operations", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.identity_mapping_stores.operations.list", +"parameterOrder": [ +"name" +], +"parameters": { +"filter": { +"description": "The standard list filter.", +"location": "query", +"type": "string" +}, +"name": { +"description": "The name of the operation's parent resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/identity_mapping_stores/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The standard list page token.", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}/operations", +"response": { +"$ref": "GoogleLongrunningListOperationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +}, "operations": { "methods": { "get": { @@ -5711,7 +5785,7 @@ } } }, -"revision": "20240704", +"revision": "20240715", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -6252,7 +6326,7 @@ "type": "string" }, "searchResultMode": { -"description": "Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents)", +"description": "Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents)", "enum": [ "SEARCH_RESULT_MODE_UNSPECIFIED", "DOCUMENTS", @@ -6403,7 +6477,7 @@ "properties": { "answer": { "$ref": "GoogleCloudDiscoveryengineV1Answer", -"description": "Answer resource object. If AnswerQueryRequest.StepSpec.max_step_count is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API." +"description": "Answer resource object. If AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.max_rephrase_steps is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API." }, "answerQueryToken": { "description": "A global unique ID used for logging.", @@ -6667,7 +6741,7 @@ "description": "Properties of the object.", "type": "any" }, -"description": "Data representation. The structured JSON data for the document. It's populated from the struct data from the Document (code pointer: http://shortn/_objzAfIiHq), or the Chunk in search result (code pointer: http://shortn/_Ipo6KFFGBL).", +"description": "Data representation. The structured JSON data for the document. It's populated from the struct data from the Document , or the Chunk in search result .", "type": "object" }, "title": { @@ -9753,7 +9827,7 @@ "description": "If there is no extractive_content_spec provided, there will be no extractive answer in the search response." }, "searchResultMode": { -"description": "Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`.", +"description": "Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.", "enum": [ "SEARCH_RESULT_MODE_UNSPECIFIED", "DOCUMENTS", @@ -11263,7 +11337,7 @@ "description": "Properties of the object.", "type": "any" }, -"description": "Data representation. The structured JSON data for the document. It's populated from the struct data from the Document (code pointer: http://shortn/_objzAfIiHq), or the Chunk in search result (code pointer: http://shortn/_Ipo6KFFGBL).", +"description": "Data representation. The structured JSON data for the document. It's populated from the struct data from the Document , or the Chunk in search result .", "type": "object" }, "title": { @@ -11582,6 +11656,12 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaCreateEvaluationMetadata": { +"description": "Metadata for EvaluationService.CreateEvaluation method.", +"id": "GoogleCloudDiscoveryengineV1alphaCreateEvaluationMetadata", +"properties": {}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata": { "description": "Metadata for Create Schema LRO.", "id": "GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata", @@ -11616,6 +11696,17 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec": { +"description": "Defines custom fine tuning spec.", +"id": "GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec", +"properties": { +"enableSearchAdaptor": { +"description": "Whether or not to enable and include custom fine tuned search adaptor model.", +"type": "boolean" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaCustomTuningModel": { "description": "Metadata that describes a custom tuned model.", "id": "GoogleCloudDiscoveryengineV1alphaCustomTuningModel", @@ -12322,6 +12413,96 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaEvaluation": { +"description": "An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data.", +"id": "GoogleCloudDiscoveryengineV1alphaEvaluation", +"properties": { +"createTime": { +"description": "Output only. Timestamp the Evaluation was created at.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"endTime": { +"description": "Output only. Timestamp the Evaluation was completed at.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"error": { +"$ref": "GoogleRpcStatus", +"description": "Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED.", +"readOnly": true +}, +"errorSamples": { +"description": "Output only. A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"readOnly": true, +"type": "array" +}, +"evaluationSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec", +"description": "Required. The specification of the evaluation." +}, +"name": { +"description": "Immutable. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"type": "string" +}, +"qualityMetrics": { +"$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetrics", +"description": "Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet. Only populated when the evaluation's state is SUCCEEDED.", +"readOnly": true +}, +"state": { +"description": "Output only. The state of the evaluation.", +"enum": [ +"STATE_UNSPECIFIED", +"PENDING", +"RUNNING", +"SUCCEEDED", +"FAILED" +], +"enumDescriptions": [ +"The evaluation is unspecified.", +"The service is preparing to run the evaluation.", +"The evaluation is in progress.", +"The evaluation completed successfully.", +"The evaluation failed." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec": { +"description": "Describes the specification of the evaluation.", +"id": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec", +"properties": { +"querySetSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec", +"description": "Required. The specification of the query set." +}, +"searchRequest": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequest", +"description": "Required. The search request that is used to perform the evaluation. Only the following fields within SearchRequest are supported; if any other fields are provided, an UNSUPPORTED error will be returned: * SearchRequest.serving_config * SearchRequest.branch * SearchRequest.canonical_filter * SearchRequest.query_expansion_spec * SearchRequest.spell_correction_spec * SearchRequest.content_search_spec * SearchRequest.user_pseudo_id" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec": { +"description": "Describes the specification of the query set.", +"id": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec", +"properties": { +"sampleQuerySet": { +"description": "Required. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaExportUserEventsMetadata": { "description": "Metadata related to the progress of the Export operation. This is returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1alphaExportUserEventsMetadata", @@ -12505,6 +12686,24 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse": { +"description": "Response message for SiteSearchEngineService.GetUriPatternDocumentData method.", +"id": "GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse", +"properties": { +"documentDataMap": { +"additionalProperties": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" +}, +"description": "Document data keyed by URI pattern. For example: document_data_map = { \"www.url1.com/*\": { \"Categories\": [\"category1\", \"category2\"] }, \"www.url2.com/*\": { \"Categories\": [\"category3\"] } }", +"type": "object" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaIdpConfig": { "description": "Identity Provider Config.", "id": "GoogleCloudDiscoveryengineV1alphaIdpConfig", @@ -12647,6 +12846,56 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaImportSampleQueriesMetadata": { +"description": "Metadata related to the progress of the ImportSampleQueries operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesMetadata", +"properties": { +"createTime": { +"description": "ImportSampleQueries operation create time.", +"format": "google-datetime", +"type": "string" +}, +"failureCount": { +"description": "Count of SampleQuerys that failed to be imported.", +"format": "int64", +"type": "string" +}, +"successCount": { +"description": "Count of SampleQuerys successfully imported.", +"format": "int64", +"type": "string" +}, +"totalCount": { +"description": "Total count of SampleQuerys that were processed.", +"format": "int64", +"type": "string" +}, +"updateTime": { +"description": "ImportSampleQueries operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaImportSampleQueriesResponse": { +"description": "Response of the SampleQueryService.ImportSampleQueries method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.", +"id": "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesResponse", +"properties": { +"errorConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", +"description": "The desired location of errors incurred during the Import." +}, +"errorSamples": { +"description": "A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata": { "description": "Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata", @@ -12743,6 +12992,33 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaInterval": { +"description": "A floating point interval.", +"id": "GoogleCloudDiscoveryengineV1alphaInterval", +"properties": { +"exclusiveMaximum": { +"description": "Exclusive upper bound.", +"format": "double", +"type": "number" +}, +"exclusiveMinimum": { +"description": "Exclusive lower bound.", +"format": "double", +"type": "number" +}, +"maximum": { +"description": "Inclusive upper bound.", +"format": "double", +"type": "number" +}, +"minimum": { +"description": "Inclusive lower bound.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaLanguageInfo": { "description": "Language info for DataStore.", "id": "GoogleCloudDiscoveryengineV1alphaLanguageInfo", @@ -13049,6 +13325,60 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaQualityMetrics": { +"description": "Describes the metrics produced by the evaluation.", +"id": "GoogleCloudDiscoveryengineV1alphaQualityMetrics", +"properties": { +"docNdcg": { +"$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", +"description": "Normalized discounted cumulative gain (NDCG) per document, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved documents (D1, D2, D3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [D3 (0), D1 (1), D2 (1)] Ideal: [D1 (1), D2 (1), D3 (0)] Calculate NDCG@3 for each SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693" +}, +"docPrecision": { +"$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", +"description": "Precision per document, at various top-k cutoff levels. Precision is the fraction of retrieved documents that are relevant. Example (top-5): * For a single SampleQuery, If 4 out of 5 retrieved documents in the top-5 are relevant, precision@5 = 4/5 = 0.8" +}, +"docRecall": { +"$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", +"description": "Recall per document, at various top-k cutoff levels. Recall is the fraction of relevant documents retrieved out of all relevant documents. Example (top-5): * For a single SampleQuery, If 3 out of 5 relevant documents are retrieved in the top-5, recall@5 = 3/5 = 0.6" +}, +"pageNdcg": { +"$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", +"description": "Normalized discounted cumulative gain (NDCG) per page, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved pages (P1, P2, P3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [P3 (0), P1 (1), P2 (1)] Ideal: [P1 (1), P2 (1), P3 (0)] Calculate NDCG@3 for SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693" +}, +"pageRecall": { +"$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", +"description": "Recall per page, at various top-k cutoff levels. Recall is the fraction of relevant pages retrieved out of all relevant pages. Example (top-5): * For a single SampleQuery, if 3 out of 5 relevant pages are retrieved in the top-5, recall@5 = 3/5 = 0.6" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics": { +"description": "Stores the metric values at specific top-k levels.", +"id": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", +"properties": { +"top1": { +"description": "The top-1 value.", +"format": "double", +"type": "number" +}, +"top10": { +"description": "The top-10 value.", +"format": "double", +"type": "number" +}, +"top3": { +"description": "The top-3 value.", +"format": "double", +"type": "number" +}, +"top5": { +"description": "The top-5 value.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaQuery": { "description": "Defines a user inputed query.", "id": "GoogleCloudDiscoveryengineV1alphaQuery", @@ -13203,561 +13533,732 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaSession": { -"description": "External session proto definition.", -"id": "GoogleCloudDiscoveryengineV1alphaSession", +"GoogleCloudDiscoveryengineV1alphaSearchRequest": { +"description": "Request message for SearchService.Search method.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequest", "properties": { -"endTime": { -"description": "Output only. The time the session finished.", -"format": "google-datetime", -"readOnly": true, -"type": "string" +"boostSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec", +"description": "Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)" }, -"name": { -"description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`", +"branch": { +"description": "The branch resource name, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Use `default_branch` as the branch ID or leave this field empty, to search documents under the default branch.", "type": "string" }, -"startTime": { -"description": "Output only. The time the session started.", -"format": "google-datetime", -"readOnly": true, +"canonicalFilter": { +"description": "The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about filter syntax, see SearchRequest.filter.", "type": "string" }, -"state": { -"description": "The state of the session.", -"enum": [ -"STATE_UNSPECIFIED", -"IN_PROGRESS" -], -"enumDescriptions": [ -"State is unspecified.", -"The session is currently open." -], -"type": "string" +"contentSearchSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec", +"description": "A specification for configuring the behavior of content search." }, -"turns": { -"description": "Turns.", +"customFineTuningSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec", +"description": "Custom fine tuning configs. If set, it has higher priority than the configs set in ServingConfig.custom_fine_tuning_spec." +}, +"dataStoreSpecs": { +"description": "Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.", "items": { -"$ref": "GoogleCloudDiscoveryengineV1alphaSessionTurn" +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec" }, "type": "array" }, -"userPseudoId": { -"description": "A unique identifier for tracking users.", +"embeddingSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec", +"description": "Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path." +}, +"facetSpecs": { +"description": "Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec" +}, +"type": "array" +}, +"filter": { +"description": "The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY(\"king kong\")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)", "type": "string" -} }, -"type": "object" +"imageQuery": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery", +"description": "Raw image query." }, -"GoogleCloudDiscoveryengineV1alphaSessionTurn": { -"description": "Represents a turn, including a query from the user and a answer from service.", -"id": "GoogleCloudDiscoveryengineV1alphaSessionTurn", -"properties": { -"answer": { -"description": "The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn.", +"languageCode": { +"description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.", "type": "string" }, -"query": { -"$ref": "GoogleCloudDiscoveryengineV1alphaQuery", -"description": "The user query." -} +"naturalLanguageQueryUnderstandingSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec", +"description": "If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done." }, -"type": "object" +"offset": { +"description": "A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.", +"format": "int32", +"type": "integer" }, -"GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo": { -"description": "Verification information for target sites in advanced site search.", -"id": "GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo", -"properties": { -"siteVerificationState": { -"description": "Site verification state indicating the ownership and validity.", -"enum": [ -"SITE_VERIFICATION_STATE_UNSPECIFIED", -"VERIFIED", -"UNVERIFIED", -"EXEMPTED" -], -"enumDescriptions": [ -"Defaults to VERIFIED.", -"Site ownership verified.", -"Site ownership pending verification or verification failed.", -"Site exempt from verification, e.g., a public website that opens to all." -], +"orderBy": { +"description": "The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering for retail search, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.", "type": "string" }, -"verifyTime": { -"description": "Latest site verification time.", -"format": "google-datetime", +"pageSize": { +"description": "Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.", +"format": "int32", +"type": "integer" +}, +"pageToken": { +"description": "A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", "type": "string" -} }, +"params": { +"additionalProperties": { +"type": "any" +}, +"description": "Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. For example, `user_country_code: \"au\"` For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example, `search_type: 1`", "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaTargetSite": { -"description": "A target site for the SiteSearchEngine.", -"id": "GoogleCloudDiscoveryengineV1alphaTargetSite", -"properties": { -"exactMatch": { -"description": "Input only. If set to false, a uri_pattern is generated to include all pages whose address contains the provided_uri_pattern. If set to true, an uri_pattern is generated to try to be an exact match of the provided_uri_pattern or just the specific page if the provided_uri_pattern is a specific one. provided_uri_pattern is always normalized to generate the URI pattern to be used by the search engine.", -"type": "boolean" +"query": { +"description": "Raw search query.", +"type": "string" }, -"failureReason": { -"$ref": "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason", -"description": "Output only. Failure reason.", -"readOnly": true +"queryExpansionSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec", +"description": "The query expansion specification that specifies the conditions under which query expansion occurs." }, -"generatedUriPattern": { -"description": "Output only. This is system-generated based on the provided_uri_pattern.", -"readOnly": true, +"rankingExpression": { +"description": "The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The ranking expression is a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.", "type": "string" }, -"indexingStatus": { -"description": "Output only. Indexing status.", +"regionCode": { +"description": "The Unicode country/region code (CLDR) of a location, such as \"US\" and \"419\". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.", +"type": "string" +}, +"relevanceThreshold": { +"description": "The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information.", "enum": [ -"INDEXING_STATUS_UNSPECIFIED", -"PENDING", -"FAILED", -"SUCCEEDED", -"DELETING" +"RELEVANCE_THRESHOLD_UNSPECIFIED", +"LOWEST", +"LOW", +"MEDIUM", +"HIGH" ], "enumDescriptions": [ -"Defaults to SUCCEEDED.", -"The target site is in the update queue and will be picked up by indexing pipeline.", -"The target site fails to be indexed.", -"The target site has been indexed.", -"The previously indexed target site has been marked to be deleted. This is a transitioning state which will resulted in either: 1. target site deleted if unindexing is successful; 2. state reverts to SUCCEEDED if the unindexing fails." +"Default value. In this case, server behavior defaults to Google defined threshold.", +"Lowest relevance threshold.", +"Low relevance threshold.", +"Medium relevance threshold.", +"High relevance threshold." ], -"readOnly": true, "type": "string" }, -"name": { -"description": "Output only. The fully qualified resource name of the target site. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}` The `target_site_id` is system-generated.", -"readOnly": true, -"type": "string" +"safeSearch": { +"description": "Whether to turn on safe search. This is only supported for website search.", +"type": "boolean" }, -"providedUriPattern": { -"description": "Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated.", +"searchAsYouTypeSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec", +"description": "Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical." +}, +"servingConfig": { +"description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.", "type": "string" }, -"rootDomainUri": { -"description": "Output only. Root domain of the provided_uri_pattern.", -"readOnly": true, +"session": { +"description": "The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is \"How did Alphabet do in 2022?\" and the current query is \"How about 2023?\", the current query will be interpreted as \"How did Alphabet do in 2023?\". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.", "type": "string" }, -"siteVerificationInfo": { -"$ref": "GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo", -"description": "Output only. Site ownership and validity verification status.", -"readOnly": true +"sessionSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec", +"description": "Session specification. Can be used only when `session` is set." }, -"type": { -"description": "The type of the target site, e.g., whether the site is to be included or excluded.", -"enum": [ -"TYPE_UNSPECIFIED", -"INCLUDE", -"EXCLUDE" -], -"enumDescriptions": [ -"This value is unused. In this case, server behavior defaults to Type.INCLUDE.", -"Include the target site.", -"Exclude the target site." -], -"type": "string" +"spellCorrectionSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec", +"description": "The spell correction specification that specifies the mode under which spell correction takes effect." }, -"updateTime": { -"description": "Output only. The target site's last updated time.", -"format": "google-datetime", -"readOnly": true, +"userInfo": { +"$ref": "GoogleCloudDiscoveryengineV1alphaUserInfo", +"description": "Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics." +}, +"userLabels": { +"additionalProperties": { "type": "string" -} }, +"description": "The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * 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. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.", "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason": { -"description": "Site search indexing failure reasons.", -"id": "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason", -"properties": { -"quotaFailure": { -"$ref": "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure", -"description": "Failed due to insufficient quota." +"userPseudoId": { +"description": "A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure": { -"description": "Failed due to insufficient quota.", -"id": "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure", +"GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec": { +"description": "Boost specification to boost certain documents.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec", "properties": { -"totalRequiredQuota": { -"description": "This number is an estimation on how much total quota this project needs to successfully complete indexing.", -"format": "int64", -"type": "string" +"conditionBoostSpecs": { +"description": "Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec" +}, +"type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata": { -"description": "Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata", +"GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec": { +"description": "Boost applies to documents which match a condition.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", -"type": "string" +"boost": { +"description": "Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied.", +"format": "float", +"type": "number" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"boostControlSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec", +"description": "Complex specification for custom ranking based on customer defined attribute value." +}, +"condition": { +"description": "An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID \"doc_1\" or \"doc_2\", and color \"Red\" or \"Blue\": `(document_id: ANY(\"doc_1\", \"doc_2\")) AND (color: ANY(\"Red\", \"Blue\"))`", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse": { -"description": "Response of the TrainCustomModelRequest. This message is returned by the google.longrunning.Operations.response field.", -"id": "GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse", +"GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec": { +"description": "Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec", "properties": { -"errorConfig": { -"$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", -"description": "Echoes the destination for the complete errors in the request if set." +"attributeType": { +"description": "The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).", +"enum": [ +"ATTRIBUTE_TYPE_UNSPECIFIED", +"NUMERICAL", +"FRESHNESS" +], +"enumDescriptions": [ +"Unspecified AttributeType.", +"The value of the numerical field will be used to dynamically update the boost amount. In this case, the attribute_value (the x value) of the control point will be the actual value of the numerical field for which the boost_amount is specified.", +"For the freshness use case the attribute value will be the duration between the current time and the date in the datetime field specified. The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. For example, `5D`, `3DT12H30M`, `T24H`." +], +"type": "string" }, -"errorSamples": { -"description": "A sample of errors encountered while processing the data.", +"controlPoints": { +"description": "The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.", "items": { -"$ref": "GoogleRpcStatus" +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint" }, "type": "array" }, -"metrics": { -"additionalProperties": { -"format": "double", -"type": "number" -}, -"description": "The metrics of the trained model.", -"type": "object" -}, -"modelName": { -"description": "Fully qualified name of the CustomTuningModel.", +"fieldName": { +"description": "The name of the field whose value will be used to determine the boost amount.", "type": "string" }, -"modelStatus": { -"description": "The trained model status. Possible values are: * **bad-data**: The training data quality is bad. * **no-improvement**: Tuning didn't improve performance. Won't deploy. * **in-progress**: Model training job creation is in progress. * **training**: Model is actively training. * **evaluating**: The model is evaluating trained metrics. * **indexing**: The model trained metrics are indexing. * **ready**: The model is ready for serving.", +"interpolationType": { +"description": "The interpolation type to be applied to connect the control points listed below.", +"enum": [ +"INTERPOLATION_TYPE_UNSPECIFIED", +"LINEAR" +], +"enumDescriptions": [ +"Interpolation type is unspecified. In this case, it defaults to Linear.", +"Piecewise linear interpolation will be applied." +], "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata": { -"description": "Metadata associated with a tune operation.", -"id": "GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata", +"GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint": { +"description": "The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint", "properties": { -"engine": { -"description": "Required. The resource name of the engine that this tune applies to. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`", +"attributeValue": { +"description": "Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.", "type": "string" -} }, -"type": "object" +"boostAmount": { +"description": "The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.", +"format": "float", +"type": "number" +} }, -"GoogleCloudDiscoveryengineV1alphaTuneEngineResponse": { -"description": "Response associated with a tune operation.", -"id": "GoogleCloudDiscoveryengineV1alphaTuneEngineResponse", -"properties": {}, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata": { -"description": "Metadata for UpdateSchema LRO.", -"id": "GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata", +"GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec": { +"description": "A specification for configuring the behavior of content search.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", -"type": "string" +"chunkSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec", +"description": "Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"extractiveContentSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec", +"description": "If there is no extractive_content_spec provided, there will be no extractive answer in the search response." +}, +"searchResultMode": { +"description": "Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.", +"enum": [ +"SEARCH_RESULT_MODE_UNSPECIFIED", +"DOCUMENTS", +"CHUNKS" +], +"enumDescriptions": [ +"Default value.", +"Returns documents in the search result.", +"Returns chunks in the search result. Only available if the DataStore.DocumentProcessingConfig.chunking_config is specified." +], "type": "string" +}, +"snippetSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec", +"description": "If `snippetSpec` is not specified, snippets are not included in the search response." +}, +"summarySpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec", +"description": "If `summarySpec` is not specified, summaries are not included in the search response." } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata": { -"description": "Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata", +"GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec": { +"description": "Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"numNextChunks": { +"description": "The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned.", +"format": "int32", +"type": "integer" +}, +"numPreviousChunks": { +"description": "The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec": { +"description": "A specification for configuring the extractive content in a search response.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec", +"properties": { +"maxExtractiveAnswerCount": { +"description": "The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult.", +"format": "int32", +"type": "integer" +}, +"maxExtractiveSegmentCount": { +"description": "The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`.", +"format": "int32", +"type": "integer" +}, +"numNextSegments": { +"description": "Return at most `num_next_segments` segments after each selected segments.", +"format": "int32", +"type": "integer" +}, +"numPreviousSegments": { +"description": "Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.", +"format": "int32", +"type": "integer" +}, +"returnExtractiveSegmentScore": { +"description": "Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`.", +"type": "boolean" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec": { +"description": "A specification for configuring snippets in a search response.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec", +"properties": { +"maxSnippetCount": { +"deprecated": true, +"description": "[DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0.", +"format": "int32", +"type": "integer" +}, +"referenceOnly": { +"deprecated": true, +"description": "[DEPRECATED] This field is deprecated and will have no affect on the snippet.", +"type": "boolean" +}, +"returnSnippet": { +"description": "If `true`, then return snippet. If no snippet can be generated, we return \"No snippet is available for this page.\" A `snippet_status` with `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned.", +"type": "boolean" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec": { +"description": "A specification for configuring a summary returned in a search response.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec", +"properties": { +"ignoreAdversarialQuery": { +"description": "Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead.", +"type": "boolean" +}, +"ignoreNonSummarySeekingQuery": { +"description": "Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead.", +"type": "boolean" +}, +"includeCitations": { +"description": "Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results.", +"type": "boolean" +}, +"languageCode": { +"description": "Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.", "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"modelPromptSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec", +"description": "If specified, the spec will be used to modify the prompt provided to the LLM." +}, +"modelSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec", +"description": "If specified, the spec will be used to modify the model specification provided to the LLM." +}, +"summaryResultCount": { +"description": "The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.", +"format": "int32", +"type": "integer" +}, +"useSemanticChunks": { +"description": "If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list.", +"type": "boolean" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec": { +"description": "Specification of the prompt to use with the model.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec", +"properties": { +"preamble": { +"description": "Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata": { -"description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata", +"GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec": { +"description": "Specification of the model.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"version": { +"description": "The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). * `preview`: string. (Public preview) Uses a preview model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).", "type": "string" +} }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec": { +"description": "A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec", +"properties": { +"dataStore": { +"description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesResponse": { -"description": "Response message for SiteSearchEngineService.BatchCreateTargetSites method.", -"id": "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesResponse", +"GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec": { +"description": "The specification that uses customized query embedding vector to do semantic document retrieval.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec", "properties": { -"targetSites": { -"description": "TargetSites created.", +"embeddingVectors": { +"description": "The embedding vector used for retrieval. Limit to 1.", "items": { -"$ref": "GoogleCloudDiscoveryengineV1betaTargetSite" +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector" }, "type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaCondition": { -"description": "Defines circumstances to be checked before allowing a behavior", -"id": "GoogleCloudDiscoveryengineV1betaCondition", +"GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector": { +"description": "Embedding vector.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector", "properties": { -"activeTimeRange": { -"description": "Range of time(s) specifying when condition is active. Maximum of 10 time ranges.", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1betaConditionTimeRange" -}, -"type": "array" +"fieldPath": { +"description": "Embedding field path in schema.", +"type": "string" }, -"queryTerms": { -"description": "Search only A list of terms to match the query on. Maximum of 10 query terms.", +"vector": { +"description": "Query embedding vector.", "items": { -"$ref": "GoogleCloudDiscoveryengineV1betaConditionQueryTerm" +"format": "float", +"type": "number" }, "type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaConditionQueryTerm": { -"description": "Matcher for search request query", -"id": "GoogleCloudDiscoveryengineV1betaConditionQueryTerm", +"GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec": { +"description": "A facet specification to perform faceted search.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec", "properties": { -"fullMatch": { -"description": "Whether the search query needs to exactly match the query term.", +"enableDynamicPosition": { +"description": "Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * \"rating\", enable_dynamic_position = true * \"price\", enable_dynamic_position = false * \"brands\", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be (\"price\", \"brands\", \"rating\", \"gender\") or (\"price\", \"brands\", \"gender\", \"rating\") depends on how API orders \"gender\" and \"rating\" facets. However, notice that \"price\" and \"brands\" are always ranked at first and second position because their enable_dynamic_position is false.", "type": "boolean" }, -"value": { -"description": "The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters.", +"excludedFilterKeys": { +"description": "List of keys to exclude when faceting. By default, FacetKey.key is not excluded from the filter unless it is listed in this field. Listing a facet key in this field allows its values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned. For example, suppose there are 100 documents with the color facet \"Red\" and 200 documents with the color facet \"Blue\". A query containing the filter \"color:ANY(\"Red\")\" and having \"color\" as FacetKey.key would by default return only \"Red\" documents in the search results, and also return \"Red\" with count 100 as the only color facet. Although there are also blue documents available, \"Blue\" would not be shown as an available facet value. If \"color\" is listed in \"excludedFilterKeys\", then the query returns the facet values \"Red\" with count 100 and \"Blue\" with count 200, because the \"color\" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly filtered to return only \"Red\" documents. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"items": { "type": "string" -} }, -"type": "object" +"type": "array" }, -"GoogleCloudDiscoveryengineV1betaConditionTimeRange": { -"description": "Used for time-dependent conditions.", -"id": "GoogleCloudDiscoveryengineV1betaConditionTimeRange", -"properties": { -"endTime": { -"description": "End of time range. Range is inclusive. Must be in the future.", -"format": "google-datetime", -"type": "string" +"facetKey": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey", +"description": "Required. The facet key specification." }, -"startTime": { -"description": "Start of time range. Range is inclusive.", -"format": "google-datetime", -"type": "string" +"limit": { +"description": "Maximum facet values that are returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. For aggregation in healthcare search, when the [FacetKey.key] is \"healthcare_aggregation_key\", the limit will be overridden to 10,000 internally, regardless of the value set here. If this field is negative, an `INVALID_ARGUMENT` is returned.", +"format": "int32", +"type": "integer" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaControl": { -"description": "Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`.", -"id": "GoogleCloudDiscoveryengineV1betaControl", +"GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey": { +"description": "Specifies how a facet is computed.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey", "properties": { -"associatedServingConfigIds": { -"description": "Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes.", +"caseInsensitive": { +"description": "True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.", +"type": "boolean" +}, +"contains": { +"description": "Only get facet values that contain the given strings. For example, suppose \"category\" has three values \"Action > 2022\", \"Action > 2021\" and \"Sci-Fi > 2022\". If set \"contains\" to \"2022\", the \"category\" facet only contains \"Action > 2022\" and \"Sci-Fi > 2022\". Only supported on textual fields. Maximum is 10.", "items": { "type": "string" }, -"readOnly": true, "type": "array" }, -"boostAction": { -"$ref": "GoogleCloudDiscoveryengineV1betaControlBoostAction", -"description": "Defines a boost-type control" -}, -"conditions": { -"description": "Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown.", +"intervals": { +"description": "Set only if values should be bucketed into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30.", "items": { -"$ref": "GoogleCloudDiscoveryengineV1betaCondition" +"$ref": "GoogleCloudDiscoveryengineV1alphaInterval" }, "type": "array" }, -"displayName": { -"description": "Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown.", +"key": { +"description": "Required. Supported textual and numerical facet keys in Document object, over which the facet values are computed. Facet key is case-sensitive.", "type": "string" }, -"filterAction": { -"$ref": "GoogleCloudDiscoveryengineV1betaControlFilterAction", -"description": "Defines a filter-type control Currently not supported by Recommendation" +"orderBy": { +"description": "The order in which documents are returned. Allowed values are: * \"count desc\", which means order by SearchResponse.Facet.values.count descending. * \"value desc\", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets. If not set, textual values are sorted in [natural order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals.", +"type": "string" }, -"name": { -"description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`", +"prefixes": { +"description": "Only get facet values that start with the given string prefix. For example, suppose \"category\" has three values \"Action > 2022\", \"Action > 2021\" and \"Sci-Fi > 2022\". If set \"prefixes\" to \"Action\", the \"category\" facet only contains \"Action > 2022\" and \"Action > 2021\". Only supported on textual fields. Maximum is 10.", +"items": { "type": "string" }, -"redirectAction": { -"$ref": "GoogleCloudDiscoveryengineV1betaControlRedirectAction", -"description": "Defines a redirect-type control." +"type": "array" }, -"solutionType": { -"description": "Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.", -"enum": [ -"SOLUTION_TYPE_UNSPECIFIED", -"SOLUTION_TYPE_RECOMMENDATION", -"SOLUTION_TYPE_SEARCH", -"SOLUTION_TYPE_CHAT", -"SOLUTION_TYPE_GENERATIVE_CHAT" -], -"enumDescriptions": [ -"Default value.", -"Used for Recommendations AI.", -"Used for Discovery Search.", -"Used for use cases related to the Generative AI agent.", -"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution." -], +"restrictedValues": { +"description": "Only get facet for the given restricted values. Only supported on textual fields. For example, suppose \"category\" has three values \"Action > 2022\", \"Action > 2021\" and \"Sci-Fi > 2022\". If set \"restricted_values\" to \"Action > 2022\", the \"category\" facet only contains \"Action > 2022\". Only supported on textual fields. Maximum is 10.", +"items": { "type": "string" }, -"synonymsAction": { -"$ref": "GoogleCloudDiscoveryengineV1betaControlSynonymsAction", -"description": "Treats a group of terms as synonyms of one another." +"type": "array" +} }, -"useCases": { -"description": "Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH.", -"items": { +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery": { +"description": "Specifies the image query input.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery", +"properties": { +"imageBytes": { +"description": "Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec": { +"description": "Specification to enable natural language understanding capabilities for search requests.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec", +"properties": { +"filterExtractionCondition": { +"description": "The condition under which filter extraction should occur. Default to Condition.DISABLED.", "enum": [ -"SEARCH_USE_CASE_UNSPECIFIED", -"SEARCH_USE_CASE_SEARCH", -"SEARCH_USE_CASE_BROWSE" +"CONDITION_UNSPECIFIED", +"DISABLED", +"ENABLED" ], "enumDescriptions": [ -"Value used when unset. Will not occur in CSS.", -"Search use case. Expects the traffic has a non-empty query.", -"Browse use case. Expects the traffic has an empty query." +"Server behavior defaults to Condition.DISABLED.", +"Disables NL filter extraction.", +"Enables NL filter extraction." ], "type": "string" }, +"geoSearchQueryDetectionFieldNames": { +"description": "Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.", +"items": { +"type": "string" +}, "type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaControlBoostAction": { -"description": "Adjusts order of products in returned list.", -"id": "GoogleCloudDiscoveryengineV1betaControlBoostAction", +"GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec": { +"description": "Specification to determine under which conditions query expansion should occur.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec", "properties": { -"boost": { -"description": "Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).", -"format": "float", -"type": "number" -}, -"dataStore": { -"description": "Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store", +"condition": { +"description": "The condition under which query expansion should occur. Default to Condition.DISABLED.", +"enum": [ +"CONDITION_UNSPECIFIED", +"DISABLED", +"AUTO" +], +"enumDescriptions": [ +"Unspecified query expansion condition. In this case, server behavior defaults to Condition.DISABLED.", +"Disabled query expansion. Only the exact search query is used, even if SearchResponse.total_size is zero.", +"Automatic query expansion built by the Search API." +], "type": "string" }, -"filter": { -"description": "Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.", -"type": "string" +"pinUnexpandedResults": { +"description": "Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results.", +"type": "boolean" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaControlFilterAction": { -"description": "Specified which products may be included in results. Uses same filter as boost.", -"id": "GoogleCloudDiscoveryengineV1betaControlFilterAction", +"GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec": { +"description": "Specification for search as you type in search requests.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec", "properties": { -"dataStore": { -"description": "Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store", -"type": "string" -}, -"filter": { -"description": "Required. A filter to apply on the matching condition results. Required Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.", +"condition": { +"description": "The condition under which search as you type should occur. Default to Condition.DISABLED.", +"enum": [ +"CONDITION_UNSPECIFIED", +"DISABLED", +"ENABLED" +], +"enumDescriptions": [ +"Server behavior defaults to Condition.DISABLED.", +"Disables Search As You Type.", +"Enables Search As You Type." +], "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaControlRedirectAction": { -"description": "Redirects a shopper to the provided URI.", -"id": "GoogleCloudDiscoveryengineV1betaControlRedirectAction", +"GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec": { +"description": "Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec", "properties": { -"redirectUri": { -"description": "Required. The URI to which the shopper will be redirected. Required. URI must have length equal or less than 2000 characters. Otherwise an INVALID ARGUMENT error is thrown.", +"queryId": { +"description": "If set, the search result gets stored to the \"turn\" specified by this query ID. Example: Let's say the session looks like this: session { name: \".../sessions/xxx\" turns { query { text: \"What is foo?\" query_id: \".../questions/yyy\" } answer: \"Foo is ...\" } turns { query { text: \"How about bar then?\" query_id: \".../questions/zzz\" } } } The user can call /search API with a request like this: session: \".../sessions/xxx\" session_spec { query_id: \".../questions/zzz\" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID.", "type": "string" +}, +"searchResultPersistenceCount": { +"description": "The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is simliar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode.", +"format": "int32", +"type": "integer" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaControlSynonymsAction": { -"description": "Creates a set of terms that will act as synonyms of one another. Example: \"happy\" will also be considered as \"glad\", \"glad\" will also be considered as \"happy\".", -"id": "GoogleCloudDiscoveryengineV1betaControlSynonymsAction", +"GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec": { +"description": "The specification for query spell correction.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec", "properties": { -"synonyms": { -"description": "Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown.", -"items": { +"mode": { +"description": "The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO.", +"enum": [ +"MODE_UNSPECIFIED", +"SUGGESTION_ONLY", +"AUTO" +], +"enumDescriptions": [ +"Unspecified spell correction mode. In this case, server behavior defaults to Mode.AUTO.", +"Search API tries to find a spelling suggestion. If a suggestion is found, it is put in the SearchResponse.corrected_query. The spelling suggestion won't be used as the search query.", +"Automatic spell correction built by the Search API. Search will be based on the corrected query if found." +], "type": "string" -}, -"type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata": { -"description": "Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata", +"GoogleCloudDiscoveryengineV1alphaSession": { +"description": "External session proto definition.", +"id": "GoogleCloudDiscoveryengineV1alphaSession", "properties": { -"createTime": { -"description": "Operation create time.", +"endTime": { +"description": "Output only. The time the session finished.", "format": "google-datetime", +"readOnly": true, "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", +"name": { +"description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`", +"type": "string" +}, +"startTime": { +"description": "Output only. The time the session started.", "format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"state": { +"description": "The state of the session.", +"enum": [ +"STATE_UNSPECIFIED", +"IN_PROGRESS" +], +"enumDescriptions": [ +"State is unspecified.", +"The session is currently open." +], +"type": "string" +}, +"turns": { +"description": "Turns.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSessionTurn" +}, +"type": "array" +}, +"userPseudoId": { +"description": "A unique identifier for tracking users.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaCreateEngineMetadata": { -"description": "Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1betaCreateEngineMetadata", +"GoogleCloudDiscoveryengineV1alphaSessionTurn": { +"description": "Represents a turn, including a query from the user and a answer from service.", +"id": "GoogleCloudDiscoveryengineV1alphaSessionTurn", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"answer": { +"description": "The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn.", "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", -"type": "string" +"query": { +"$ref": "GoogleCloudDiscoveryengineV1alphaQuery", +"description": "The user query." } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata": { -"description": "Metadata for Create Schema LRO.", -"id": "GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata", +"GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataMetadata": { +"description": "Metadata related to the progress of the SiteSearchEngineService.SetUriPatternDocumentData operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -13772,178 +14273,145 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaCreateTargetSiteMetadata": { -"description": "Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1betaCreateTargetSiteMetadata", +"GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataResponse": { +"description": "Response message for SiteSearchEngineService.SetUriPatternDocumentData method.", +"id": "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataResponse", +"properties": {}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo": { +"description": "Verification information for target sites in advanced site search.", +"id": "GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"siteVerificationState": { +"description": "Site verification state indicating the ownership and validity.", +"enum": [ +"SITE_VERIFICATION_STATE_UNSPECIFIED", +"VERIFIED", +"UNVERIFIED", +"EXEMPTED" +], +"enumDescriptions": [ +"Defaults to VERIFIED.", +"Site ownership verified.", +"Site ownership pending verification or verification failed.", +"Site exempt from verification, e.g., a public website that opens to all." +], "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", +"verifyTime": { +"description": "Latest site verification time.", "format": "google-datetime", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaCustomTuningModel": { -"description": "Metadata that describes a custom tuned model.", -"id": "GoogleCloudDiscoveryengineV1betaCustomTuningModel", +"GoogleCloudDiscoveryengineV1alphaTargetSite": { +"description": "A target site for the SiteSearchEngine.", +"id": "GoogleCloudDiscoveryengineV1alphaTargetSite", "properties": { -"createTime": { -"deprecated": true, -"description": "Timestamp the Model was created at.", -"format": "google-datetime", -"type": "string" +"exactMatch": { +"description": "Input only. If set to false, a uri_pattern is generated to include all pages whose address contains the provided_uri_pattern. If set to true, an uri_pattern is generated to try to be an exact match of the provided_uri_pattern or just the specific page if the provided_uri_pattern is a specific one. provided_uri_pattern is always normalized to generate the URI pattern to be used by the search engine.", +"type": "boolean" }, -"displayName": { -"description": "The display name of the model.", -"type": "string" +"failureReason": { +"$ref": "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason", +"description": "Output only. Failure reason.", +"readOnly": true }, -"metrics": { -"additionalProperties": { -"format": "double", -"type": "number" -}, -"description": "The metrics of the trained model.", -"type": "object" +"generatedUriPattern": { +"description": "Output only. This is system-generated based on the provided_uri_pattern.", +"readOnly": true, +"type": "string" }, -"modelState": { -"description": "The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).", +"indexingStatus": { +"description": "Output only. Indexing status.", "enum": [ -"MODEL_STATE_UNSPECIFIED", -"TRAINING_PAUSED", -"TRAINING", -"TRAINING_COMPLETE", -"READY_FOR_SERVING", -"TRAINING_FAILED", -"NO_IMPROVEMENT" +"INDEXING_STATUS_UNSPECIFIED", +"PENDING", +"FAILED", +"SUCCEEDED", +"DELETING" ], "enumDescriptions": [ -"Default value.", -"The model is in a paused training state.", -"The model is currently training.", -"The model has successfully completed training.", -"The model is ready for serving.", -"The model training failed.", -"The model training finished successfully but metrics did not improve." +"Defaults to SUCCEEDED.", +"The target site is in the update queue and will be picked up by indexing pipeline.", +"The target site fails to be indexed.", +"The target site has been indexed.", +"The previously indexed target site has been marked to be deleted. This is a transitioning state which will resulted in either: 1. target site deleted if unindexing is successful; 2. state reverts to SUCCEEDED if the unindexing fails." ], +"readOnly": true, "type": "string" }, -"modelVersion": { -"description": "The version of the model.", -"format": "int64", +"name": { +"description": "Output only. The fully qualified resource name of the target site. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}` The `target_site_id` is system-generated.", +"readOnly": true, "type": "string" }, -"name": { -"description": "Required. The fully qualified resource name of the model. Format: `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}` model must be an alpha-numerical string with limit of 40 characters.", +"providedUriPattern": { +"description": "Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated.", "type": "string" }, -"trainingStartTime": { -"description": "Timestamp the model training was initiated.", -"format": "google-datetime", +"rootDomainUri": { +"description": "Output only. Root domain of the provided_uri_pattern.", +"readOnly": true, "type": "string" -} }, -"type": "object" +"siteVerificationInfo": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo", +"description": "Output only. Site ownership and validity verification status.", +"readOnly": true }, -"GoogleCloudDiscoveryengineV1betaDataStore": { -"description": "DataStore captures global settings and configs at the DataStore level.", -"id": "GoogleCloudDiscoveryengineV1betaDataStore", -"properties": { -"contentConfig": { -"description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", +"type": { +"description": "The type of the target site, e.g., whether the site is to be included or excluded.", "enum": [ -"CONTENT_CONFIG_UNSPECIFIED", -"NO_CONTENT", -"CONTENT_REQUIRED", -"PUBLIC_WEBSITE" +"TYPE_UNSPECIFIED", +"INCLUDE", +"EXCLUDE" ], "enumDescriptions": [ -"Default value.", -"Only contains documents without any Document.content.", -"Only contains documents with Document.content.", -"The data store is used for public website search." +"This value is unused. In this case, server behavior defaults to Type.INCLUDE.", +"Include the target site.", +"Exclude the target site." ], "type": "string" }, -"createTime": { -"description": "Output only. Timestamp the DataStore was created at.", +"updateTime": { +"description": "Output only. The target site's last updated time.", "format": "google-datetime", "readOnly": true, "type": "string" +} }, -"defaultSchemaId": { -"description": "Output only. The id of the default Schema asscociated to this data store.", -"readOnly": true, -"type": "string" -}, -"displayName": { -"description": "Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.", -"type": "string" -}, -"documentProcessingConfig": { -"$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig", -"description": "Configuration for Document understanding and enrichment." -}, -"industryVertical": { -"description": "Immutable. The industry vertical that the data store registers.", -"enum": [ -"INDUSTRY_VERTICAL_UNSPECIFIED", -"GENERIC", -"MEDIA", -"HEALTHCARE_FHIR" -], -"enumDescriptions": [ -"Value used when unset.", -"The generic vertical for documents that are not specific to any industry vertical.", -"The media industry vertical.", -"The healthcare FHIR vertical." -], -"type": "string" +"type": "object" }, -"languageInfo": { -"$ref": "GoogleCloudDiscoveryengineV1betaLanguageInfo", -"description": "Language info for DataStore." +"GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason": { +"description": "Site search indexing failure reasons.", +"id": "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason", +"properties": { +"quotaFailure": { +"$ref": "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure", +"description": "Failed due to insufficient quota." +} }, -"name": { -"description": "Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", -"type": "string" +"type": "object" }, -"solutionTypes": { -"description": "The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.", -"items": { -"enum": [ -"SOLUTION_TYPE_UNSPECIFIED", -"SOLUTION_TYPE_RECOMMENDATION", -"SOLUTION_TYPE_SEARCH", -"SOLUTION_TYPE_CHAT", -"SOLUTION_TYPE_GENERATIVE_CHAT" -], -"enumDescriptions": [ -"Default value.", -"Used for Recommendations AI.", -"Used for Discovery Search.", -"Used for use cases related to the Generative AI agent.", -"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution." -], +"GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure": { +"description": "Failed due to insufficient quota.", +"id": "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure", +"properties": { +"totalRequiredQuota": { +"description": "This number is an estimation on how much total quota this project needs to successfully complete indexing.", +"format": "int64", "type": "string" -}, -"type": "array" -}, -"startingSchema": { -"$ref": "GoogleCloudDiscoveryengineV1betaSchema", -"description": "The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema)." } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata": { -"description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata", +"GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata": { +"description": "Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -13958,26 +14426,60 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaDeleteEngineMetadata": { -"description": "Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1betaDeleteEngineMetadata", +"GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse": { +"description": "Response of the TrainCustomModelRequest. This message is returned by the google.longrunning.Operations.response field.", +"id": "GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"errorConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", +"description": "Echoes the destination for the complete errors in the request if set." +}, +"errorSamples": { +"description": "A sample of errors encountered while processing the data.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"type": "array" +}, +"metrics": { +"additionalProperties": { +"format": "double", +"type": "number" +}, +"description": "The metrics of the trained model.", +"type": "object" +}, +"modelName": { +"description": "Fully qualified name of the CustomTuningModel.", "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"modelStatus": { +"description": "The trained model status. Possible values are: * **bad-data**: The training data quality is bad. * **no-improvement**: Tuning didn't improve performance. Won't deploy. * **in-progress**: Model training job creation is in progress. * **training**: Model is actively training. * **evaluating**: The model is evaluating trained metrics. * **indexing**: The model trained metrics are indexing. * **ready**: The model is ready for serving.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaDeleteSchemaMetadata": { -"description": "Metadata for DeleteSchema LRO.", -"id": "GoogleCloudDiscoveryengineV1betaDeleteSchemaMetadata", +"GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata": { +"description": "Metadata associated with a tune operation.", +"id": "GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata", +"properties": { +"engine": { +"description": "Required. The resource name of the engine that this tune applies to. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaTuneEngineResponse": { +"description": "Response associated with a tune operation.", +"id": "GoogleCloudDiscoveryengineV1alphaTuneEngineResponse", +"properties": {}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata": { +"description": "Metadata for UpdateSchema LRO.", +"id": "GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -13992,9 +14494,9 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaDeleteTargetSiteMetadata": { -"description": "Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1betaDeleteTargetSiteMetadata", +"GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata": { +"description": "Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -14009,9 +14511,24 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchMetadata": { -"description": "Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchMetadata", +"GoogleCloudDiscoveryengineV1alphaUserInfo": { +"description": "Information of an end user.", +"id": "GoogleCloudDiscoveryengineV1alphaUserInfo", +"properties": { +"userAgent": { +"description": "User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set.", +"type": "string" +}, +"userId": { +"description": "Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata": { +"description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -14026,198 +14543,114 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchResponse": { -"description": "Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.", -"id": "GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchResponse", -"properties": {}, -"type": "object" -}, -"GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig": { -"description": "A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config.", -"id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig", +"GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesResponse": { +"description": "Response message for SiteSearchEngineService.BatchCreateTargetSites method.", +"id": "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesResponse", "properties": { -"chunkingConfig": { -"$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig", -"description": "Whether chunking mode is enabled." -}, -"defaultParsingConfig": { -"$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig", -"description": "Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing." -}, -"name": { -"description": "The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.", -"type": "string" -}, -"parsingConfigOverrides": { -"additionalProperties": { -"$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig" +"targetSites": { +"description": "TargetSites created.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaTargetSite" }, -"description": "Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported.", -"type": "object" +"type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig": { -"description": "Configuration for chunking config.", -"id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig", +"GoogleCloudDiscoveryengineV1betaCondition": { +"description": "Defines circumstances to be checked before allowing a behavior", +"id": "GoogleCloudDiscoveryengineV1betaCondition", "properties": { -"layoutBasedChunkingConfig": { -"$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", -"description": "Configuration for the layout based chunking." -} +"activeTimeRange": { +"description": "Range of time(s) specifying when condition is active. Maximum of 10 time ranges.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaConditionTimeRange" }, -"type": "object" +"type": "array" }, -"GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig": { -"description": "Configuration for the layout based chunking.", -"id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", -"properties": { -"chunkSize": { -"description": "The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.", -"format": "int32", -"type": "integer" +"queryTerms": { +"description": "Search only A list of terms to match the query on. Maximum of 10 query terms.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaConditionQueryTerm" }, -"includeAncestorHeadings": { -"description": "Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False.", -"type": "boolean" +"type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig": { -"description": "Related configurations applied to a specific type of document parser.", -"id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig", +"GoogleCloudDiscoveryengineV1betaConditionQueryTerm": { +"description": "Matcher for search request query", +"id": "GoogleCloudDiscoveryengineV1betaConditionQueryTerm", "properties": { -"digitalParsingConfig": { -"$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig", -"description": "Configurations applied to digital parser." -}, -"layoutParsingConfig": { -"$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig", -"description": "Configurations applied to layout parser." -}, -"ocrParsingConfig": { -"$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig", -"description": "Configurations applied to OCR parser. Currently it only applies to PDFs." -} -}, -"type": "object" -}, -"GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig": { -"description": "The digital parsing configurations for documents.", -"id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig", -"properties": {}, -"type": "object" -}, -"GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig": { -"description": "The layout parsing configurations for documents.", -"id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig", -"properties": {}, -"type": "object" +"fullMatch": { +"description": "Whether the search query needs to exactly match the query term.", +"type": "boolean" }, -"GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig": { -"description": "The OCR parsing configurations for documents.", -"id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig", -"properties": { -"enhancedDocumentElements": { -"deprecated": true, -"description": "[DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.", -"items": { +"value": { +"description": "The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters.", "type": "string" -}, -"type": "array" -}, -"useNativeText": { -"description": "If true, will use native text instead of OCR text on pages containing native text.", -"type": "boolean" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchMetadata": { -"description": "Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchMetadata", +"GoogleCloudDiscoveryengineV1betaConditionTimeRange": { +"description": "Used for time-dependent conditions.", +"id": "GoogleCloudDiscoveryengineV1betaConditionTimeRange", "properties": { -"createTime": { -"description": "Operation create time.", +"endTime": { +"description": "End of time range. Range is inclusive. Must be in the future.", "format": "google-datetime", "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", +"startTime": { +"description": "Start of time range. Range is inclusive.", "format": "google-datetime", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchResponse": { -"description": "Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.", -"id": "GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchResponse", -"properties": {}, -"type": "object" -}, -"GoogleCloudDiscoveryengineV1betaEngine": { -"description": "Metadata that describes the training and serving parameters of an Engine.", -"id": "GoogleCloudDiscoveryengineV1betaEngine", +"GoogleCloudDiscoveryengineV1betaControl": { +"description": "Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`.", +"id": "GoogleCloudDiscoveryengineV1betaControl", "properties": { -"chatEngineConfig": { -"$ref": "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig", -"description": "Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT." -}, -"chatEngineMetadata": { -"$ref": "GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata", -"description": "Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.", -"readOnly": true -}, -"commonConfig": { -"$ref": "GoogleCloudDiscoveryengineV1betaEngineCommonConfig", -"description": "Common config spec that specifies the metadata of the engine." +"associatedServingConfigIds": { +"description": "Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes.", +"items": { +"type": "string" }, -"createTime": { -"description": "Output only. Timestamp the Recommendation Engine was created at.", -"format": "google-datetime", "readOnly": true, -"type": "string" +"type": "array" }, -"dataStoreIds": { -"description": "The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.", +"boostAction": { +"$ref": "GoogleCloudDiscoveryengineV1betaControlBoostAction", +"description": "Defines a boost-type control" +}, +"conditions": { +"description": "Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown.", "items": { -"type": "string" +"$ref": "GoogleCloudDiscoveryengineV1betaCondition" }, "type": "array" }, "displayName": { -"description": "Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.", +"description": "Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown.", "type": "string" }, -"industryVertical": { -"description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore linked to the engine.", -"enum": [ -"INDUSTRY_VERTICAL_UNSPECIFIED", -"GENERIC", -"MEDIA", -"HEALTHCARE_FHIR" -], -"enumDescriptions": [ -"Value used when unset.", -"The generic vertical for documents that are not specific to any industry vertical.", -"The media industry vertical.", -"The healthcare FHIR vertical." -], -"type": "string" +"filterAction": { +"$ref": "GoogleCloudDiscoveryengineV1betaControlFilterAction", +"description": "Defines a filter-type control Currently not supported by Recommendation" }, "name": { -"description": "Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.", +"description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`", "type": "string" }, -"searchEngineConfig": { -"$ref": "GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig", -"description": "Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH." +"redirectAction": { +"$ref": "GoogleCloudDiscoveryengineV1betaControlRedirectAction", +"description": "Defines a redirect-type control." }, "solutionType": { -"description": "Required. The solutions of the engine.", +"description": "Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.", "enum": [ "SOLUTION_TYPE_UNSPECIFIED", "SOLUTION_TYPE_RECOMMENDATION", @@ -14234,475 +14667,1915 @@ ], "type": "string" }, -"updateTime": { -"description": "Output only. Timestamp the Recommendation Engine was last updated.", -"format": "google-datetime", -"readOnly": true, +"synonymsAction": { +"$ref": "GoogleCloudDiscoveryengineV1betaControlSynonymsAction", +"description": "Treats a group of terms as synonyms of one another." +}, +"useCases": { +"description": "Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH.", +"items": { +"enum": [ +"SEARCH_USE_CASE_UNSPECIFIED", +"SEARCH_USE_CASE_SEARCH", +"SEARCH_USE_CASE_BROWSE" +], +"enumDescriptions": [ +"Value used when unset. Will not occur in CSS.", +"Search use case. Expects the traffic has a non-empty query.", +"Browse use case. Expects the traffic has an empty query." +], "type": "string" +}, +"type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig": { -"description": "Configurations for a Chat Engine.", -"id": "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig", +"GoogleCloudDiscoveryengineV1betaControlBoostAction": { +"description": "Adjusts order of products in returned list.", +"id": "GoogleCloudDiscoveryengineV1betaControlBoostAction", "properties": { -"agentCreationConfig": { -"$ref": "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig", -"description": "The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation." +"boost": { +"description": "Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).", +"format": "float", +"type": "number" }, -"dialogflowAgentToLink": { -"description": "The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.", +"dataStore": { +"description": "Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store", +"type": "string" +}, +"filter": { +"description": "Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig": { -"description": "Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.", -"id": "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig", +"GoogleCloudDiscoveryengineV1betaControlFilterAction": { +"description": "Specified which products may be included in results. Uses same filter as boost.", +"id": "GoogleCloudDiscoveryengineV1betaControlFilterAction", "properties": { -"business": { -"description": "Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.", +"dataStore": { +"description": "Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store", "type": "string" }, -"defaultLanguageCode": { -"description": "Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes.", +"filter": { +"description": "Required. A filter to apply on the matching condition results. Required Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.", "type": "string" +} }, -"location": { -"description": "Agent location for Agent creation, supported values: global/us/eu. If not provided, us Engine will create Agent using us-central-1 by default; eu Engine will create Agent using eu-west-1 by default.", +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaControlRedirectAction": { +"description": "Redirects a shopper to the provided URI.", +"id": "GoogleCloudDiscoveryengineV1betaControlRedirectAction", +"properties": { +"redirectUri": { +"description": "Required. The URI to which the shopper will be redirected. Required. URI must have length equal or less than 2000 characters. Otherwise an INVALID ARGUMENT error is thrown.", "type": "string" +} }, -"timeZone": { -"description": "Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.", +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaControlSynonymsAction": { +"description": "Creates a set of terms that will act as synonyms of one another. Example: \"happy\" will also be considered as \"glad\", \"glad\" will also be considered as \"happy\".", +"id": "GoogleCloudDiscoveryengineV1betaControlSynonymsAction", +"properties": { +"synonyms": { +"description": "Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown.", +"items": { "type": "string" +}, +"type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata": { -"description": "Additional information of a Chat Engine. Fields in this message are output only.", -"id": "GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata", +"GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata": { +"description": "Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata", "properties": { -"dialogflowAgent": { -"description": "The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`.", +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaEngineCommonConfig": { -"description": "Common configurations for an Engine.", -"id": "GoogleCloudDiscoveryengineV1betaEngineCommonConfig", +"GoogleCloudDiscoveryengineV1betaCreateEngineMetadata": { +"description": "Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1betaCreateEngineMetadata", "properties": { -"companyName": { -"description": "The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.", +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig": { -"description": "Configurations for a Search Engine.", -"id": "GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig", +"GoogleCloudDiscoveryengineV1betaCreateEvaluationMetadata": { +"description": "Metadata for EvaluationService.CreateEvaluation method.", +"id": "GoogleCloudDiscoveryengineV1betaCreateEvaluationMetadata", +"properties": {}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata": { +"description": "Metadata for Create Schema LRO.", +"id": "GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata", "properties": { -"searchAddOns": { -"description": "The add-on that this search engine enables.", -"items": { -"enum": [ -"SEARCH_ADD_ON_UNSPECIFIED", -"SEARCH_ADD_ON_LLM" -], -"enumDescriptions": [ -"Default value when the enum is unspecified. This is invalid to use.", -"Large language model add-on." -], +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", "type": "string" }, -"type": "array" +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} }, -"searchTier": { -"description": "The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified.", +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaCreateTargetSiteMetadata": { +"description": "Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1betaCreateTargetSiteMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaCustomTuningModel": { +"description": "Metadata that describes a custom tuned model.", +"id": "GoogleCloudDiscoveryengineV1betaCustomTuningModel", +"properties": { +"createTime": { +"deprecated": true, +"description": "Timestamp the Model was created at.", +"format": "google-datetime", +"type": "string" +}, +"displayName": { +"description": "The display name of the model.", +"type": "string" +}, +"metrics": { +"additionalProperties": { +"format": "double", +"type": "number" +}, +"description": "The metrics of the trained model.", +"type": "object" +}, +"modelState": { +"description": "The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).", "enum": [ -"SEARCH_TIER_UNSPECIFIED", -"SEARCH_TIER_STANDARD", -"SEARCH_TIER_ENTERPRISE" +"MODEL_STATE_UNSPECIFIED", +"TRAINING_PAUSED", +"TRAINING", +"TRAINING_COMPLETE", +"READY_FOR_SERVING", +"TRAINING_FAILED", +"NO_IMPROVEMENT" ], "enumDescriptions": [ -"Default value when the enum is unspecified. This is invalid to use.", -"Standard tier.", -"Enterprise tier." +"Default value.", +"The model is in a paused training state.", +"The model is currently training.", +"The model has successfully completed training.", +"The model is ready for serving.", +"The model training failed.", +"The model training finished successfully but metrics did not improve." ], "type": "string" +}, +"modelVersion": { +"description": "The version of the model.", +"format": "int64", +"type": "string" +}, +"name": { +"description": "Required. The fully qualified resource name of the model. Format: `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}` model must be an alpha-numerical string with limit of 40 characters.", +"type": "string" +}, +"trainingStartTime": { +"description": "Timestamp the model training was initiated.", +"format": "google-datetime", +"type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsMetadata": { -"description": "Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsMetadata", +"GoogleCloudDiscoveryengineV1betaDataStore": { +"description": "DataStore captures global settings and configs at the DataStore level.", +"id": "GoogleCloudDiscoveryengineV1betaDataStore", "properties": { +"contentConfig": { +"description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", +"enum": [ +"CONTENT_CONFIG_UNSPECIFIED", +"NO_CONTENT", +"CONTENT_REQUIRED", +"PUBLIC_WEBSITE" +], +"enumDescriptions": [ +"Default value.", +"Only contains documents without any Document.content.", +"Only contains documents with Document.content.", +"The data store is used for public website search." +], +"type": "string" +}, "createTime": { -"description": "Operation create time.", +"description": "Output only. Timestamp the DataStore was created at.", "format": "google-datetime", +"readOnly": true, "type": "string" }, -"failureCount": { -"description": "Count of CompletionSuggestions that failed to be imported.", -"format": "int64", +"defaultSchemaId": { +"description": "Output only. The id of the default Schema asscociated to this data store.", +"readOnly": true, "type": "string" }, -"successCount": { -"description": "Count of CompletionSuggestions successfully imported.", -"format": "int64", +"displayName": { +"description": "Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.", "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"documentProcessingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig", +"description": "Configuration for Document understanding and enrichment." +}, +"industryVertical": { +"description": "Immutable. The industry vertical that the data store registers.", +"enum": [ +"INDUSTRY_VERTICAL_UNSPECIFIED", +"GENERIC", +"MEDIA", +"HEALTHCARE_FHIR" +], +"enumDescriptions": [ +"Value used when unset.", +"The generic vertical for documents that are not specific to any industry vertical.", +"The media industry vertical.", +"The healthcare FHIR vertical." +], +"type": "string" +}, +"languageInfo": { +"$ref": "GoogleCloudDiscoveryengineV1betaLanguageInfo", +"description": "Language info for DataStore." +}, +"name": { +"description": "Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"type": "string" +}, +"solutionTypes": { +"description": "The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.", +"items": { +"enum": [ +"SOLUTION_TYPE_UNSPECIFIED", +"SOLUTION_TYPE_RECOMMENDATION", +"SOLUTION_TYPE_SEARCH", +"SOLUTION_TYPE_CHAT", +"SOLUTION_TYPE_GENERATIVE_CHAT" +], +"enumDescriptions": [ +"Default value.", +"Used for Recommendations AI.", +"Used for Discovery Search.", +"Used for use cases related to the Generative AI agent.", +"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution." +], "type": "string" +}, +"type": "array" +}, +"startingSchema": { +"$ref": "GoogleCloudDiscoveryengineV1betaSchema", +"description": "The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema)." } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsResponse": { +"GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata": { +"description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaDeleteEngineMetadata": { +"description": "Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1betaDeleteEngineMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaDeleteSchemaMetadata": { +"description": "Metadata for DeleteSchema LRO.", +"id": "GoogleCloudDiscoveryengineV1betaDeleteSchemaMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaDeleteTargetSiteMetadata": { +"description": "Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1betaDeleteTargetSiteMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchMetadata": { +"description": "Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchResponse": { +"description": "Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.", +"id": "GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchResponse", +"properties": {}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig": { +"description": "A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config.", +"id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig", +"properties": { +"chunkingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig", +"description": "Whether chunking mode is enabled." +}, +"defaultParsingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig", +"description": "Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing." +}, +"name": { +"description": "The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.", +"type": "string" +}, +"parsingConfigOverrides": { +"additionalProperties": { +"$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig" +}, +"description": "Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported.", +"type": "object" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig": { +"description": "Configuration for chunking config.", +"id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig", +"properties": { +"layoutBasedChunkingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", +"description": "Configuration for the layout based chunking." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig": { +"description": "Configuration for the layout based chunking.", +"id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", +"properties": { +"chunkSize": { +"description": "The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.", +"format": "int32", +"type": "integer" +}, +"includeAncestorHeadings": { +"description": "Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False.", +"type": "boolean" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig": { +"description": "Related configurations applied to a specific type of document parser.", +"id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig", +"properties": { +"digitalParsingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig", +"description": "Configurations applied to digital parser." +}, +"layoutParsingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig", +"description": "Configurations applied to layout parser." +}, +"ocrParsingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig", +"description": "Configurations applied to OCR parser. Currently it only applies to PDFs." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig": { +"description": "The digital parsing configurations for documents.", +"id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig", +"properties": {}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig": { +"description": "The layout parsing configurations for documents.", +"id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig", +"properties": {}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig": { +"description": "The OCR parsing configurations for documents.", +"id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig", +"properties": { +"enhancedDocumentElements": { +"deprecated": true, +"description": "[DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.", +"items": { +"type": "string" +}, +"type": "array" +}, +"useNativeText": { +"description": "If true, will use native text instead of OCR text on pages containing native text.", +"type": "boolean" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchMetadata": { +"description": "Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchResponse": { +"description": "Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.", +"id": "GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchResponse", +"properties": {}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaEngine": { +"description": "Metadata that describes the training and serving parameters of an Engine.", +"id": "GoogleCloudDiscoveryengineV1betaEngine", +"properties": { +"chatEngineConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig", +"description": "Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT." +}, +"chatEngineMetadata": { +"$ref": "GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata", +"description": "Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.", +"readOnly": true +}, +"commonConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaEngineCommonConfig", +"description": "Common config spec that specifies the metadata of the engine." +}, +"createTime": { +"description": "Output only. Timestamp the Recommendation Engine was created at.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"dataStoreIds": { +"description": "The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.", +"items": { +"type": "string" +}, +"type": "array" +}, +"displayName": { +"description": "Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.", +"type": "string" +}, +"industryVertical": { +"description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore linked to the engine.", +"enum": [ +"INDUSTRY_VERTICAL_UNSPECIFIED", +"GENERIC", +"MEDIA", +"HEALTHCARE_FHIR" +], +"enumDescriptions": [ +"Value used when unset.", +"The generic vertical for documents that are not specific to any industry vertical.", +"The media industry vertical.", +"The healthcare FHIR vertical." +], +"type": "string" +}, +"name": { +"description": "Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.", +"type": "string" +}, +"searchEngineConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig", +"description": "Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH." +}, +"solutionType": { +"description": "Required. The solutions of the engine.", +"enum": [ +"SOLUTION_TYPE_UNSPECIFIED", +"SOLUTION_TYPE_RECOMMENDATION", +"SOLUTION_TYPE_SEARCH", +"SOLUTION_TYPE_CHAT", +"SOLUTION_TYPE_GENERATIVE_CHAT" +], +"enumDescriptions": [ +"Default value.", +"Used for Recommendations AI.", +"Used for Discovery Search.", +"Used for use cases related to the Generative AI agent.", +"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution." +], +"type": "string" +}, +"updateTime": { +"description": "Output only. Timestamp the Recommendation Engine was last updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig": { +"description": "Configurations for a Chat Engine.", +"id": "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig", +"properties": { +"agentCreationConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig", +"description": "The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation." +}, +"dialogflowAgentToLink": { +"description": "The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig": { +"description": "Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.", +"id": "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig", +"properties": { +"business": { +"description": "Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.", +"type": "string" +}, +"defaultLanguageCode": { +"description": "Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes.", +"type": "string" +}, +"location": { +"description": "Agent location for Agent creation, supported values: global/us/eu. If not provided, us Engine will create Agent using us-central-1 by default; eu Engine will create Agent using eu-west-1 by default.", +"type": "string" +}, +"timeZone": { +"description": "Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata": { +"description": "Additional information of a Chat Engine. Fields in this message are output only.", +"id": "GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata", +"properties": { +"dialogflowAgent": { +"description": "The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaEngineCommonConfig": { +"description": "Common configurations for an Engine.", +"id": "GoogleCloudDiscoveryengineV1betaEngineCommonConfig", +"properties": { +"companyName": { +"description": "The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig": { +"description": "Configurations for a Search Engine.", +"id": "GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig", +"properties": { +"searchAddOns": { +"description": "The add-on that this search engine enables.", +"items": { +"enum": [ +"SEARCH_ADD_ON_UNSPECIFIED", +"SEARCH_ADD_ON_LLM" +], +"enumDescriptions": [ +"Default value when the enum is unspecified. This is invalid to use.", +"Large language model add-on." +], +"type": "string" +}, +"type": "array" +}, +"searchTier": { +"description": "The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified.", +"enum": [ +"SEARCH_TIER_UNSPECIFIED", +"SEARCH_TIER_STANDARD", +"SEARCH_TIER_ENTERPRISE" +], +"enumDescriptions": [ +"Default value when the enum is unspecified. This is invalid to use.", +"Standard tier.", +"Enterprise tier." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaEvaluation": { +"description": "An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data.", +"id": "GoogleCloudDiscoveryengineV1betaEvaluation", +"properties": { +"createTime": { +"description": "Output only. Timestamp the Evaluation was created at.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"endTime": { +"description": "Output only. Timestamp the Evaluation was completed at.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"error": { +"$ref": "GoogleRpcStatus", +"description": "Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED.", +"readOnly": true +}, +"errorSamples": { +"description": "Output only. A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"readOnly": true, +"type": "array" +}, +"evaluationSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec", +"description": "Required. The specification of the evaluation." +}, +"name": { +"description": "Immutable. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"type": "string" +}, +"qualityMetrics": { +"$ref": "GoogleCloudDiscoveryengineV1betaQualityMetrics", +"description": "Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet. Only populated when the evaluation's state is SUCCEEDED.", +"readOnly": true +}, +"state": { +"description": "Output only. The state of the evaluation.", +"enum": [ +"STATE_UNSPECIFIED", +"PENDING", +"RUNNING", +"SUCCEEDED", +"FAILED" +], +"enumDescriptions": [ +"The evaluation is unspecified.", +"The service is preparing to run the evaluation.", +"The evaluation is in progress.", +"The evaluation completed successfully.", +"The evaluation failed." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec": { +"description": "Describes the specification of the evaluation.", +"id": "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec", +"properties": { +"querySetSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec", +"description": "Required. The specification of the query set." +}, +"searchRequest": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequest", +"description": "Required. The search request that is used to perform the evaluation. Only the following fields within SearchRequest are supported; if any other fields are provided, an UNSUPPORTED error will be returned: * SearchRequest.serving_config * SearchRequest.branch * SearchRequest.canonical_filter * SearchRequest.query_expansion_spec * SearchRequest.spell_correction_spec * SearchRequest.content_search_spec * SearchRequest.user_pseudo_id" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec": { +"description": "Describes the specification of the query set.", +"id": "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec", +"properties": { +"sampleQuerySet": { +"description": "Required. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsMetadata": { +"description": "Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"failureCount": { +"description": "Count of CompletionSuggestions that failed to be imported.", +"format": "int64", +"type": "string" +}, +"successCount": { +"description": "Count of CompletionSuggestions successfully imported.", +"format": "int64", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsResponse": { "description": "Response of the CompletionService.ImportCompletionSuggestions method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.", "id": "GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsResponse", "properties": { -"errorConfig": { -"$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", -"description": "The desired location of errors incurred during the Import." +"errorConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", +"description": "The desired location of errors incurred during the Import." +}, +"errorSamples": { +"description": "A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata": { +"description": "Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"failureCount": { +"description": "Count of entries that encountered errors while processing.", +"format": "int64", +"type": "string" +}, +"successCount": { +"description": "Count of entries that were processed successfully.", +"format": "int64", +"type": "string" +}, +"totalCount": { +"description": "Total count of entries that were processed.", +"format": "int64", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaImportDocumentsResponse": { +"description": "Response of the ImportDocumentsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", +"id": "GoogleCloudDiscoveryengineV1betaImportDocumentsResponse", +"properties": { +"errorConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", +"description": "Echoes the destination for the complete errors in the request if set." +}, +"errorSamples": { +"description": "A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaImportErrorConfig": { +"description": "Configuration of destination for Import related errors.", +"id": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", +"properties": { +"gcsPrefix": { +"description": "Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaImportSampleQueriesMetadata": { +"description": "Metadata related to the progress of the ImportSampleQueries operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1betaImportSampleQueriesMetadata", +"properties": { +"createTime": { +"description": "ImportSampleQueries operation create time.", +"format": "google-datetime", +"type": "string" +}, +"failureCount": { +"description": "Count of SampleQuerys that failed to be imported.", +"format": "int64", +"type": "string" +}, +"successCount": { +"description": "Count of SampleQuerys successfully imported.", +"format": "int64", +"type": "string" +}, +"totalCount": { +"description": "Total count of SampleQuerys that were processed.", +"format": "int64", +"type": "string" +}, +"updateTime": { +"description": "ImportSampleQueries operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaImportSampleQueriesResponse": { +"description": "Response of the SampleQueryService.ImportSampleQueries method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.", +"id": "GoogleCloudDiscoveryengineV1betaImportSampleQueriesResponse", +"properties": { +"errorConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", +"description": "The desired location of errors incurred during the Import." +}, +"errorSamples": { +"description": "A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesMetadata": { +"description": "Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesResponse": { +"description": "Response message for CompletionService.ImportSuggestionDenyListEntries method.", +"id": "GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesResponse", +"properties": { +"errorSamples": { +"description": "A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"type": "array" +}, +"failedEntriesCount": { +"description": "Count of deny list entries that failed to be imported.", +"format": "int64", +"type": "string" +}, +"importedEntriesCount": { +"description": "Count of deny list entries successfully imported.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaImportUserEventsMetadata": { +"description": "Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1betaImportUserEventsMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"failureCount": { +"description": "Count of entries that encountered errors while processing.", +"format": "int64", +"type": "string" +}, +"successCount": { +"description": "Count of entries that were processed successfully.", +"format": "int64", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaImportUserEventsResponse": { +"description": "Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", +"id": "GoogleCloudDiscoveryengineV1betaImportUserEventsResponse", +"properties": { +"errorConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", +"description": "Echoes the destination for the complete errors if this field was set in the request." +}, +"errorSamples": { +"description": "A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"type": "array" +}, +"joinedEventsCount": { +"description": "Count of user events imported with complete existing Documents.", +"format": "int64", +"type": "string" +}, +"unjoinedEventsCount": { +"description": "Count of user events imported, but with Document information not found in the existing Branch.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaInterval": { +"description": "A floating point interval.", +"id": "GoogleCloudDiscoveryengineV1betaInterval", +"properties": { +"exclusiveMaximum": { +"description": "Exclusive upper bound.", +"format": "double", +"type": "number" +}, +"exclusiveMinimum": { +"description": "Exclusive lower bound.", +"format": "double", +"type": "number" +}, +"maximum": { +"description": "Inclusive upper bound.", +"format": "double", +"type": "number" +}, +"minimum": { +"description": "Inclusive lower bound.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaLanguageInfo": { +"description": "Language info for DataStore.", +"id": "GoogleCloudDiscoveryengineV1betaLanguageInfo", +"properties": { +"language": { +"description": "Output only. Language part of normalized_language_code. E.g.: `en-US` -> `en`, `zh-Hans-HK` -> `zh`, `en` -> `en`.", +"readOnly": true, +"type": "string" +}, +"languageCode": { +"description": "The language code for the DataStore.", +"type": "string" +}, +"normalizedLanguageCode": { +"description": "Output only. This is the normalized form of language_code. E.g.: language_code of `en-GB`, `en_GB`, `en-UK` or `en-gb` will have normalized_language_code of `en-GB`.", +"readOnly": true, +"type": "string" +}, +"region": { +"description": "Output only. Region part of normalized_language_code, if present. E.g.: `en-US` -> `US`, `zh-Hans-HK` -> `HK`, `en` -> ``.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaListCustomModelsResponse": { +"description": "Response message for SearchTuningService.ListCustomModels method.", +"id": "GoogleCloudDiscoveryengineV1betaListCustomModelsResponse", +"properties": { +"models": { +"description": "List of custom tuning models.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaCustomTuningModel" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaProject": { +"description": "Metadata and configurations for a Google Cloud project in the service.", +"id": "GoogleCloudDiscoveryengineV1betaProject", +"properties": { +"createTime": { +"description": "Output only. The timestamp when this project is created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Output only. Full resource name of the project, for example `projects/{project_number}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.", +"readOnly": true, +"type": "string" +}, +"provisionCompletionTime": { +"description": "Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"serviceTermsMap": { +"additionalProperties": { +"$ref": "GoogleCloudDiscoveryengineV1betaProjectServiceTerms" +}, +"description": "Output only. A map of terms of services. The key is the `id` of ServiceTerms.", +"readOnly": true, +"type": "object" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaProjectServiceTerms": { +"description": "Metadata about the terms of service.", +"id": "GoogleCloudDiscoveryengineV1betaProjectServiceTerms", +"properties": { +"acceptTime": { +"description": "The last time when the project agreed to the terms of service.", +"format": "google-datetime", +"type": "string" +}, +"declineTime": { +"description": "The last time when the project declined or revoked the agreement to terms of service.", +"format": "google-datetime", +"type": "string" +}, +"id": { +"description": "The unique identifier of this terms of service. Available terms: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this as `id`, the acceptable version to provide is `2022-11-23`.", +"type": "string" +}, +"state": { +"description": "Whether the project has accepted/rejected the service terms or it is still pending.", +"enum": [ +"STATE_UNSPECIFIED", +"TERMS_ACCEPTED", +"TERMS_PENDING", +"TERMS_DECLINED" +], +"enumDescriptions": [ +"The default value of the enum. This value is not actually used.", +"The project has given consent to the terms of service.", +"The project is pending to review and accept the terms of service.", +"The project has declined or revoked the agreement to terms of service." +], +"type": "string" +}, +"version": { +"description": "The version string of the terms of service. For acceptable values, see the comments for id above.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaProvisionProjectMetadata": { +"description": "Metadata associated with a project provision operation.", +"id": "GoogleCloudDiscoveryengineV1betaProvisionProjectMetadata", +"properties": {}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata": { +"description": "Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"failureCount": { +"description": "Count of entries that encountered errors while processing.", +"format": "int64", +"type": "string" +}, +"ignoredCount": { +"description": "Count of entries that were ignored as entries were not found.", +"format": "int64", +"type": "string" +}, +"successCount": { +"description": "Count of entries that were deleted successfully.", +"format": "int64", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse": { +"description": "Response message for DocumentService.PurgeDocuments method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.", +"id": "GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse", +"properties": { +"purgeCount": { +"description": "The total count of documents purged as a result of the operation.", +"format": "int64", +"type": "string" +}, +"purgeSample": { +"description": "A sample of document names that will be deleted. Only populated if `force` is set to false. A max of 100 names will be returned and the names are chosen at random.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesMetadata": { +"description": "Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesResponse": { +"description": "Response message for CompletionService.PurgeSuggestionDenyListEntries method.", +"id": "GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesResponse", +"properties": { +"errorSamples": { +"description": "A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"type": "array" +}, +"purgeCount": { +"description": "Number of suggestion deny list entries purged.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaQualityMetrics": { +"description": "Describes the metrics produced by the evaluation.", +"id": "GoogleCloudDiscoveryengineV1betaQualityMetrics", +"properties": { +"docNdcg": { +"$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", +"description": "Normalized discounted cumulative gain (NDCG) per document, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved documents (D1, D2, D3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [D3 (0), D1 (1), D2 (1)] Ideal: [D1 (1), D2 (1), D3 (0)] Calculate NDCG@3 for each SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693" +}, +"docPrecision": { +"$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", +"description": "Precision per document, at various top-k cutoff levels. Precision is the fraction of retrieved documents that are relevant. Example (top-5): * For a single SampleQuery, If 4 out of 5 retrieved documents in the top-5 are relevant, precision@5 = 4/5 = 0.8" +}, +"docRecall": { +"$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", +"description": "Recall per document, at various top-k cutoff levels. Recall is the fraction of relevant documents retrieved out of all relevant documents. Example (top-5): * For a single SampleQuery, If 3 out of 5 relevant documents are retrieved in the top-5, recall@5 = 3/5 = 0.6" +}, +"pageNdcg": { +"$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", +"description": "Normalized discounted cumulative gain (NDCG) per page, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved pages (P1, P2, P3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [P3 (0), P1 (1), P2 (1)] Ideal: [P1 (1), P2 (1), P3 (0)] Calculate NDCG@3 for SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693" +}, +"pageRecall": { +"$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", +"description": "Recall per page, at various top-k cutoff levels. Recall is the fraction of relevant pages retrieved out of all relevant pages. Example (top-5): * For a single SampleQuery, if 3 out of 5 relevant pages are retrieved in the top-5, recall@5 = 3/5 = 0.6" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics": { +"description": "Stores the metric values at specific top-k levels.", +"id": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", +"properties": { +"top1": { +"description": "The top-1 value.", +"format": "double", +"type": "number" +}, +"top10": { +"description": "The top-10 value.", +"format": "double", +"type": "number" +}, +"top3": { +"description": "The top-3 value.", +"format": "double", +"type": "number" +}, +"top5": { +"description": "The top-5 value.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSchema": { +"description": "Defines the structure and layout of a type of document data.", +"id": "GoogleCloudDiscoveryengineV1betaSchema", +"properties": { +"jsonSchema": { +"description": "The JSON representation of the schema.", +"type": "string" +}, +"name": { +"description": "Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"type": "string" +}, +"structSchema": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "The structured representation of the schema.", +"type": "object" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSearchRequest": { +"description": "Request message for SearchService.Search method.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequest", +"properties": { +"boostSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec", +"description": "Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)" +}, +"branch": { +"description": "The branch resource name, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Use `default_branch` as the branch ID or leave this field empty, to search documents under the default branch.", +"type": "string" +}, +"canonicalFilter": { +"description": "The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about filter syntax, see SearchRequest.filter.", +"type": "string" +}, +"contentSearchSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec", +"description": "A specification for configuring the behavior of content search." +}, +"dataStoreSpecs": { +"description": "Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec" +}, +"type": "array" +}, +"embeddingSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec", +"description": "Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path." +}, +"facetSpecs": { +"description": "Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec" +}, +"type": "array" +}, +"filter": { +"description": "The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY(\"king kong\")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)", +"type": "string" +}, +"imageQuery": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery", +"description": "Raw image query." +}, +"languageCode": { +"description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.", +"type": "string" +}, +"naturalLanguageQueryUnderstandingSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec", +"description": "If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done." +}, +"offset": { +"description": "A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.", +"format": "int32", +"type": "integer" +}, +"orderBy": { +"description": "The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering for retail search, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.", +"type": "string" +}, +"pageSize": { +"description": "Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.", +"format": "int32", +"type": "integer" +}, +"pageToken": { +"description": "A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"type": "string" +}, +"params": { +"additionalProperties": { +"type": "any" +}, +"description": "Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. For example, `user_country_code: \"au\"` For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example, `search_type: 1`", +"type": "object" +}, +"query": { +"description": "Raw search query.", +"type": "string" +}, +"queryExpansionSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec", +"description": "The query expansion specification that specifies the conditions under which query expansion occurs." +}, +"rankingExpression": { +"description": "The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The ranking expression is a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.", +"type": "string" +}, +"regionCode": { +"description": "The Unicode country/region code (CLDR) of a location, such as \"US\" and \"419\". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.", +"type": "string" +}, +"safeSearch": { +"description": "Whether to turn on safe search. This is only supported for website search.", +"type": "boolean" +}, +"searchAsYouTypeSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec", +"description": "Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical." +}, +"servingConfig": { +"description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.", +"type": "string" +}, +"session": { +"description": "The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is \"How did Alphabet do in 2022?\" and the current query is \"How about 2023?\", the current query will be interpreted as \"How did Alphabet do in 2023?\". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.", +"type": "string" +}, +"sessionSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec", +"description": "Session specification. Can be used only when `session` is set." +}, +"spellCorrectionSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec", +"description": "The spell correction specification that specifies the mode under which spell correction takes effect." +}, +"userInfo": { +"$ref": "GoogleCloudDiscoveryengineV1betaUserInfo", +"description": "Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics." +}, +"userLabels": { +"additionalProperties": { +"type": "string" +}, +"description": "The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * 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. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.", +"type": "object" +}, +"userPseudoId": { +"description": "A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec": { +"description": "Boost specification to boost certain documents.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec", +"properties": { +"conditionBoostSpecs": { +"description": "Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec": { +"description": "Boost applies to documents which match a condition.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec", +"properties": { +"boost": { +"description": "Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied.", +"format": "float", +"type": "number" }, -"errorSamples": { -"description": "A sample of errors encountered while processing the request.", -"items": { -"$ref": "GoogleRpcStatus" +"boostControlSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec", +"description": "Complex specification for custom ranking based on customer defined attribute value." }, -"type": "array" +"condition": { +"description": "An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID \"doc_1\" or \"doc_2\", and color \"Red\" or \"Blue\": `(document_id: ANY(\"doc_1\", \"doc_2\")) AND (color: ANY(\"Red\", \"Blue\"))`", +"type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata": { -"description": "Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata", +"GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec": { +"description": "Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"attributeType": { +"description": "The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).", +"enum": [ +"ATTRIBUTE_TYPE_UNSPECIFIED", +"NUMERICAL", +"FRESHNESS" +], +"enumDescriptions": [ +"Unspecified AttributeType.", +"The value of the numerical field will be used to dynamically update the boost amount. In this case, the attribute_value (the x value) of the control point will be the actual value of the numerical field for which the boost_amount is specified.", +"For the freshness use case the attribute value will be the duration between the current time and the date in the datetime field specified. The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. For example, `5D`, `3DT12H30M`, `T24H`." +], "type": "string" }, -"failureCount": { -"description": "Count of entries that encountered errors while processing.", -"format": "int64", -"type": "string" +"controlPoints": { +"description": "The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint" }, -"successCount": { -"description": "Count of entries that were processed successfully.", -"format": "int64", -"type": "string" +"type": "array" }, -"totalCount": { -"description": "Total count of entries that were processed.", -"format": "int64", +"fieldName": { +"description": "The name of the field whose value will be used to determine the boost amount.", "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"interpolationType": { +"description": "The interpolation type to be applied to connect the control points listed below.", +"enum": [ +"INTERPOLATION_TYPE_UNSPECIFIED", +"LINEAR" +], +"enumDescriptions": [ +"Interpolation type is unspecified. In this case, it defaults to Linear.", +"Piecewise linear interpolation will be applied." +], "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaImportDocumentsResponse": { -"description": "Response of the ImportDocumentsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", -"id": "GoogleCloudDiscoveryengineV1betaImportDocumentsResponse", +"GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint": { +"description": "The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint", "properties": { -"errorConfig": { -"$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", -"description": "Echoes the destination for the complete errors in the request if set." -}, -"errorSamples": { -"description": "A sample of errors encountered while processing the request.", -"items": { -"$ref": "GoogleRpcStatus" +"attributeValue": { +"description": "Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.", +"type": "string" }, -"type": "array" +"boostAmount": { +"description": "The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.", +"format": "float", +"type": "number" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaImportErrorConfig": { -"description": "Configuration of destination for Import related errors.", -"id": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", +"GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec": { +"description": "A specification for configuring the behavior of content search.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec", "properties": { -"gcsPrefix": { -"description": "Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.", +"chunkSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec", +"description": "Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS" +}, +"extractiveContentSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec", +"description": "If there is no extractive_content_spec provided, there will be no extractive answer in the search response." +}, +"searchResultMode": { +"description": "Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.", +"enum": [ +"SEARCH_RESULT_MODE_UNSPECIFIED", +"DOCUMENTS", +"CHUNKS" +], +"enumDescriptions": [ +"Default value.", +"Returns documents in the search result.", +"Returns chunks in the search result. Only available if the DataStore.DocumentProcessingConfig.chunking_config is specified." +], "type": "string" +}, +"snippetSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec", +"description": "If `snippetSpec` is not specified, snippets are not included in the search response." +}, +"summarySpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec", +"description": "If `summarySpec` is not specified, summaries are not included in the search response." } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesMetadata": { -"description": "Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesMetadata", +"GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec": { +"description": "Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", -"type": "string" +"numNextChunks": { +"description": "The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned.", +"format": "int32", +"type": "integer" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", -"type": "string" +"numPreviousChunks": { +"description": "The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned.", +"format": "int32", +"type": "integer" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesResponse": { -"description": "Response message for CompletionService.ImportSuggestionDenyListEntries method.", -"id": "GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesResponse", +"GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec": { +"description": "A specification for configuring the extractive content in a search response.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec", "properties": { -"errorSamples": { -"description": "A sample of errors encountered while processing the request.", -"items": { -"$ref": "GoogleRpcStatus" +"maxExtractiveAnswerCount": { +"description": "The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult.", +"format": "int32", +"type": "integer" }, -"type": "array" +"maxExtractiveSegmentCount": { +"description": "The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`.", +"format": "int32", +"type": "integer" }, -"failedEntriesCount": { -"description": "Count of deny list entries that failed to be imported.", -"format": "int64", -"type": "string" +"numNextSegments": { +"description": "Return at most `num_next_segments` segments after each selected segments.", +"format": "int32", +"type": "integer" }, -"importedEntriesCount": { -"description": "Count of deny list entries successfully imported.", -"format": "int64", -"type": "string" +"numPreviousSegments": { +"description": "Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.", +"format": "int32", +"type": "integer" +}, +"returnExtractiveSegmentScore": { +"description": "Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`.", +"type": "boolean" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaImportUserEventsMetadata": { -"description": "Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1betaImportUserEventsMetadata", +"GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec": { +"description": "A specification for configuring snippets in a search response.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", -"type": "string" -}, -"failureCount": { -"description": "Count of entries that encountered errors while processing.", -"format": "int64", -"type": "string" +"maxSnippetCount": { +"deprecated": true, +"description": "[DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0.", +"format": "int32", +"type": "integer" }, -"successCount": { -"description": "Count of entries that were processed successfully.", -"format": "int64", -"type": "string" +"referenceOnly": { +"deprecated": true, +"description": "[DEPRECATED] This field is deprecated and will have no affect on the snippet.", +"type": "boolean" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", -"type": "string" +"returnSnippet": { +"description": "If `true`, then return snippet. If no snippet can be generated, we return \"No snippet is available for this page.\" A `snippet_status` with `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned.", +"type": "boolean" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaImportUserEventsResponse": { -"description": "Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", -"id": "GoogleCloudDiscoveryengineV1betaImportUserEventsResponse", +"GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec": { +"description": "A specification for configuring a summary returned in a search response.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec", "properties": { -"errorConfig": { -"$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", -"description": "Echoes the destination for the complete errors if this field was set in the request." +"ignoreAdversarialQuery": { +"description": "Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead.", +"type": "boolean" }, -"errorSamples": { -"description": "A sample of errors encountered while processing the request.", -"items": { -"$ref": "GoogleRpcStatus" +"ignoreNonSummarySeekingQuery": { +"description": "Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead.", +"type": "boolean" }, -"type": "array" +"includeCitations": { +"description": "Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results.", +"type": "boolean" }, -"joinedEventsCount": { -"description": "Count of user events imported with complete existing Documents.", -"format": "int64", +"languageCode": { +"description": "Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.", "type": "string" }, -"unjoinedEventsCount": { -"description": "Count of user events imported, but with Document information not found in the existing Branch.", -"format": "int64", -"type": "string" +"modelPromptSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec", +"description": "If specified, the spec will be used to modify the prompt provided to the LLM." +}, +"modelSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec", +"description": "If specified, the spec will be used to modify the model specification provided to the LLM." +}, +"summaryResultCount": { +"description": "The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.", +"format": "int32", +"type": "integer" +}, +"useSemanticChunks": { +"description": "If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list.", +"type": "boolean" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaLanguageInfo": { -"description": "Language info for DataStore.", -"id": "GoogleCloudDiscoveryengineV1betaLanguageInfo", +"GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec": { +"description": "Specification of the prompt to use with the model.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec", "properties": { -"language": { -"description": "Output only. Language part of normalized_language_code. E.g.: `en-US` -> `en`, `zh-Hans-HK` -> `zh`, `en` -> `en`.", -"readOnly": true, +"preamble": { +"description": "Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide.", "type": "string" +} }, -"languageCode": { -"description": "The language code for the DataStore.", -"type": "string" +"type": "object" }, -"normalizedLanguageCode": { -"description": "Output only. This is the normalized form of language_code. E.g.: language_code of `en-GB`, `en_GB`, `en-UK` or `en-gb` will have normalized_language_code of `en-GB`.", -"readOnly": true, +"GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec": { +"description": "Specification of the model.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec", +"properties": { +"version": { +"description": "The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). * `preview`: string. (Public preview) Uses a preview model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).", "type": "string" +} }, -"region": { -"description": "Output only. Region part of normalized_language_code, if present. E.g.: `en-US` -> `US`, `zh-Hans-HK` -> `HK`, `en` -> ``.", -"readOnly": true, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec": { +"description": "A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec", +"properties": { +"dataStore": { +"description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaListCustomModelsResponse": { -"description": "Response message for SearchTuningService.ListCustomModels method.", -"id": "GoogleCloudDiscoveryengineV1betaListCustomModelsResponse", +"GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec": { +"description": "The specification that uses customized query embedding vector to do semantic document retrieval.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec", "properties": { -"models": { -"description": "List of custom tuning models.", +"embeddingVectors": { +"description": "The embedding vector used for retrieval. Limit to 1.", "items": { -"$ref": "GoogleCloudDiscoveryengineV1betaCustomTuningModel" +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector" }, "type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaProject": { -"description": "Metadata and configurations for a Google Cloud project in the service.", -"id": "GoogleCloudDiscoveryengineV1betaProject", +"GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector": { +"description": "Embedding vector.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector", "properties": { -"createTime": { -"description": "Output only. The timestamp when this project is created.", -"format": "google-datetime", -"readOnly": true, -"type": "string" -}, -"name": { -"description": "Output only. Full resource name of the project, for example `projects/{project_number}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.", -"readOnly": true, -"type": "string" -}, -"provisionCompletionTime": { -"description": "Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use.", -"format": "google-datetime", -"readOnly": true, +"fieldPath": { +"description": "Embedding field path in schema.", "type": "string" }, -"serviceTermsMap": { -"additionalProperties": { -"$ref": "GoogleCloudDiscoveryengineV1betaProjectServiceTerms" +"vector": { +"description": "Query embedding vector.", +"items": { +"format": "float", +"type": "number" }, -"description": "Output only. A map of terms of services. The key is the `id` of ServiceTerms.", -"readOnly": true, -"type": "object" +"type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaProjectServiceTerms": { -"description": "Metadata about the terms of service.", -"id": "GoogleCloudDiscoveryengineV1betaProjectServiceTerms", +"GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec": { +"description": "A facet specification to perform faceted search.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec", "properties": { -"acceptTime": { -"description": "The last time when the project agreed to the terms of service.", -"format": "google-datetime", -"type": "string" +"enableDynamicPosition": { +"description": "Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * \"rating\", enable_dynamic_position = true * \"price\", enable_dynamic_position = false * \"brands\", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be (\"price\", \"brands\", \"rating\", \"gender\") or (\"price\", \"brands\", \"gender\", \"rating\") depends on how API orders \"gender\" and \"rating\" facets. However, notice that \"price\" and \"brands\" are always ranked at first and second position because their enable_dynamic_position is false.", +"type": "boolean" }, -"declineTime": { -"description": "The last time when the project declined or revoked the agreement to terms of service.", -"format": "google-datetime", +"excludedFilterKeys": { +"description": "List of keys to exclude when faceting. By default, FacetKey.key is not excluded from the filter unless it is listed in this field. Listing a facet key in this field allows its values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned. For example, suppose there are 100 documents with the color facet \"Red\" and 200 documents with the color facet \"Blue\". A query containing the filter \"color:ANY(\"Red\")\" and having \"color\" as FacetKey.key would by default return only \"Red\" documents in the search results, and also return \"Red\" with count 100 as the only color facet. Although there are also blue documents available, \"Blue\" would not be shown as an available facet value. If \"color\" is listed in \"excludedFilterKeys\", then the query returns the facet values \"Red\" with count 100 and \"Blue\" with count 200, because the \"color\" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly filtered to return only \"Red\" documents. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"items": { "type": "string" }, -"id": { -"description": "The unique identifier of this terms of service. Available terms: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this as `id`, the acceptable version to provide is `2022-11-23`.", -"type": "string" +"type": "array" }, -"state": { -"description": "Whether the project has accepted/rejected the service terms or it is still pending.", -"enum": [ -"STATE_UNSPECIFIED", -"TERMS_ACCEPTED", -"TERMS_PENDING", -"TERMS_DECLINED" -], -"enumDescriptions": [ -"The default value of the enum. This value is not actually used.", -"The project has given consent to the terms of service.", -"The project is pending to review and accept the terms of service.", -"The project has declined or revoked the agreement to terms of service." -], -"type": "string" +"facetKey": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey", +"description": "Required. The facet key specification." }, -"version": { -"description": "The version string of the terms of service. For acceptable values, see the comments for id above.", -"type": "string" +"limit": { +"description": "Maximum facet values that are returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. For aggregation in healthcare search, when the [FacetKey.key] is \"healthcare_aggregation_key\", the limit will be overridden to 10,000 internally, regardless of the value set here. If this field is negative, an `INVALID_ARGUMENT` is returned.", +"format": "int32", +"type": "integer" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaProvisionProjectMetadata": { -"description": "Metadata associated with a project provision operation.", -"id": "GoogleCloudDiscoveryengineV1betaProvisionProjectMetadata", -"properties": {}, -"type": "object" -}, -"GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata": { -"description": "Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata", +"GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey": { +"description": "Specifies how a facet is computed.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"caseInsensitive": { +"description": "True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.", +"type": "boolean" +}, +"contains": { +"description": "Only get facet values that contain the given strings. For example, suppose \"category\" has three values \"Action > 2022\", \"Action > 2021\" and \"Sci-Fi > 2022\". If set \"contains\" to \"2022\", the \"category\" facet only contains \"Action > 2022\" and \"Sci-Fi > 2022\". Only supported on textual fields. Maximum is 10.", +"items": { "type": "string" }, -"failureCount": { -"description": "Count of entries that encountered errors while processing.", -"format": "int64", +"type": "array" +}, +"intervals": { +"description": "Set only if values should be bucketed into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaInterval" +}, +"type": "array" +}, +"key": { +"description": "Required. Supported textual and numerical facet keys in Document object, over which the facet values are computed. Facet key is case-sensitive.", "type": "string" }, -"ignoredCount": { -"description": "Count of entries that were ignored as entries were not found.", -"format": "int64", +"orderBy": { +"description": "The order in which documents are returned. Allowed values are: * \"count desc\", which means order by SearchResponse.Facet.values.count descending. * \"value desc\", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets. If not set, textual values are sorted in [natural order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals.", "type": "string" }, -"successCount": { -"description": "Count of entries that were deleted successfully.", -"format": "int64", +"prefixes": { +"description": "Only get facet values that start with the given string prefix. For example, suppose \"category\" has three values \"Action > 2022\", \"Action > 2021\" and \"Sci-Fi > 2022\". If set \"prefixes\" to \"Action\", the \"category\" facet only contains \"Action > 2022\" and \"Action > 2021\". Only supported on textual fields. Maximum is 10.", +"items": { "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"type": "array" +}, +"restrictedValues": { +"description": "Only get facet for the given restricted values. Only supported on textual fields. For example, suppose \"category\" has three values \"Action > 2022\", \"Action > 2021\" and \"Sci-Fi > 2022\". If set \"restricted_values\" to \"Action > 2022\", the \"category\" facet only contains \"Action > 2022\". Only supported on textual fields. Maximum is 10.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery": { +"description": "Specifies the image query input.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery", +"properties": { +"imageBytes": { +"description": "Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse": { -"description": "Response message for DocumentService.PurgeDocuments method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.", -"id": "GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse", +"GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec": { +"description": "Specification to enable natural language understanding capabilities for search requests.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec", "properties": { -"purgeCount": { -"description": "The total count of documents purged as a result of the operation.", -"format": "int64", +"filterExtractionCondition": { +"description": "The condition under which filter extraction should occur. Default to Condition.DISABLED.", +"enum": [ +"CONDITION_UNSPECIFIED", +"DISABLED", +"ENABLED" +], +"enumDescriptions": [ +"Server behavior defaults to Condition.DISABLED.", +"Disables NL filter extraction.", +"Enables NL filter extraction." +], "type": "string" }, -"purgeSample": { -"description": "A sample of document names that will be deleted. Only populated if `force` is set to false. A max of 100 names will be returned and the names are chosen at random.", +"geoSearchQueryDetectionFieldNames": { +"description": "Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.", "items": { "type": "string" }, @@ -14711,61 +16584,85 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesMetadata": { -"description": "Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesMetadata", +"GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec": { +"description": "Specification to determine under which conditions query expansion should occur.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"condition": { +"description": "The condition under which query expansion should occur. Default to Condition.DISABLED.", +"enum": [ +"CONDITION_UNSPECIFIED", +"DISABLED", +"AUTO" +], +"enumDescriptions": [ +"Unspecified query expansion condition. In this case, server behavior defaults to Condition.DISABLED.", +"Disabled query expansion. Only the exact search query is used, even if SearchResponse.total_size is zero.", +"Automatic query expansion built by the Search API." +], "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", -"type": "string" +"pinUnexpandedResults": { +"description": "Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results.", +"type": "boolean" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesResponse": { -"description": "Response message for CompletionService.PurgeSuggestionDenyListEntries method.", -"id": "GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesResponse", +"GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec": { +"description": "Specification for search as you type in search requests.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec", "properties": { -"errorSamples": { -"description": "A sample of errors encountered while processing the request.", -"items": { -"$ref": "GoogleRpcStatus" -}, -"type": "array" -}, -"purgeCount": { -"description": "Number of suggestion deny list entries purged.", -"format": "int64", +"condition": { +"description": "The condition under which search as you type should occur. Default to Condition.DISABLED.", +"enum": [ +"CONDITION_UNSPECIFIED", +"DISABLED", +"ENABLED" +], +"enumDescriptions": [ +"Server behavior defaults to Condition.DISABLED.", +"Disables Search As You Type.", +"Enables Search As You Type." +], "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaSchema": { -"description": "Defines the structure and layout of a type of document data.", -"id": "GoogleCloudDiscoveryengineV1betaSchema", +"GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec": { +"description": "Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec", "properties": { -"jsonSchema": { -"description": "The JSON representation of the schema.", -"type": "string" -}, -"name": { -"description": "Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"queryId": { +"description": "If set, the search result gets stored to the \"turn\" specified by this query ID. Example: Let's say the session looks like this: session { name: \".../sessions/xxx\" turns { query { text: \"What is foo?\" query_id: \".../questions/yyy\" } answer: \"Foo is ...\" } turns { query { text: \"How about bar then?\" query_id: \".../questions/zzz\" } } } The user can call /search API with a request like this: session: \".../sessions/xxx\" session_spec { query_id: \".../questions/zzz\" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID.", "type": "string" }, -"structSchema": { -"additionalProperties": { -"description": "Properties of the object.", -"type": "any" +"searchResultPersistenceCount": { +"description": "The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is simliar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode.", +"format": "int32", +"type": "integer" +} }, -"description": "The structured representation of the schema.", "type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec": { +"description": "The specification for query spell correction.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec", +"properties": { +"mode": { +"description": "The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO.", +"enum": [ +"MODE_UNSPECIFIED", +"SUGGESTION_ONLY", +"AUTO" +], +"enumDescriptions": [ +"Unspecified spell correction mode. In this case, server behavior defaults to Mode.AUTO.", +"Search API tries to find a spelling suggestion. If a suggestion is found, it is put in the SearchResponse.corrected_query. The spelling suggestion won't be used as the search query.", +"Automatic spell correction built by the Search API. Search will be based on the corrected query if found." +], +"type": "string" } }, "type": "object" @@ -15002,6 +16899,21 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaUserInfo": { +"description": "Information of an end user.", +"id": "GoogleCloudDiscoveryengineV1betaUserInfo", +"properties": { +"userAgent": { +"description": "User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set.", +"type": "string" +}, +"userId": { +"description": "Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"type": "string" +} +}, +"type": "object" +}, "GoogleLongrunningCancelOperationRequest": { "description": "The request message for Operations.CancelOperation.", "id": "GoogleLongrunningCancelOperationRequest", diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json index 3f6b0851113..ac0803f1935 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json @@ -2428,6 +2428,31 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"getUriPatternDocumentData": { +"description": "Gets the URI Pattern to Document data mapping for an Advanced Site Search DataStore.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine:getUriPatternDocumentData", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.getUriPatternDocumentData", +"parameterOrder": [ +"siteSearchEngine" +], +"parameters": { +"siteSearchEngine": { +"description": "Required. Full resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+siteSearchEngine}:getUriPatternDocumentData", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "recrawlUris": { "description": "Request on-demand recrawl for a list of URIs.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine:recrawlUris", @@ -2455,6 +2480,34 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +}, +"setUriPatternDocumentData": { +"description": "Sets the URI Pattern to Document data mapping for an Advanced Site Search DataStore.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine:setUriPatternDocumentData", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.setUriPatternDocumentData", +"parameterOrder": [ +"siteSearchEngine" +], +"parameters": { +"siteSearchEngine": { +"description": "Required. Full resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+siteSearchEngine}:setUriPatternDocumentData", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] } }, "resources": { @@ -6377,6 +6430,133 @@ } }, "evaluations": { +"methods": { +"create": { +"description": "Creates a Evaluation. Upon creation, the evaluation will be automatically triggered and begin execution.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/evaluations", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.evaluations.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent resource name, such as `projects/{project}/locations/{location}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/evaluations", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaEvaluation" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets a Evaluation.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/evaluations/{evaluationsId}", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.evaluations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Full resource name of Evaluation, such as `projects/{project}/locations/{location}/evaluations/{evaluation}`. If the caller does not have permission to access the Evaluation, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Evaluation does not exist, a NOT_FOUND error is returned.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/evaluations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaEvaluation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Gets a list of Evaluations.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/evaluations", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.evaluations.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Maximum number of Evaluations to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A page token ListEvaluationsResponse.next_page_token, received from a previous EvaluationService.ListEvaluations call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to EvaluationService.ListEvaluations must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent location resource name, such as `projects/{project}/locations/{location}`. If the caller does not have permission to list Evaluations under this location, regardless of whether or not this location exists, a `PERMISSION_DENIED` error is returned.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/evaluations", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaListEvaluationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"listResults": { +"description": "Gets a list of results for a given a Evaluation.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/evaluations/{evaluationsId}:listResults", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.evaluations.listResults", +"parameterOrder": [ +"evaluation" +], +"parameters": { +"evaluation": { +"description": "Required. The evaluation resource name, such as `projects/{project}/locations/{location}/evaluations/{evaluation}`. If the caller does not have permission to list EvaluationResult under this evaluation, regardless of whether or not this evaluation set exists, a `PERMISSION_DENIED` error is returned.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/evaluations/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "Maximum number of EvaluationResult to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A page token ListEvaluationResultsResponse.next_page_token, received from a previous EvaluationService.ListEvaluationResults call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to EvaluationService.ListEvaluationResults must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"location": "query", +"type": "string" +} +}, +"path": "v1alpha/{+evaluation}:listResults", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaListEvaluationResultsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, "resources": { "operations": { "methods": { @@ -6441,6 +6621,80 @@ } } }, +"identity_mapping_stores": { +"resources": { +"operations": { +"methods": { +"get": { +"description": "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.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/identity_mapping_stores/{identity_mapping_storesId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.identity_mapping_stores.operations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/identity_mapping_stores/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/identity_mapping_stores/{identity_mapping_storesId}/operations", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.identity_mapping_stores.operations.list", +"parameterOrder": [ +"name" +], +"parameters": { +"filter": { +"description": "The standard list filter.", +"location": "query", +"type": "string" +}, +"name": { +"description": "The name of the operation's parent resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/identity_mapping_stores/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The standard list page token.", +"location": "query", +"type": "string" +} +}, +"path": "v1alpha/{+name}/operations", +"response": { +"$ref": "GoogleLongrunningListOperationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +}, "operations": { "methods": { "get": { @@ -6576,125 +6830,169 @@ } }, "sampleQuerySets": { -"resources": { -"operations": { "methods": { -"get": { -"description": "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.", -"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/operations/{operationsId}", -"httpMethod": "GET", -"id": "discoveryengine.projects.locations.sampleQuerySets.operations.get", +"create": { +"description": "Creates a SampleQuerySet", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.sampleQuerySets.create", "parameterOrder": [ -"name" +"parent" ], "parameters": { -"name": { -"description": "The name of the operation resource.", +"parent": { +"description": "Required. The parent resource name, such as `projects/{project}/locations/{location}`.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" +}, +"sampleQuerySetId": { +"description": "Required. The ID to use for the SampleQuerySet, which will become the final component of the SampleQuerySet.name. If the caller does not have permission to create the SampleQuerySet, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all SampleQuerySets with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"location": "query", +"type": "string" } }, -"path": "v1alpha/{+name}", +"path": "v1alpha/{+parent}/sampleQuerySets", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuerySet" +}, "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuerySet" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] -} -} -} -} }, -"userEvents": { -"methods": { -"collect": { -"description": "Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-party domain. This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly.", -"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/userEvents:collect", -"httpMethod": "GET", -"id": "discoveryengine.projects.locations.userEvents.collect", +"delete": { +"description": "Deletes a SampleQuerySet.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}", +"httpMethod": "DELETE", +"id": "discoveryengine.projects.locations.sampleQuerySets.delete", "parameterOrder": [ -"parent" +"name" ], "parameters": { -"ets": { -"description": "The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.", -"format": "int64", -"location": "query", -"type": "string" -}, -"parent": { -"description": "Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.", +"name": { +"description": "Required. Full resource name of SampleQuerySet, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to delete the SampleQuerySet, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the SampleQuerySet to delete does not exist, a `NOT_FOUND` error is returned.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$", "required": true, "type": "string" +} }, -"uri": { -"description": "The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for third-party requests.", -"location": "query", -"type": "string" +"path": "v1alpha/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" }, -"userEvent": { -"description": "Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.", -"location": "query", +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets a SampleQuerySet.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.sampleQuerySets.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Full resource name of SampleQuerySet, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to access the SampleQuerySet, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested SampleQuerySet does not exist, a NOT_FOUND error is returned.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$", +"required": true, "type": "string" } }, -"path": "v1alpha/{+parent}/userEvents:collect", +"path": "v1alpha/{+name}", "response": { -"$ref": "GoogleApiHttpBody" +"$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuerySet" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"write": { -"description": "Writes a single user event.", -"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/userEvents:write", -"httpMethod": "POST", -"id": "discoveryengine.projects.locations.userEvents.write", +"list": { +"description": "Gets a list of SampleQuerySets.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.sampleQuerySets.list", "parameterOrder": [ "parent" ], "parameters": { +"pageSize": { +"description": "Maximum number of SampleQuerySets to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A page token ListSampleQuerySetsResponse.next_page_token, received from a previous SampleQuerySetService.ListSampleQuerySets call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SampleQuerySetService.ListSampleQuerySets must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"location": "query", +"type": "string" +}, "parent": { -"description": "Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`.", +"description": "Required. The parent location resource name, such as `projects/{project}/locations/{location}`. If the caller does not have permission to list SampleQuerySets under this location, regardless of whether or not this location exists, a `PERMISSION_DENIED` error is returned.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" +} }, -"writeAsync": { -"description": "If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write.", +"path": "v1alpha/{+parent}/sampleQuerySets", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaListSampleQuerySetsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates a SampleQuerySet.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}", +"httpMethod": "PATCH", +"id": "discoveryengine.projects.locations.sampleQuerySets.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Immutable. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Indicates which fields in the provided imported 'sample query set' to update. If not set, will by default update all fields.", +"format": "google-fieldmask", "location": "query", -"type": "boolean" +"type": "string" } }, -"path": "v1alpha/{+parent}/userEvents:write", +"path": "v1alpha/{+name}", "request": { -"$ref": "GoogleCloudDiscoveryengineV1alphaUserEvent" +"$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuerySet" }, "response": { -"$ref": "GoogleCloudDiscoveryengineV1alphaUserEvent" +"$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuerySet" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } -} -} -} }, +"resources": { "operations": { "methods": { "get": { "description": "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.", -"flatPath": "v1alpha/projects/{projectsId}/operations/{operationsId}", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/operations/{operationsId}", "httpMethod": "GET", -"id": "discoveryengine.projects.operations.get", +"id": "discoveryengine.projects.locations.sampleQuerySets.operations.get", "parameterOrder": [ "name" ], @@ -6702,7 +7000,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", -"pattern": "^projects/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -6714,85 +7012,381 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +} +} }, -"list": { -"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1alpha/projects/{projectsId}/operations", -"httpMethod": "GET", -"id": "discoveryengine.projects.operations.list", +"sampleQueries": { +"methods": { +"create": { +"description": "Creates a SampleQuery", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.sampleQuerySets.sampleQueries.create", "parameterOrder": [ -"name" +"parent" ], "parameters": { -"filter": { -"description": "The standard list filter.", +"parent": { +"description": "Required. The parent resource name, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$", +"required": true, +"type": "string" +}, +"sampleQueryId": { +"description": "Required. The ID to use for the SampleQuery, which will become the final component of the SampleQuery.name. If the caller does not have permission to create the SampleQuery, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all SampleQuerys with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", "location": "query", "type": "string" +} +}, +"path": "v1alpha/{+parent}/sampleQueries", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuery" +}, +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuery" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] }, +"delete": { +"description": "Deletes a SampleQuery.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries/{sampleQueriesId}", +"httpMethod": "DELETE", +"id": "discoveryengine.projects.locations.sampleQuerySets.sampleQueries.delete", +"parameterOrder": [ +"name" +], +"parameters": { "name": { -"description": "The name of the operation's parent resource.", +"description": "Required. Full resource name of SampleQuery, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. If the caller does not have permission to delete the SampleQuery, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the SampleQuery to delete does not exist, a `NOT_FOUND` error is returned.", "location": "path", -"pattern": "^projects/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+/sampleQueries/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets a SampleQuery.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries/{sampleQueriesId}", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.sampleQuerySets.sampleQueries.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Full resource name of SampleQuery, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. If the caller does not have permission to access the SampleQuery, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested SampleQuery does not exist, a NOT_FOUND error is returned.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+/sampleQueries/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuery" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"import": { +"description": "Bulk import of multiple SampleQuerys. Sample queries that already exist may be deleted. Note: It is possible for a subset of the SampleQuerys to be successfully imported.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries:import", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.sampleQuerySets.sampleQueries.import", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent sample query set resource name, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to list SampleQuerys under this sample query set, regardless of whether or not this sample query set exists, a `PERMISSION_DENIED` error is returned.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$", "required": true, "type": "string" +} +}, +"path": "v1alpha/{+parent}/sampleQueries:import", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] }, +"list": { +"description": "Gets a list of SampleQuerys.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.sampleQuerySets.sampleQueries.list", +"parameterOrder": [ +"parent" +], +"parameters": { "pageSize": { -"description": "The standard list page size.", +"description": "Maximum number of SampleQuerys to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "The standard list page token.", +"description": "A page token ListSampleQueriesResponse.next_page_token, received from a previous SampleQueryService.ListSampleQueries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SampleQueryService.ListSampleQueries must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", "location": "query", "type": "string" +}, +"parent": { +"description": "Required. The parent sample query set resource name, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to list SampleQuerys under this sample query set, regardless of whether or not this sample query set exists, a `PERMISSION_DENIED` error is returned.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$", +"required": true, +"type": "string" } }, -"path": "v1alpha/{+name}/operations", +"path": "v1alpha/{+parent}/sampleQueries", "response": { -"$ref": "GoogleLongrunningListOperationsResponse" +"$ref": "GoogleCloudDiscoveryengineV1alphaListSampleQueriesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +}, +"patch": { +"description": "Updates a SampleQuery.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries/{sampleQueriesId}", +"httpMethod": "PATCH", +"id": "discoveryengine.projects.locations.sampleQuerySets.sampleQueries.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+/sampleQueries/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Indicates which fields in the provided imported 'simple query' to update. If not set, will by default update all fields.", +"format": "google-fieldmask", +"location": "query", +"type": "string" } +}, +"path": "v1alpha/{+name}", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuery" +}, +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuery" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] } } } } }, -"revision": "20240704", -"rootUrl": "https://discoveryengine.googleapis.com/", -"schemas": { -"GoogleApiDistribution": { -"description": "`Distribution` contains summary statistics for a population of values. It optionally contains a histogram representing the distribution of those values across a set of buckets. The summary statistics are the count, mean, sum of the squared deviation from the mean, the minimum, and the maximum of the set of population of values. The histogram is based on a sequence of buckets and gives a count of values that fall into each bucket. The boundaries of the buckets are given either explicitly or by formulas for buckets of fixed or exponentially increasing widths. Although it is not forbidden, it is generally a bad idea to include non-finite values (infinities or NaNs) in the population of values, as this will render the `mean` and `sum_of_squared_deviation` fields meaningless.", -"id": "GoogleApiDistribution", -"properties": { -"bucketCounts": { -"description": "The number of values in each bucket of the histogram, as described in `bucket_options`. If the distribution does not have a histogram, then omit this field. If there is a histogram, then the sum of the values in `bucket_counts` must equal the value in the `count` field of the distribution. If present, `bucket_counts` should contain N values, where N is the number of buckets specified in `bucket_options`. If you supply fewer than N values, the remaining values are assumed to be 0. The order of the values in `bucket_counts` follows the bucket numbering schemes described for the three bucket types. The first value must be the count for the underflow bucket (number 0). The next N-2 values are the counts for the finite buckets (number 1 through N-2). The N'th value in `bucket_counts` is the count for the overflow bucket (number N-1).", -"items": { +"userEvents": { +"methods": { +"collect": { +"description": "Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-party domain. This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/userEvents:collect", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.userEvents.collect", +"parameterOrder": [ +"parent" +], +"parameters": { +"ets": { +"description": "The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.", "format": "int64", +"location": "query", "type": "string" }, -"type": "array" -}, -"bucketOptions": { -"$ref": "GoogleApiDistributionBucketOptions", -"description": "Defines the histogram bucket boundaries. If the distribution does not contain a histogram, then omit this field." +"parent": { +"description": "Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" }, -"count": { -"description": "The number of values in the population. Must be non-negative. This value must equal the sum of the values in `bucket_counts` if a histogram is provided.", -"format": "int64", +"uri": { +"description": "The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for third-party requests.", +"location": "query", "type": "string" }, -"exemplars": { -"description": "Must be in increasing order of `value` field.", -"items": { -"$ref": "GoogleApiDistributionExemplar" +"userEvent": { +"description": "Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.", +"location": "query", +"type": "string" +} }, -"type": "array" +"path": "v1alpha/{+parent}/userEvents:collect", +"response": { +"$ref": "GoogleApiHttpBody" }, -"mean": { +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"write": { +"description": "Writes a single user event.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/userEvents:write", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.userEvents.write", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"writeAsync": { +"description": "If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1alpha/{+parent}/userEvents:write", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaUserEvent" +}, +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaUserEvent" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +}, +"operations": { +"methods": { +"get": { +"description": "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.", +"flatPath": "v1alpha/projects/{projectsId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "discoveryengine.projects.operations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^projects/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", +"flatPath": "v1alpha/projects/{projectsId}/operations", +"httpMethod": "GET", +"id": "discoveryengine.projects.operations.list", +"parameterOrder": [ +"name" +], +"parameters": { +"filter": { +"description": "The standard list filter.", +"location": "query", +"type": "string" +}, +"name": { +"description": "The name of the operation's parent resource.", +"location": "path", +"pattern": "^projects/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The standard list page token.", +"location": "query", +"type": "string" +} +}, +"path": "v1alpha/{+name}/operations", +"response": { +"$ref": "GoogleLongrunningListOperationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +} +}, +"revision": "20240715", +"rootUrl": "https://discoveryengine.googleapis.com/", +"schemas": { +"GoogleApiDistribution": { +"description": "`Distribution` contains summary statistics for a population of values. It optionally contains a histogram representing the distribution of those values across a set of buckets. The summary statistics are the count, mean, sum of the squared deviation from the mean, the minimum, and the maximum of the set of population of values. The histogram is based on a sequence of buckets and gives a count of values that fall into each bucket. The boundaries of the buckets are given either explicitly or by formulas for buckets of fixed or exponentially increasing widths. Although it is not forbidden, it is generally a bad idea to include non-finite values (infinities or NaNs) in the population of values, as this will render the `mean` and `sum_of_squared_deviation` fields meaningless.", +"id": "GoogleApiDistribution", +"properties": { +"bucketCounts": { +"description": "The number of values in each bucket of the histogram, as described in `bucket_options`. If the distribution does not have a histogram, then omit this field. If there is a histogram, then the sum of the values in `bucket_counts` must equal the value in the `count` field of the distribution. If present, `bucket_counts` should contain N values, where N is the number of buckets specified in `bucket_options`. If you supply fewer than N values, the remaining values are assumed to be 0. The order of the values in `bucket_counts` follows the bucket numbering schemes described for the three bucket types. The first value must be the count for the underflow bucket (number 0). The next N-2 values are the counts for the finite buckets (number 1 through N-2). The N'th value in `bucket_counts` is the count for the overflow bucket (number N-1).", +"items": { +"format": "int64", +"type": "string" +}, +"type": "array" +}, +"bucketOptions": { +"$ref": "GoogleApiDistributionBucketOptions", +"description": "Defines the histogram bucket boundaries. If the distribution does not contain a histogram, then omit this field." +}, +"count": { +"description": "The number of values in the population. Must be non-negative. This value must equal the sum of the values in `bucket_counts` if a histogram is provided.", +"format": "int64", +"type": "string" +}, +"exemplars": { +"description": "Must be in increasing order of `value` field.", +"items": { +"$ref": "GoogleApiDistributionExemplar" +}, +"type": "array" +}, +"mean": { "description": "The arithmetic mean of the values in the population. If `count` is zero then this field must be zero.", "format": "double", "type": "number" @@ -8875,7 +9469,7 @@ "type": "string" }, "searchResultMode": { -"description": "Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents)", +"description": "Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents)", "enum": [ "SEARCH_RESULT_MODE_UNSPECIFIED", "DOCUMENTS", @@ -9026,7 +9620,7 @@ "properties": { "answer": { "$ref": "GoogleCloudDiscoveryengineV1alphaAnswer", -"description": "Answer resource object. If AnswerQueryRequest.StepSpec.max_step_count is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API." +"description": "Answer resource object. If AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.max_rephrase_steps is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API." }, "answerQueryToken": { "description": "A global unique ID used for logging.", @@ -9290,7 +9884,7 @@ "description": "Properties of the object.", "type": "any" }, -"description": "Data representation. The structured JSON data for the document. It's populated from the struct data from the Document (code pointer: http://shortn/_objzAfIiHq), or the Chunk in search result (code pointer: http://shortn/_Ipo6KFFGBL).", +"description": "Data representation. The structured JSON data for the document. It's populated from the struct data from the Document , or the Chunk in search result .", "type": "object" }, "title": { @@ -10390,6 +10984,12 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaCreateEvaluationMetadata": { +"description": "Metadata for EvaluationService.CreateEvaluation method.", +"id": "GoogleCloudDiscoveryengineV1alphaCreateEvaluationMetadata", +"properties": {}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata": { "description": "Metadata for Create Schema LRO.", "id": "GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata", @@ -11416,6 +12016,96 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaEvaluation": { +"description": "An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data.", +"id": "GoogleCloudDiscoveryengineV1alphaEvaluation", +"properties": { +"createTime": { +"description": "Output only. Timestamp the Evaluation was created at.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"endTime": { +"description": "Output only. Timestamp the Evaluation was completed at.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"error": { +"$ref": "GoogleRpcStatus", +"description": "Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED.", +"readOnly": true +}, +"errorSamples": { +"description": "Output only. A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"readOnly": true, +"type": "array" +}, +"evaluationSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec", +"description": "Required. The specification of the evaluation." +}, +"name": { +"description": "Immutable. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"type": "string" +}, +"qualityMetrics": { +"$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetrics", +"description": "Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet. Only populated when the evaluation's state is SUCCEEDED.", +"readOnly": true +}, +"state": { +"description": "Output only. The state of the evaluation.", +"enum": [ +"STATE_UNSPECIFIED", +"PENDING", +"RUNNING", +"SUCCEEDED", +"FAILED" +], +"enumDescriptions": [ +"The evaluation is unspecified.", +"The service is preparing to run the evaluation.", +"The evaluation is in progress.", +"The evaluation completed successfully.", +"The evaluation failed." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec": { +"description": "Describes the specification of the evaluation.", +"id": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec", +"properties": { +"querySetSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec", +"description": "Required. The specification of the query set." +}, +"searchRequest": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequest", +"description": "Required. The search request that is used to perform the evaluation. Only the following fields within SearchRequest are supported; if any other fields are provided, an UNSUPPORTED error will be returned: * SearchRequest.serving_config * SearchRequest.branch * SearchRequest.canonical_filter * SearchRequest.query_expansion_spec * SearchRequest.spell_correction_spec * SearchRequest.content_search_spec * SearchRequest.user_pseudo_id" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec": { +"description": "Describes the specification of the query set.", +"id": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec", +"properties": { +"sampleQuerySet": { +"description": "Required. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaExportUserEventsMetadata": { "description": "Metadata related to the progress of the Export operation. This is returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1alphaExportUserEventsMetadata", @@ -11705,6 +12395,24 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse": { +"description": "Response message for SiteSearchEngineService.GetUriPatternDocumentData method.", +"id": "GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse", +"properties": { +"documentDataMap": { +"additionalProperties": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" +}, +"description": "Document data keyed by URI pattern. For example: document_data_map = { \"www.url1.com/*\": { \"Categories\": [\"category1\", \"category2\"] }, \"www.url2.com/*\": { \"Categories\": [\"category3\"] } }", +"type": "object" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaGroundingFact": { "description": "Grounding Fact.", "id": "GoogleCloudDiscoveryengineV1alphaGroundingFact", @@ -12010,55 +12718,142 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata": { -"description": "Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata", +"GoogleCloudDiscoveryengineV1alphaImportSampleQueriesMetadata": { +"description": "Metadata related to the progress of the ImportSampleQueries operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesMetadata", "properties": { "createTime": { -"description": "Operation create time.", +"description": "ImportSampleQueries operation create time.", "format": "google-datetime", "type": "string" }, +"failureCount": { +"description": "Count of SampleQuerys that failed to be imported.", +"format": "int64", +"type": "string" +}, +"successCount": { +"description": "Count of SampleQuerys successfully imported.", +"format": "int64", +"type": "string" +}, +"totalCount": { +"description": "Total count of SampleQuerys that were processed.", +"format": "int64", +"type": "string" +}, "updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", +"description": "ImportSampleQueries operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequest": { -"description": "Request message for CompletionService.ImportSuggestionDenyListEntries method.", -"id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequest", +"GoogleCloudDiscoveryengineV1alphaImportSampleQueriesRequest": { +"description": "Request message for SampleQueryService.ImportSampleQueries method.", +"id": "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesRequest", "properties": { +"bigquerySource": { +"$ref": "GoogleCloudDiscoveryengineV1alphaBigQuerySource", +"description": "BigQuery input source." +}, +"errorConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", +"description": "The desired location of errors incurred during the Import." +}, "gcsSource": { "$ref": "GoogleCloudDiscoveryengineV1alphaGcsSource", -"description": "Cloud Storage location for the input content. Only 1 file can be specified that contains all entries to import. Supported values `gcs_source.schema` for autocomplete suggestion deny list entry imports: * `suggestion_deny_list` (default): One JSON [SuggestionDenyListEntry] per line." +"description": "Cloud Storage location for the input content." }, "inlineSource": { -"$ref": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequestInlineSource", -"description": "The Inline source for the input content for suggestion deny list entries." +"$ref": "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesRequestInlineSource", +"description": "The Inline source for sample query entries." } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequestInlineSource": { -"description": "The inline source for SuggestionDenyListEntry.", -"id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequestInlineSource", +"GoogleCloudDiscoveryengineV1alphaImportSampleQueriesRequestInlineSource": { +"description": "The inline source for SampleQuerys.", +"id": "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesRequestInlineSource", "properties": { -"entries": { -"description": "Required. A list of all denylist entries to import. Max of 1000 items.", +"sampleQueries": { +"description": "Required. A list of SampleQuerys to import. Max of 1000 items.", "items": { -"$ref": "GoogleCloudDiscoveryengineV1alphaSuggestionDenyListEntry" +"$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuery" }, "type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesResponse": { -"description": "Response message for CompletionService.ImportSuggestionDenyListEntries method.", -"id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesResponse", +"GoogleCloudDiscoveryengineV1alphaImportSampleQueriesResponse": { +"description": "Response of the SampleQueryService.ImportSampleQueries method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.", +"id": "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesResponse", +"properties": { +"errorConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", +"description": "The desired location of errors incurred during the Import." +}, +"errorSamples": { +"description": "A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata": { +"description": "Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequest": { +"description": "Request message for CompletionService.ImportSuggestionDenyListEntries method.", +"id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequest", +"properties": { +"gcsSource": { +"$ref": "GoogleCloudDiscoveryengineV1alphaGcsSource", +"description": "Cloud Storage location for the input content. Only 1 file can be specified that contains all entries to import. Supported values `gcs_source.schema` for autocomplete suggestion deny list entry imports: * `suggestion_deny_list` (default): One JSON [SuggestionDenyListEntry] per line." +}, +"inlineSource": { +"$ref": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequestInlineSource", +"description": "The Inline source for the input content for suggestion deny list entries." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequestInlineSource": { +"description": "The inline source for SuggestionDenyListEntry.", +"id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequestInlineSource", +"properties": { +"entries": { +"description": "Required. A list of all denylist entries to import. Max of 1000 items.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSuggestionDenyListEntry" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesResponse": { +"description": "Response message for CompletionService.ImportSuggestionDenyListEntries method.", +"id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesResponse", "properties": { "errorSamples": { "description": "A sample of errors encountered while processing the request.", @@ -12347,6 +13142,95 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaListEvaluationResultsResponse": { +"description": "Response message for EvaluationService.ListEvaluationResults method.", +"id": "GoogleCloudDiscoveryengineV1alphaListEvaluationResultsResponse", +"properties": { +"evaluationResults": { +"description": "The EvaluationResults.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaListEvaluationResultsResponseEvaluationResult" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token that can be sent as ListEvaluationResultsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaListEvaluationResultsResponseEvaluationResult": { +"description": "Represents the results of an evaluation for a single SampleQuery.", +"id": "GoogleCloudDiscoveryengineV1alphaListEvaluationResultsResponseEvaluationResult", +"properties": { +"qualityMetrics": { +"$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetrics", +"description": "Output only. The metrics produced by the evaluation, for a given SampleQuery.", +"readOnly": true +}, +"sampleQuery": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuery", +"description": "Output only. The SampleQuery that was evaluated.", +"readOnly": true +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaListEvaluationsResponse": { +"description": "Response message for EvaluationService.ListEvaluations method.", +"id": "GoogleCloudDiscoveryengineV1alphaListEvaluationsResponse", +"properties": { +"evaluations": { +"description": "The Evaluations.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaEvaluation" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token that can be sent as ListEvaluationsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaListSampleQueriesResponse": { +"description": "Response message for SampleQueryService.ListSampleQueries method.", +"id": "GoogleCloudDiscoveryengineV1alphaListSampleQueriesResponse", +"properties": { +"nextPageToken": { +"description": "A token that can be sent as ListSampleQueriesRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", +"type": "string" +}, +"sampleQueries": { +"description": "The SampleQuerys.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuery" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaListSampleQuerySetsResponse": { +"description": "Response message for SampleQuerySetService.ListSampleQuerySets method.", +"id": "GoogleCloudDiscoveryengineV1alphaListSampleQuerySetsResponse", +"properties": { +"nextPageToken": { +"description": "A token that can be sent as ListSampleQuerySetsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", +"type": "string" +}, +"sampleQuerySets": { +"description": "The SampleQuerySets.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuerySet" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaListSchemasResponse": { "description": "Response message for SchemaService.ListSchemas method.", "id": "GoogleCloudDiscoveryengineV1alphaListSchemasResponse", @@ -12867,6 +13751,60 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaQualityMetrics": { +"description": "Describes the metrics produced by the evaluation.", +"id": "GoogleCloudDiscoveryengineV1alphaQualityMetrics", +"properties": { +"docNdcg": { +"$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", +"description": "Normalized discounted cumulative gain (NDCG) per document, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved documents (D1, D2, D3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [D3 (0), D1 (1), D2 (1)] Ideal: [D1 (1), D2 (1), D3 (0)] Calculate NDCG@3 for each SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693" +}, +"docPrecision": { +"$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", +"description": "Precision per document, at various top-k cutoff levels. Precision is the fraction of retrieved documents that are relevant. Example (top-5): * For a single SampleQuery, If 4 out of 5 retrieved documents in the top-5 are relevant, precision@5 = 4/5 = 0.8" +}, +"docRecall": { +"$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", +"description": "Recall per document, at various top-k cutoff levels. Recall is the fraction of relevant documents retrieved out of all relevant documents. Example (top-5): * For a single SampleQuery, If 3 out of 5 relevant documents are retrieved in the top-5, recall@5 = 3/5 = 0.6" +}, +"pageNdcg": { +"$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", +"description": "Normalized discounted cumulative gain (NDCG) per page, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved pages (P1, P2, P3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [P3 (0), P1 (1), P2 (1)] Ideal: [P1 (1), P2 (1), P3 (0)] Calculate NDCG@3 for SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693" +}, +"pageRecall": { +"$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", +"description": "Recall per page, at various top-k cutoff levels. Recall is the fraction of relevant pages retrieved out of all relevant pages. Example (top-5): * For a single SampleQuery, if 3 out of 5 relevant pages are retrieved in the top-5, recall@5 = 3/5 = 0.6" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics": { +"description": "Stores the metric values at specific top-k levels.", +"id": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", +"properties": { +"top1": { +"description": "The top-1 value.", +"format": "double", +"type": "number" +}, +"top10": { +"description": "The top-10 value.", +"format": "double", +"type": "number" +}, +"top3": { +"description": "The top-3 value.", +"format": "double", +"type": "number" +}, +"top5": { +"description": "The top-5 value.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaQuery": { "description": "Defines a user inputed query.", "id": "GoogleCloudDiscoveryengineV1alphaQuery", @@ -13367,6 +14305,94 @@ "properties": {}, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaSampleQuery": { +"description": "Sample Query captures metadata to be used for evaluation.", +"id": "GoogleCloudDiscoveryengineV1alphaSampleQuery", +"properties": { +"createTime": { +"description": "Output only. Timestamp the SampleQuery was created at.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"type": "string" +}, +"queryEntry": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSampleQueryQueryEntry", +"description": "The query entry." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaSampleQueryQueryEntry": { +"description": "Query Entry captures metadata to be used for search evaluation.", +"id": "GoogleCloudDiscoveryengineV1alphaSampleQueryQueryEntry", +"properties": { +"query": { +"description": "Required. The query.", +"type": "string" +}, +"targets": { +"description": "List of targets for the query.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSampleQueryQueryEntryTarget" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaSampleQueryQueryEntryTarget": { +"description": "Defines the parameters of the query's expected outcome.", +"id": "GoogleCloudDiscoveryengineV1alphaSampleQueryQueryEntryTarget", +"properties": { +"pageNumbers": { +"description": "Expected page numbers of the target. Each page number must be non negative.", +"items": { +"format": "int32", +"type": "integer" +}, +"type": "array" +}, +"score": { +"description": "Relevance score of the target.", +"format": "double", +"type": "number" +}, +"uri": { +"description": "Expected uri of the target. This field must be a UTF-8 encoded string with a length limit of 2048 characters. Example of valid uris: `https://example.com/abc`, `gcs://example/example.pdf`.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaSampleQuerySet": { +"description": "A SampleQuerySet is the parent resource of SampleQuery, and contains the configurations shared by all SampleQuery under it.", +"id": "GoogleCloudDiscoveryengineV1alphaSampleQuerySet", +"properties": { +"createTime": { +"description": "Output only. Timestamp the SampleQuerySet was created at.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"description": { +"description": "The description of the SampleQuerySet.", +"type": "string" +}, +"displayName": { +"description": "Required. The sample query set display name. This field must be a UTF-8 encoded string with a length limit of 128 characters.", +"type": "string" +}, +"name": { +"description": "Immutable. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaSchema": { "description": "Defines the structure and layout of a type of document data.", "id": "GoogleCloudDiscoveryengineV1alphaSchema", @@ -13543,6 +14569,10 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec", "description": "Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical." }, +"servingConfig": { +"description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.", +"type": "string" +}, "session": { "description": "The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is \"How did Alphabet do in 2022?\" and the current query is \"How about 2023?\", the current query will be interpreted as \"How did Alphabet do in 2023?\". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.", "type": "string" @@ -13680,7 +14710,7 @@ "description": "If there is no extractive_content_spec provided, there will be no extractive answer in the search response." }, "searchResultMode": { -"description": "Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`.", +"description": "Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.", "enum": [ "SEARCH_RESULT_MODE_UNSPECIFIED", "DOCUMENTS", @@ -13984,7 +15014,7 @@ "type": "string" }, "geoSearchQueryDetectionFieldNames": { -"description": "Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in Servingconfig.geo_search_query_detection_field_names.", +"description": "Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.", "items": { "type": "string" }, @@ -14868,6 +15898,59 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataMetadata": { +"description": "Metadata related to the progress of the SiteSearchEngineService.SetUriPatternDocumentData operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataRequest": { +"description": "Request message for SiteSearchEngineService.SetUriPatternDocumentData method.", +"id": "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataRequest", +"properties": { +"documentDataMap": { +"additionalProperties": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" +}, +"description": "Document data keyed by URI pattern. Each entry must be consistent with the Schema. For example: Schema = { \"type\": \"object\", \"properties\": { \"Categories\": { \"type\": \"array\", \"items\": { \"retrievable\": true, \"type\": \"string\" } } } document_data_map = { \"www.url1.com/*\": { \"Categories\": [\"category1\", \"category2\"] }, \"www.url2.com/*\": { \"Categories\": [\"category3\"] } }", +"type": "object" +}, +"emptyDocumentDataMap": { +"description": "If true, clears the document data map. If true, SetUriPatternDocumentDataRequest.document_data_map must be empty.", +"type": "boolean" +}, +"schema": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Optional. If not provided, the current Schema is used. If provided, validates and updates the Schema. If validation fails, an error is returned.", +"type": "object" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataResponse": { +"description": "Response message for SiteSearchEngineService.SetUriPatternDocumentData method.", +"id": "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataResponse", +"properties": {}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaSiteSearchEngine": { "description": "SiteSearchEngine captures DataStore level site search persisting configurations. It is a singleton value per data store.", "id": "GoogleCloudDiscoveryengineV1alphaSiteSearchEngine", @@ -15639,6 +16722,12 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaCreateEvaluationMetadata": { +"description": "Metadata for EvaluationService.CreateEvaluation method.", +"id": "GoogleCloudDiscoveryengineV1betaCreateEvaluationMetadata", +"properties": {}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata": { "description": "Metadata for Create Schema LRO.", "id": "GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata", @@ -16223,19 +17312,109 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsMetadata": { -"description": "Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsMetadata", +"GoogleCloudDiscoveryengineV1betaEvaluation": { +"description": "An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data.", +"id": "GoogleCloudDiscoveryengineV1betaEvaluation", "properties": { "createTime": { -"description": "Operation create time.", +"description": "Output only. Timestamp the Evaluation was created at.", "format": "google-datetime", +"readOnly": true, "type": "string" }, -"failureCount": { -"description": "Count of CompletionSuggestions that failed to be imported.", -"format": "int64", -"type": "string" +"endTime": { +"description": "Output only. Timestamp the Evaluation was completed at.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"error": { +"$ref": "GoogleRpcStatus", +"description": "Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED.", +"readOnly": true +}, +"errorSamples": { +"description": "Output only. A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"readOnly": true, +"type": "array" +}, +"evaluationSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec", +"description": "Required. The specification of the evaluation." +}, +"name": { +"description": "Immutable. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"type": "string" +}, +"qualityMetrics": { +"$ref": "GoogleCloudDiscoveryengineV1betaQualityMetrics", +"description": "Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet. Only populated when the evaluation's state is SUCCEEDED.", +"readOnly": true +}, +"state": { +"description": "Output only. The state of the evaluation.", +"enum": [ +"STATE_UNSPECIFIED", +"PENDING", +"RUNNING", +"SUCCEEDED", +"FAILED" +], +"enumDescriptions": [ +"The evaluation is unspecified.", +"The service is preparing to run the evaluation.", +"The evaluation is in progress.", +"The evaluation completed successfully.", +"The evaluation failed." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec": { +"description": "Describes the specification of the evaluation.", +"id": "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec", +"properties": { +"querySetSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec", +"description": "Required. The specification of the query set." +}, +"searchRequest": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequest", +"description": "Required. The search request that is used to perform the evaluation. Only the following fields within SearchRequest are supported; if any other fields are provided, an UNSUPPORTED error will be returned: * SearchRequest.serving_config * SearchRequest.branch * SearchRequest.canonical_filter * SearchRequest.query_expansion_spec * SearchRequest.spell_correction_spec * SearchRequest.content_search_spec * SearchRequest.user_pseudo_id" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec": { +"description": "Describes the specification of the query set.", +"id": "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec", +"properties": { +"sampleQuerySet": { +"description": "Required. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsMetadata": { +"description": "Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"failureCount": { +"description": "Count of CompletionSuggestions that failed to be imported.", +"format": "int64", +"type": "string" }, "successCount": { "description": "Count of CompletionSuggestions successfully imported.", @@ -16329,6 +17508,56 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaImportSampleQueriesMetadata": { +"description": "Metadata related to the progress of the ImportSampleQueries operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1betaImportSampleQueriesMetadata", +"properties": { +"createTime": { +"description": "ImportSampleQueries operation create time.", +"format": "google-datetime", +"type": "string" +}, +"failureCount": { +"description": "Count of SampleQuerys that failed to be imported.", +"format": "int64", +"type": "string" +}, +"successCount": { +"description": "Count of SampleQuerys successfully imported.", +"format": "int64", +"type": "string" +}, +"totalCount": { +"description": "Total count of SampleQuerys that were processed.", +"format": "int64", +"type": "string" +}, +"updateTime": { +"description": "ImportSampleQueries operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaImportSampleQueriesResponse": { +"description": "Response of the SampleQueryService.ImportSampleQueries method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.", +"id": "GoogleCloudDiscoveryengineV1betaImportSampleQueriesResponse", +"properties": { +"errorConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", +"description": "The desired location of errors incurred during the Import." +}, +"errorSamples": { +"description": "A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesMetadata": { "description": "Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesMetadata", @@ -16425,6 +17654,33 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaInterval": { +"description": "A floating point interval.", +"id": "GoogleCloudDiscoveryengineV1betaInterval", +"properties": { +"exclusiveMaximum": { +"description": "Exclusive upper bound.", +"format": "double", +"type": "number" +}, +"exclusiveMinimum": { +"description": "Exclusive lower bound.", +"format": "double", +"type": "number" +}, +"maximum": { +"description": "Inclusive upper bound.", +"format": "double", +"type": "number" +}, +"minimum": { +"description": "Inclusive lower bound.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaLanguageInfo": { "description": "Language info for DataStore.", "id": "GoogleCloudDiscoveryengineV1betaLanguageInfo", @@ -16458,135 +17714,805 @@ "models": { "description": "List of custom tuning models.", "items": { -"$ref": "GoogleCloudDiscoveryengineV1betaCustomTuningModel" +"$ref": "GoogleCloudDiscoveryengineV1betaCustomTuningModel" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaProject": { +"description": "Metadata and configurations for a Google Cloud project in the service.", +"id": "GoogleCloudDiscoveryengineV1betaProject", +"properties": { +"createTime": { +"description": "Output only. The timestamp when this project is created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Output only. Full resource name of the project, for example `projects/{project_number}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.", +"readOnly": true, +"type": "string" +}, +"provisionCompletionTime": { +"description": "Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"serviceTermsMap": { +"additionalProperties": { +"$ref": "GoogleCloudDiscoveryengineV1betaProjectServiceTerms" +}, +"description": "Output only. A map of terms of services. The key is the `id` of ServiceTerms.", +"readOnly": true, +"type": "object" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaProjectServiceTerms": { +"description": "Metadata about the terms of service.", +"id": "GoogleCloudDiscoveryengineV1betaProjectServiceTerms", +"properties": { +"acceptTime": { +"description": "The last time when the project agreed to the terms of service.", +"format": "google-datetime", +"type": "string" +}, +"declineTime": { +"description": "The last time when the project declined or revoked the agreement to terms of service.", +"format": "google-datetime", +"type": "string" +}, +"id": { +"description": "The unique identifier of this terms of service. Available terms: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this as `id`, the acceptable version to provide is `2022-11-23`.", +"type": "string" +}, +"state": { +"description": "Whether the project has accepted/rejected the service terms or it is still pending.", +"enum": [ +"STATE_UNSPECIFIED", +"TERMS_ACCEPTED", +"TERMS_PENDING", +"TERMS_DECLINED" +], +"enumDescriptions": [ +"The default value of the enum. This value is not actually used.", +"The project has given consent to the terms of service.", +"The project is pending to review and accept the terms of service.", +"The project has declined or revoked the agreement to terms of service." +], +"type": "string" +}, +"version": { +"description": "The version string of the terms of service. For acceptable values, see the comments for id above.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaProvisionProjectMetadata": { +"description": "Metadata associated with a project provision operation.", +"id": "GoogleCloudDiscoveryengineV1betaProvisionProjectMetadata", +"properties": {}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata": { +"description": "Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"failureCount": { +"description": "Count of entries that encountered errors while processing.", +"format": "int64", +"type": "string" +}, +"ignoredCount": { +"description": "Count of entries that were ignored as entries were not found.", +"format": "int64", +"type": "string" +}, +"successCount": { +"description": "Count of entries that were deleted successfully.", +"format": "int64", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse": { +"description": "Response message for DocumentService.PurgeDocuments method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.", +"id": "GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse", +"properties": { +"purgeCount": { +"description": "The total count of documents purged as a result of the operation.", +"format": "int64", +"type": "string" +}, +"purgeSample": { +"description": "A sample of document names that will be deleted. Only populated if `force` is set to false. A max of 100 names will be returned and the names are chosen at random.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesMetadata": { +"description": "Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesResponse": { +"description": "Response message for CompletionService.PurgeSuggestionDenyListEntries method.", +"id": "GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesResponse", +"properties": { +"errorSamples": { +"description": "A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"type": "array" +}, +"purgeCount": { +"description": "Number of suggestion deny list entries purged.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaQualityMetrics": { +"description": "Describes the metrics produced by the evaluation.", +"id": "GoogleCloudDiscoveryengineV1betaQualityMetrics", +"properties": { +"docNdcg": { +"$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", +"description": "Normalized discounted cumulative gain (NDCG) per document, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved documents (D1, D2, D3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [D3 (0), D1 (1), D2 (1)] Ideal: [D1 (1), D2 (1), D3 (0)] Calculate NDCG@3 for each SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693" +}, +"docPrecision": { +"$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", +"description": "Precision per document, at various top-k cutoff levels. Precision is the fraction of retrieved documents that are relevant. Example (top-5): * For a single SampleQuery, If 4 out of 5 retrieved documents in the top-5 are relevant, precision@5 = 4/5 = 0.8" +}, +"docRecall": { +"$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", +"description": "Recall per document, at various top-k cutoff levels. Recall is the fraction of relevant documents retrieved out of all relevant documents. Example (top-5): * For a single SampleQuery, If 3 out of 5 relevant documents are retrieved in the top-5, recall@5 = 3/5 = 0.6" +}, +"pageNdcg": { +"$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", +"description": "Normalized discounted cumulative gain (NDCG) per page, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved pages (P1, P2, P3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [P3 (0), P1 (1), P2 (1)] Ideal: [P1 (1), P2 (1), P3 (0)] Calculate NDCG@3 for SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693" +}, +"pageRecall": { +"$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", +"description": "Recall per page, at various top-k cutoff levels. Recall is the fraction of relevant pages retrieved out of all relevant pages. Example (top-5): * For a single SampleQuery, if 3 out of 5 relevant pages are retrieved in the top-5, recall@5 = 3/5 = 0.6" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics": { +"description": "Stores the metric values at specific top-k levels.", +"id": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", +"properties": { +"top1": { +"description": "The top-1 value.", +"format": "double", +"type": "number" +}, +"top10": { +"description": "The top-10 value.", +"format": "double", +"type": "number" +}, +"top3": { +"description": "The top-3 value.", +"format": "double", +"type": "number" +}, +"top5": { +"description": "The top-5 value.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSchema": { +"description": "Defines the structure and layout of a type of document data.", +"id": "GoogleCloudDiscoveryengineV1betaSchema", +"properties": { +"jsonSchema": { +"description": "The JSON representation of the schema.", +"type": "string" +}, +"name": { +"description": "Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"type": "string" +}, +"structSchema": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "The structured representation of the schema.", +"type": "object" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSearchRequest": { +"description": "Request message for SearchService.Search method.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequest", +"properties": { +"boostSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec", +"description": "Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)" +}, +"branch": { +"description": "The branch resource name, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Use `default_branch` as the branch ID or leave this field empty, to search documents under the default branch.", +"type": "string" +}, +"canonicalFilter": { +"description": "The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about filter syntax, see SearchRequest.filter.", +"type": "string" +}, +"contentSearchSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec", +"description": "A specification for configuring the behavior of content search." +}, +"dataStoreSpecs": { +"description": "Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec" +}, +"type": "array" +}, +"embeddingSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec", +"description": "Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path." +}, +"facetSpecs": { +"description": "Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec" +}, +"type": "array" +}, +"filter": { +"description": "The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY(\"king kong\")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)", +"type": "string" +}, +"imageQuery": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery", +"description": "Raw image query." +}, +"languageCode": { +"description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.", +"type": "string" +}, +"naturalLanguageQueryUnderstandingSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec", +"description": "If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done." +}, +"offset": { +"description": "A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.", +"format": "int32", +"type": "integer" +}, +"orderBy": { +"description": "The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering for retail search, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.", +"type": "string" +}, +"pageSize": { +"description": "Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.", +"format": "int32", +"type": "integer" +}, +"pageToken": { +"description": "A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"type": "string" +}, +"params": { +"additionalProperties": { +"type": "any" +}, +"description": "Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. For example, `user_country_code: \"au\"` For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example, `search_type: 1`", +"type": "object" +}, +"query": { +"description": "Raw search query.", +"type": "string" +}, +"queryExpansionSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec", +"description": "The query expansion specification that specifies the conditions under which query expansion occurs." +}, +"rankingExpression": { +"description": "The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The ranking expression is a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.", +"type": "string" +}, +"regionCode": { +"description": "The Unicode country/region code (CLDR) of a location, such as \"US\" and \"419\". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.", +"type": "string" +}, +"safeSearch": { +"description": "Whether to turn on safe search. This is only supported for website search.", +"type": "boolean" +}, +"searchAsYouTypeSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec", +"description": "Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical." +}, +"servingConfig": { +"description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.", +"type": "string" +}, +"session": { +"description": "The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is \"How did Alphabet do in 2022?\" and the current query is \"How about 2023?\", the current query will be interpreted as \"How did Alphabet do in 2023?\". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.", +"type": "string" +}, +"sessionSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec", +"description": "Session specification. Can be used only when `session` is set." +}, +"spellCorrectionSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec", +"description": "The spell correction specification that specifies the mode under which spell correction takes effect." +}, +"userInfo": { +"$ref": "GoogleCloudDiscoveryengineV1betaUserInfo", +"description": "Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics." +}, +"userLabels": { +"additionalProperties": { +"type": "string" +}, +"description": "The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * 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. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.", +"type": "object" +}, +"userPseudoId": { +"description": "A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec": { +"description": "Boost specification to boost certain documents.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec", +"properties": { +"conditionBoostSpecs": { +"description": "Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec": { +"description": "Boost applies to documents which match a condition.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec", +"properties": { +"boost": { +"description": "Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied.", +"format": "float", +"type": "number" +}, +"boostControlSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec", +"description": "Complex specification for custom ranking based on customer defined attribute value." +}, +"condition": { +"description": "An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID \"doc_1\" or \"doc_2\", and color \"Red\" or \"Blue\": `(document_id: ANY(\"doc_1\", \"doc_2\")) AND (color: ANY(\"Red\", \"Blue\"))`", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec": { +"description": "Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec", +"properties": { +"attributeType": { +"description": "The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).", +"enum": [ +"ATTRIBUTE_TYPE_UNSPECIFIED", +"NUMERICAL", +"FRESHNESS" +], +"enumDescriptions": [ +"Unspecified AttributeType.", +"The value of the numerical field will be used to dynamically update the boost amount. In this case, the attribute_value (the x value) of the control point will be the actual value of the numerical field for which the boost_amount is specified.", +"For the freshness use case the attribute value will be the duration between the current time and the date in the datetime field specified. The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. For example, `5D`, `3DT12H30M`, `T24H`." +], +"type": "string" +}, +"controlPoints": { +"description": "The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint" +}, +"type": "array" +}, +"fieldName": { +"description": "The name of the field whose value will be used to determine the boost amount.", +"type": "string" +}, +"interpolationType": { +"description": "The interpolation type to be applied to connect the control points listed below.", +"enum": [ +"INTERPOLATION_TYPE_UNSPECIFIED", +"LINEAR" +], +"enumDescriptions": [ +"Interpolation type is unspecified. In this case, it defaults to Linear.", +"Piecewise linear interpolation will be applied." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint": { +"description": "The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint", +"properties": { +"attributeValue": { +"description": "Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.", +"type": "string" +}, +"boostAmount": { +"description": "The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.", +"format": "float", +"type": "number" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec": { +"description": "A specification for configuring the behavior of content search.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec", +"properties": { +"chunkSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec", +"description": "Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS" +}, +"extractiveContentSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec", +"description": "If there is no extractive_content_spec provided, there will be no extractive answer in the search response." +}, +"searchResultMode": { +"description": "Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.", +"enum": [ +"SEARCH_RESULT_MODE_UNSPECIFIED", +"DOCUMENTS", +"CHUNKS" +], +"enumDescriptions": [ +"Default value.", +"Returns documents in the search result.", +"Returns chunks in the search result. Only available if the DataStore.DocumentProcessingConfig.chunking_config is specified." +], +"type": "string" +}, +"snippetSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec", +"description": "If `snippetSpec` is not specified, snippets are not included in the search response." +}, +"summarySpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec", +"description": "If `summarySpec` is not specified, summaries are not included in the search response." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec": { +"description": "Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec", +"properties": { +"numNextChunks": { +"description": "The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned.", +"format": "int32", +"type": "integer" +}, +"numPreviousChunks": { +"description": "The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec": { +"description": "A specification for configuring the extractive content in a search response.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec", +"properties": { +"maxExtractiveAnswerCount": { +"description": "The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult.", +"format": "int32", +"type": "integer" +}, +"maxExtractiveSegmentCount": { +"description": "The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`.", +"format": "int32", +"type": "integer" +}, +"numNextSegments": { +"description": "Return at most `num_next_segments` segments after each selected segments.", +"format": "int32", +"type": "integer" +}, +"numPreviousSegments": { +"description": "Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.", +"format": "int32", +"type": "integer" +}, +"returnExtractiveSegmentScore": { +"description": "Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`.", +"type": "boolean" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec": { +"description": "A specification for configuring snippets in a search response.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec", +"properties": { +"maxSnippetCount": { +"deprecated": true, +"description": "[DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0.", +"format": "int32", +"type": "integer" +}, +"referenceOnly": { +"deprecated": true, +"description": "[DEPRECATED] This field is deprecated and will have no affect on the snippet.", +"type": "boolean" +}, +"returnSnippet": { +"description": "If `true`, then return snippet. If no snippet can be generated, we return \"No snippet is available for this page.\" A `snippet_status` with `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned.", +"type": "boolean" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec": { +"description": "A specification for configuring a summary returned in a search response.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec", +"properties": { +"ignoreAdversarialQuery": { +"description": "Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead.", +"type": "boolean" +}, +"ignoreNonSummarySeekingQuery": { +"description": "Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead.", +"type": "boolean" +}, +"includeCitations": { +"description": "Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results.", +"type": "boolean" +}, +"languageCode": { +"description": "Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.", +"type": "string" +}, +"modelPromptSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec", +"description": "If specified, the spec will be used to modify the prompt provided to the LLM." +}, +"modelSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec", +"description": "If specified, the spec will be used to modify the model specification provided to the LLM." +}, +"summaryResultCount": { +"description": "The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.", +"format": "int32", +"type": "integer" +}, +"useSemanticChunks": { +"description": "If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list.", +"type": "boolean" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec": { +"description": "Specification of the prompt to use with the model.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec", +"properties": { +"preamble": { +"description": "Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec": { +"description": "Specification of the model.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec", +"properties": { +"version": { +"description": "The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). * `preview`: string. (Public preview) Uses a preview model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec": { +"description": "A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec", +"properties": { +"dataStore": { +"description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec": { +"description": "The specification that uses customized query embedding vector to do semantic document retrieval.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec", +"properties": { +"embeddingVectors": { +"description": "The embedding vector used for retrieval. Limit to 1.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector": { +"description": "Embedding vector.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector", +"properties": { +"fieldPath": { +"description": "Embedding field path in schema.", +"type": "string" +}, +"vector": { +"description": "Query embedding vector.", +"items": { +"format": "float", +"type": "number" }, "type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaProject": { -"description": "Metadata and configurations for a Google Cloud project in the service.", -"id": "GoogleCloudDiscoveryengineV1betaProject", +"GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec": { +"description": "A facet specification to perform faceted search.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec", "properties": { -"createTime": { -"description": "Output only. The timestamp when this project is created.", -"format": "google-datetime", -"readOnly": true, -"type": "string" +"enableDynamicPosition": { +"description": "Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * \"rating\", enable_dynamic_position = true * \"price\", enable_dynamic_position = false * \"brands\", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be (\"price\", \"brands\", \"rating\", \"gender\") or (\"price\", \"brands\", \"gender\", \"rating\") depends on how API orders \"gender\" and \"rating\" facets. However, notice that \"price\" and \"brands\" are always ranked at first and second position because their enable_dynamic_position is false.", +"type": "boolean" }, -"name": { -"description": "Output only. Full resource name of the project, for example `projects/{project_number}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.", -"readOnly": true, +"excludedFilterKeys": { +"description": "List of keys to exclude when faceting. By default, FacetKey.key is not excluded from the filter unless it is listed in this field. Listing a facet key in this field allows its values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned. For example, suppose there are 100 documents with the color facet \"Red\" and 200 documents with the color facet \"Blue\". A query containing the filter \"color:ANY(\"Red\")\" and having \"color\" as FacetKey.key would by default return only \"Red\" documents in the search results, and also return \"Red\" with count 100 as the only color facet. Although there are also blue documents available, \"Blue\" would not be shown as an available facet value. If \"color\" is listed in \"excludedFilterKeys\", then the query returns the facet values \"Red\" with count 100 and \"Blue\" with count 200, because the \"color\" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly filtered to return only \"Red\" documents. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"items": { "type": "string" }, -"provisionCompletionTime": { -"description": "Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use.", -"format": "google-datetime", -"readOnly": true, -"type": "string" +"type": "array" }, -"serviceTermsMap": { -"additionalProperties": { -"$ref": "GoogleCloudDiscoveryengineV1betaProjectServiceTerms" +"facetKey": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey", +"description": "Required. The facet key specification." }, -"description": "Output only. A map of terms of services. The key is the `id` of ServiceTerms.", -"readOnly": true, -"type": "object" +"limit": { +"description": "Maximum facet values that are returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. For aggregation in healthcare search, when the [FacetKey.key] is \"healthcare_aggregation_key\", the limit will be overridden to 10,000 internally, regardless of the value set here. If this field is negative, an `INVALID_ARGUMENT` is returned.", +"format": "int32", +"type": "integer" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaProjectServiceTerms": { -"description": "Metadata about the terms of service.", -"id": "GoogleCloudDiscoveryengineV1betaProjectServiceTerms", +"GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey": { +"description": "Specifies how a facet is computed.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey", "properties": { -"acceptTime": { -"description": "The last time when the project agreed to the terms of service.", -"format": "google-datetime", -"type": "string" -}, -"declineTime": { -"description": "The last time when the project declined or revoked the agreement to terms of service.", -"format": "google-datetime", -"type": "string" -}, -"id": { -"description": "The unique identifier of this terms of service. Available terms: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this as `id`, the acceptable version to provide is `2022-11-23`.", -"type": "string" +"caseInsensitive": { +"description": "True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.", +"type": "boolean" }, -"state": { -"description": "Whether the project has accepted/rejected the service terms or it is still pending.", -"enum": [ -"STATE_UNSPECIFIED", -"TERMS_ACCEPTED", -"TERMS_PENDING", -"TERMS_DECLINED" -], -"enumDescriptions": [ -"The default value of the enum. This value is not actually used.", -"The project has given consent to the terms of service.", -"The project is pending to review and accept the terms of service.", -"The project has declined or revoked the agreement to terms of service." -], +"contains": { +"description": "Only get facet values that contain the given strings. For example, suppose \"category\" has three values \"Action > 2022\", \"Action > 2021\" and \"Sci-Fi > 2022\". If set \"contains\" to \"2022\", the \"category\" facet only contains \"Action > 2022\" and \"Sci-Fi > 2022\". Only supported on textual fields. Maximum is 10.", +"items": { "type": "string" }, -"version": { -"description": "The version string of the terms of service. For acceptable values, see the comments for id above.", -"type": "string" -} +"type": "array" }, -"type": "object" +"intervals": { +"description": "Set only if values should be bucketed into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaInterval" }, -"GoogleCloudDiscoveryengineV1betaProvisionProjectMetadata": { -"description": "Metadata associated with a project provision operation.", -"id": "GoogleCloudDiscoveryengineV1betaProvisionProjectMetadata", -"properties": {}, -"type": "object" +"type": "array" }, -"GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata": { -"description": "Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata", -"properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"key": { +"description": "Required. Supported textual and numerical facet keys in Document object, over which the facet values are computed. Facet key is case-sensitive.", "type": "string" }, -"failureCount": { -"description": "Count of entries that encountered errors while processing.", -"format": "int64", +"orderBy": { +"description": "The order in which documents are returned. Allowed values are: * \"count desc\", which means order by SearchResponse.Facet.values.count descending. * \"value desc\", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets. If not set, textual values are sorted in [natural order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals.", "type": "string" }, -"ignoredCount": { -"description": "Count of entries that were ignored as entries were not found.", -"format": "int64", +"prefixes": { +"description": "Only get facet values that start with the given string prefix. For example, suppose \"category\" has three values \"Action > 2022\", \"Action > 2021\" and \"Sci-Fi > 2022\". If set \"prefixes\" to \"Action\", the \"category\" facet only contains \"Action > 2022\" and \"Action > 2021\". Only supported on textual fields. Maximum is 10.", +"items": { "type": "string" }, -"successCount": { -"description": "Count of entries that were deleted successfully.", -"format": "int64", +"type": "array" +}, +"restrictedValues": { +"description": "Only get facet for the given restricted values. Only supported on textual fields. For example, suppose \"category\" has three values \"Action > 2022\", \"Action > 2021\" and \"Sci-Fi > 2022\". If set \"restricted_values\" to \"Action > 2022\", the \"category\" facet only contains \"Action > 2022\". Only supported on textual fields. Maximum is 10.", +"items": { "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery": { +"description": "Specifies the image query input.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery", +"properties": { +"imageBytes": { +"description": "Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse": { -"description": "Response message for DocumentService.PurgeDocuments method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.", -"id": "GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse", +"GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec": { +"description": "Specification to enable natural language understanding capabilities for search requests.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec", "properties": { -"purgeCount": { -"description": "The total count of documents purged as a result of the operation.", -"format": "int64", +"filterExtractionCondition": { +"description": "The condition under which filter extraction should occur. Default to Condition.DISABLED.", +"enum": [ +"CONDITION_UNSPECIFIED", +"DISABLED", +"ENABLED" +], +"enumDescriptions": [ +"Server behavior defaults to Condition.DISABLED.", +"Disables NL filter extraction.", +"Enables NL filter extraction." +], "type": "string" }, -"purgeSample": { -"description": "A sample of document names that will be deleted. Only populated if `force` is set to false. A max of 100 names will be returned and the names are chosen at random.", +"geoSearchQueryDetectionFieldNames": { +"description": "Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.", "items": { "type": "string" }, @@ -16595,61 +18521,85 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesMetadata": { -"description": "Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesMetadata", +"GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec": { +"description": "Specification to determine under which conditions query expansion should occur.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"condition": { +"description": "The condition under which query expansion should occur. Default to Condition.DISABLED.", +"enum": [ +"CONDITION_UNSPECIFIED", +"DISABLED", +"AUTO" +], +"enumDescriptions": [ +"Unspecified query expansion condition. In this case, server behavior defaults to Condition.DISABLED.", +"Disabled query expansion. Only the exact search query is used, even if SearchResponse.total_size is zero.", +"Automatic query expansion built by the Search API." +], "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", -"type": "string" +"pinUnexpandedResults": { +"description": "Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results.", +"type": "boolean" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesResponse": { -"description": "Response message for CompletionService.PurgeSuggestionDenyListEntries method.", -"id": "GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesResponse", +"GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec": { +"description": "Specification for search as you type in search requests.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec", "properties": { -"errorSamples": { -"description": "A sample of errors encountered while processing the request.", -"items": { -"$ref": "GoogleRpcStatus" -}, -"type": "array" -}, -"purgeCount": { -"description": "Number of suggestion deny list entries purged.", -"format": "int64", +"condition": { +"description": "The condition under which search as you type should occur. Default to Condition.DISABLED.", +"enum": [ +"CONDITION_UNSPECIFIED", +"DISABLED", +"ENABLED" +], +"enumDescriptions": [ +"Server behavior defaults to Condition.DISABLED.", +"Disables Search As You Type.", +"Enables Search As You Type." +], "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaSchema": { -"description": "Defines the structure and layout of a type of document data.", -"id": "GoogleCloudDiscoveryengineV1betaSchema", +"GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec": { +"description": "Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec", "properties": { -"jsonSchema": { -"description": "The JSON representation of the schema.", -"type": "string" -}, -"name": { -"description": "Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"queryId": { +"description": "If set, the search result gets stored to the \"turn\" specified by this query ID. Example: Let's say the session looks like this: session { name: \".../sessions/xxx\" turns { query { text: \"What is foo?\" query_id: \".../questions/yyy\" } answer: \"Foo is ...\" } turns { query { text: \"How about bar then?\" query_id: \".../questions/zzz\" } } } The user can call /search API with a request like this: session: \".../sessions/xxx\" session_spec { query_id: \".../questions/zzz\" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID.", "type": "string" }, -"structSchema": { -"additionalProperties": { -"description": "Properties of the object.", -"type": "any" +"searchResultPersistenceCount": { +"description": "The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is simliar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode.", +"format": "int32", +"type": "integer" +} }, -"description": "The structured representation of the schema.", "type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec": { +"description": "The specification for query spell correction.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec", +"properties": { +"mode": { +"description": "The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO.", +"enum": [ +"MODE_UNSPECIFIED", +"SUGGESTION_ONLY", +"AUTO" +], +"enumDescriptions": [ +"Unspecified spell correction mode. In this case, server behavior defaults to Mode.AUTO.", +"Search API tries to find a spelling suggestion. If a suggestion is found, it is put in the SearchResponse.corrected_query. The spelling suggestion won't be used as the search query.", +"Automatic spell correction built by the Search API. Search will be based on the corrected query if found." +], +"type": "string" } }, "type": "object" @@ -16886,6 +18836,21 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaUserInfo": { +"description": "Information of an end user.", +"id": "GoogleCloudDiscoveryengineV1betaUserInfo", +"properties": { +"userAgent": { +"description": "User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set.", +"type": "string" +}, +"userId": { +"description": "Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"type": "string" +} +}, +"type": "object" +}, "GoogleLongrunningCancelOperationRequest": { "description": "The request message for Operations.CancelOperation.", "id": "GoogleLongrunningCancelOperationRequest", diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json index 3a7a3ab31b8..bcf237ddb17 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json @@ -5823,6 +5823,133 @@ } }, "evaluations": { +"methods": { +"create": { +"description": "Creates a Evaluation. Upon creation, the evaluation will be automatically triggered and begin execution.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/evaluations", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.evaluations.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent resource name, such as `projects/{project}/locations/{location}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+parent}/evaluations", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1betaEvaluation" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets a Evaluation.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/evaluations/{evaluationsId}", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.evaluations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Full resource name of Evaluation, such as `projects/{project}/locations/{location}/evaluations/{evaluation}`. If the caller does not have permission to access the Evaluation, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Evaluation does not exist, a NOT_FOUND error is returned.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/evaluations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+name}", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1betaEvaluation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Gets a list of Evaluations.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/evaluations", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.evaluations.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Maximum number of Evaluations to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A page token ListEvaluationsResponse.next_page_token, received from a previous EvaluationService.ListEvaluations call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to EvaluationService.ListEvaluations must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent location resource name, such as `projects/{project}/locations/{location}`. If the caller does not have permission to list Evaluations under this location, regardless of whether or not this location exists, a `PERMISSION_DENIED` error is returned.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+parent}/evaluations", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1betaListEvaluationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"listResults": { +"description": "Gets a list of results for a given a Evaluation.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/evaluations/{evaluationsId}:listResults", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.evaluations.listResults", +"parameterOrder": [ +"evaluation" +], +"parameters": { +"evaluation": { +"description": "Required. The evaluation resource name, such as `projects/{project}/locations/{location}/evaluations/{evaluation}`. If the caller does not have permission to list EvaluationResult under this evaluation, regardless of whether or not this evaluation set exists, a `PERMISSION_DENIED` error is returned.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/evaluations/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "Maximum number of EvaluationResult to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A page token ListEvaluationResultsResponse.next_page_token, received from a previous EvaluationService.ListEvaluationResults call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to EvaluationService.ListEvaluationResults must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"location": "query", +"type": "string" +} +}, +"path": "v1beta/{+evaluation}:listResults", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1betaListEvaluationResultsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, "resources": { "operations": { "methods": { @@ -5990,125 +6117,169 @@ } }, "sampleQuerySets": { -"resources": { -"operations": { "methods": { +"create": { +"description": "Creates a SampleQuerySet", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.sampleQuerySets.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent resource name, such as `projects/{project}/locations/{location}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"sampleQuerySetId": { +"description": "Required. The ID to use for the SampleQuerySet, which will become the final component of the SampleQuerySet.name. If the caller does not have permission to create the SampleQuerySet, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all SampleQuerySets with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"location": "query", +"type": "string" +} +}, +"path": "v1beta/{+parent}/sampleQuerySets", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1betaSampleQuerySet" +}, +"response": { +"$ref": "GoogleCloudDiscoveryengineV1betaSampleQuerySet" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a SampleQuerySet.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}", +"httpMethod": "DELETE", +"id": "discoveryengine.projects.locations.sampleQuerySets.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Full resource name of SampleQuerySet, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to delete the SampleQuerySet, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the SampleQuerySet to delete does not exist, a `NOT_FOUND` error is returned.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "get": { -"description": "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.", -"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/operations/{operationsId}", +"description": "Gets a SampleQuerySet.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}", "httpMethod": "GET", -"id": "discoveryengine.projects.locations.sampleQuerySets.operations.get", +"id": "discoveryengine.projects.locations.sampleQuerySets.get", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "The name of the operation resource.", +"description": "Required. Full resource name of SampleQuerySet, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to access the SampleQuerySet, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested SampleQuerySet does not exist, a NOT_FOUND error is returned.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta/{+name}", "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleCloudDiscoveryengineV1betaSampleQuerySet" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] -} -} -} -} }, -"userEvents": { -"methods": { -"collect": { -"description": "Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-party domain. This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly.", -"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/userEvents:collect", +"list": { +"description": "Gets a list of SampleQuerySets.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets", "httpMethod": "GET", -"id": "discoveryengine.projects.locations.userEvents.collect", +"id": "discoveryengine.projects.locations.sampleQuerySets.list", "parameterOrder": [ "parent" ], "parameters": { -"ets": { -"description": "The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.", -"format": "int64", +"pageSize": { +"description": "Maximum number of SampleQuerySets to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A page token ListSampleQuerySetsResponse.next_page_token, received from a previous SampleQuerySetService.ListSampleQuerySets call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SampleQuerySetService.ListSampleQuerySets must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", "location": "query", "type": "string" }, "parent": { -"description": "Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.", +"description": "Required. The parent location resource name, such as `projects/{project}/locations/{location}`. If the caller does not have permission to list SampleQuerySets under this location, regardless of whether or not this location exists, a `PERMISSION_DENIED` error is returned.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" -}, -"uri": { -"description": "The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for third-party requests.", -"location": "query", -"type": "string" -}, -"userEvent": { -"description": "Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.", -"location": "query", -"type": "string" } }, -"path": "v1beta/{+parent}/userEvents:collect", +"path": "v1beta/{+parent}/sampleQuerySets", "response": { -"$ref": "GoogleApiHttpBody" +"$ref": "GoogleCloudDiscoveryengineV1betaListSampleQuerySetsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"write": { -"description": "Writes a single user event.", -"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/userEvents:write", -"httpMethod": "POST", -"id": "discoveryengine.projects.locations.userEvents.write", +"patch": { +"description": "Updates a SampleQuerySet.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}", +"httpMethod": "PATCH", +"id": "discoveryengine.projects.locations.sampleQuerySets.patch", "parameterOrder": [ -"parent" +"name" ], "parameters": { -"parent": { -"description": "Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`.", +"name": { +"description": "Immutable. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$", "required": true, "type": "string" }, -"writeAsync": { -"description": "If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write.", +"updateMask": { +"description": "Indicates which fields in the provided imported 'sample query set' to update. If not set, will by default update all fields.", +"format": "google-fieldmask", "location": "query", -"type": "boolean" +"type": "string" } }, -"path": "v1beta/{+parent}/userEvents:write", +"path": "v1beta/{+name}", "request": { -"$ref": "GoogleCloudDiscoveryengineV1betaUserEvent" +"$ref": "GoogleCloudDiscoveryengineV1betaSampleQuerySet" }, "response": { -"$ref": "GoogleCloudDiscoveryengineV1betaUserEvent" +"$ref": "GoogleCloudDiscoveryengineV1betaSampleQuerySet" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } -} -} -} }, +"resources": { "operations": { "methods": { "get": { "description": "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.", -"flatPath": "v1beta/projects/{projectsId}/operations/{operationsId}", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/operations/{operationsId}", "httpMethod": "GET", -"id": "discoveryengine.projects.operations.get", +"id": "discoveryengine.projects.locations.sampleQuerySets.operations.get", "parameterOrder": [ "name" ], @@ -6116,7 +6287,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", -"pattern": "^projects/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -6128,205 +6299,1075 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +} +} }, -"list": { -"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1beta/projects/{projectsId}/operations", -"httpMethod": "GET", -"id": "discoveryengine.projects.operations.list", +"sampleQueries": { +"methods": { +"create": { +"description": "Creates a SampleQuery", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.sampleQuerySets.sampleQueries.create", "parameterOrder": [ -"name" +"parent" ], "parameters": { -"filter": { -"description": "The standard list filter.", -"location": "query", -"type": "string" -}, -"name": { -"description": "The name of the operation's parent resource.", +"parent": { +"description": "Required. The parent resource name, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.", "location": "path", -"pattern": "^projects/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$", "required": true, "type": "string" }, -"pageSize": { -"description": "The standard list page size.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "The standard list page token.", +"sampleQueryId": { +"description": "Required. The ID to use for the SampleQuery, which will become the final component of the SampleQuery.name. If the caller does not have permission to create the SampleQuery, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all SampleQuerys with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", "location": "query", "type": "string" } }, -"path": "v1beta/{+name}/operations", +"path": "v1beta/{+parent}/sampleQueries", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1betaSampleQuery" +}, "response": { -"$ref": "GoogleLongrunningListOperationsResponse" +"$ref": "GoogleCloudDiscoveryengineV1betaSampleQuery" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] -} -} -} -} -} }, -"revision": "20240704", -"rootUrl": "https://discoveryengine.googleapis.com/", -"schemas": { -"GoogleApiHttpBody": { -"description": "Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.", -"id": "GoogleApiHttpBody", +"delete": { +"description": "Deletes a SampleQuery.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries/{sampleQueriesId}", +"httpMethod": "DELETE", +"id": "discoveryengine.projects.locations.sampleQuerySets.sampleQueries.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Full resource name of SampleQuery, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. If the caller does not have permission to delete the SampleQuery, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the SampleQuery to delete does not exist, a `NOT_FOUND` error is returned.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+/sampleQueries/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets a SampleQuery.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries/{sampleQueriesId}", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.sampleQuerySets.sampleQueries.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Full resource name of SampleQuery, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. If the caller does not have permission to access the SampleQuery, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested SampleQuery does not exist, a NOT_FOUND error is returned.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+/sampleQueries/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+name}", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1betaSampleQuery" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"import": { +"description": "Bulk import of multiple SampleQuerys. Sample queries that already exist may be deleted. Note: It is possible for a subset of the SampleQuerys to be successfully imported.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries:import", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.sampleQuerySets.sampleQueries.import", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent sample query set resource name, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to list SampleQuerys under this sample query set, regardless of whether or not this sample query set exists, a `PERMISSION_DENIED` error is returned.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+parent}/sampleQueries:import", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1betaImportSampleQueriesRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Gets a list of SampleQuerys.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.sampleQuerySets.sampleQueries.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Maximum number of SampleQuerys to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A page token ListSampleQueriesResponse.next_page_token, received from a previous SampleQueryService.ListSampleQueries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SampleQueryService.ListSampleQueries must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent sample query set resource name, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to list SampleQuerys under this sample query set, regardless of whether or not this sample query set exists, a `PERMISSION_DENIED` error is returned.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+parent}/sampleQueries", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1betaListSampleQueriesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates a SampleQuery.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries/{sampleQueriesId}", +"httpMethod": "PATCH", +"id": "discoveryengine.projects.locations.sampleQuerySets.sampleQueries.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+/sampleQueries/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Indicates which fields in the provided imported 'simple query' to update. If not set, will by default update all fields.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1beta/{+name}", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1betaSampleQuery" +}, +"response": { +"$ref": "GoogleCloudDiscoveryengineV1betaSampleQuery" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +}, +"userEvents": { +"methods": { +"collect": { +"description": "Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-party domain. This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/userEvents:collect", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.userEvents.collect", +"parameterOrder": [ +"parent" +], +"parameters": { +"ets": { +"description": "The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.", +"format": "int64", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"uri": { +"description": "The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for third-party requests.", +"location": "query", +"type": "string" +}, +"userEvent": { +"description": "Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.", +"location": "query", +"type": "string" +} +}, +"path": "v1beta/{+parent}/userEvents:collect", +"response": { +"$ref": "GoogleApiHttpBody" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"write": { +"description": "Writes a single user event.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/userEvents:write", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.userEvents.write", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"writeAsync": { +"description": "If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1beta/{+parent}/userEvents:write", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1betaUserEvent" +}, +"response": { +"$ref": "GoogleCloudDiscoveryengineV1betaUserEvent" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +}, +"operations": { +"methods": { +"get": { +"description": "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.", +"flatPath": "v1beta/projects/{projectsId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "discoveryengine.projects.operations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^projects/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", +"flatPath": "v1beta/projects/{projectsId}/operations", +"httpMethod": "GET", +"id": "discoveryengine.projects.operations.list", +"parameterOrder": [ +"name" +], +"parameters": { +"filter": { +"description": "The standard list filter.", +"location": "query", +"type": "string" +}, +"name": { +"description": "The name of the operation's parent resource.", +"location": "path", +"pattern": "^projects/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The standard list page token.", +"location": "query", +"type": "string" +} +}, +"path": "v1beta/{+name}/operations", +"response": { +"$ref": "GoogleLongrunningListOperationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +} +}, +"revision": "20240715", +"rootUrl": "https://discoveryengine.googleapis.com/", +"schemas": { +"GoogleApiHttpBody": { +"description": "Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.", +"id": "GoogleApiHttpBody", +"properties": { +"contentType": { +"description": "The HTTP Content-Type header value specifying the content type of the body.", +"type": "string" +}, +"data": { +"description": "The HTTP request/response body as raw binary.", +"format": "byte", +"type": "string" +}, +"extensions": { +"description": "Application specific response metadata. Must be set in the first response for streaming APIs.", +"items": { +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" +}, +"type": "object" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineLoggingErrorContext": { +"description": "A description of the context in which an error occurred.", +"id": "GoogleCloudDiscoveryengineLoggingErrorContext", +"properties": { +"httpRequest": { +"$ref": "GoogleCloudDiscoveryengineLoggingHttpRequestContext", +"description": "The HTTP request which was processed when the error was triggered." +}, +"reportLocation": { +"$ref": "GoogleCloudDiscoveryengineLoggingSourceLocation", +"description": "The location in the source code where the decision was made to report the error, usually the place where it was logged." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineLoggingErrorLog": { +"description": "An error log which is reported to the Error Reporting system.", +"id": "GoogleCloudDiscoveryengineLoggingErrorLog", +"properties": { +"context": { +"$ref": "GoogleCloudDiscoveryengineLoggingErrorContext", +"description": "A description of the context in which the error occurred." +}, +"importPayload": { +"$ref": "GoogleCloudDiscoveryengineLoggingImportErrorContext", +"description": "The error payload that is populated on LRO import APIs." +}, +"message": { +"description": "A message describing the error.", +"type": "string" +}, +"requestPayload": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "The API request payload, represented as a protocol buffer. Most API request types are supported\u2014for example: * `type.googleapis.com/google.cloud.discoveryengine.v1alpha.DocumentService.CreateDocumentRequest` * `type.googleapis.com/google.cloud.discoveryengine.v1alpha.UserEventService.WriteUserEventRequest`", +"type": "object" +}, +"responsePayload": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "The API response payload, represented as a protocol buffer. This is used to log some \"soft errors\", where the response is valid but we consider there are some quality issues like unjoined events. The following API responses are supported, and no PII is included: * `google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend` * `google.cloud.discoveryengine.v1alpha.UserEventService.WriteUserEvent` * `google.cloud.discoveryengine.v1alpha.UserEventService.CollectUserEvent`", +"type": "object" +}, +"serviceContext": { +"$ref": "GoogleCloudDiscoveryengineLoggingServiceContext", +"description": "The service context in which this error has occurred." +}, +"status": { +"$ref": "GoogleRpcStatus", +"description": "The RPC status associated with the error log." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineLoggingHttpRequestContext": { +"description": "HTTP request data that is related to a reported error.", +"id": "GoogleCloudDiscoveryengineLoggingHttpRequestContext", +"properties": { +"responseStatusCode": { +"description": "The HTTP response status code for the request.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineLoggingImportErrorContext": { +"description": "The error payload that is populated on LRO import APIs, including the following: * `google.cloud.discoveryengine.v1alpha.DocumentService.ImportDocuments` * `google.cloud.discoveryengine.v1alpha.UserEventService.ImportUserEvents`", +"id": "GoogleCloudDiscoveryengineLoggingImportErrorContext", +"properties": { +"document": { +"description": "The detailed content which caused the error on importing a document.", +"type": "string" +}, +"gcsPath": { +"description": "Google Cloud Storage file path of the import source. Can be set for batch operation error.", +"type": "string" +}, +"lineNumber": { +"description": "Line number of the content in file. Should be empty for permission or batch operation error.", +"type": "string" +}, +"operation": { +"description": "The operation resource name of the LRO.", +"type": "string" +}, +"userEvent": { +"description": "The detailed content which caused the error on importing a user event.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineLoggingServiceContext": { +"description": "Describes a running service that sends errors.", +"id": "GoogleCloudDiscoveryengineLoggingServiceContext", +"properties": { +"service": { +"description": "An identifier of the service\u2014for example, `discoveryengine.googleapis.com`.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineLoggingSourceLocation": { +"description": "Indicates a location in the source code of the service for which errors are reported.", +"id": "GoogleCloudDiscoveryengineLoggingSourceLocation", +"properties": { +"functionName": { +"description": "Human-readable name of a function or method\u2014for example, `google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend`.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata": { +"description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1BatchCreateTargetSitesResponse": { +"description": "Response message for SiteSearchEngineService.BatchCreateTargetSites method.", +"id": "GoogleCloudDiscoveryengineV1BatchCreateTargetSitesResponse", +"properties": { +"targetSites": { +"description": "TargetSites created.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1TargetSite" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1Condition": { +"description": "Defines circumstances to be checked before allowing a behavior", +"id": "GoogleCloudDiscoveryengineV1Condition", +"properties": { +"activeTimeRange": { +"description": "Range of time(s) specifying when condition is active. Maximum of 10 time ranges.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1ConditionTimeRange" +}, +"type": "array" +}, +"queryTerms": { +"description": "Search only A list of terms to match the query on. Maximum of 10 query terms.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1ConditionQueryTerm" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1ConditionQueryTerm": { +"description": "Matcher for search request query", +"id": "GoogleCloudDiscoveryengineV1ConditionQueryTerm", +"properties": { +"fullMatch": { +"description": "Whether the search query needs to exactly match the query term.", +"type": "boolean" +}, +"value": { +"description": "The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1ConditionTimeRange": { +"description": "Used for time-dependent conditions.", +"id": "GoogleCloudDiscoveryengineV1ConditionTimeRange", +"properties": { +"endTime": { +"description": "End of time range. Range is inclusive. Must be in the future.", +"format": "google-datetime", +"type": "string" +}, +"startTime": { +"description": "Start of time range. Range is inclusive.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1Control": { +"description": "Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`.", +"id": "GoogleCloudDiscoveryengineV1Control", +"properties": { +"associatedServingConfigIds": { +"description": "Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"boostAction": { +"$ref": "GoogleCloudDiscoveryengineV1ControlBoostAction", +"description": "Defines a boost-type control" +}, +"conditions": { +"description": "Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1Condition" +}, +"type": "array" +}, +"displayName": { +"description": "Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown.", +"type": "string" +}, +"filterAction": { +"$ref": "GoogleCloudDiscoveryengineV1ControlFilterAction", +"description": "Defines a filter-type control Currently not supported by Recommendation" +}, +"name": { +"description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`", +"type": "string" +}, +"redirectAction": { +"$ref": "GoogleCloudDiscoveryengineV1ControlRedirectAction", +"description": "Defines a redirect-type control." +}, +"solutionType": { +"description": "Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.", +"enum": [ +"SOLUTION_TYPE_UNSPECIFIED", +"SOLUTION_TYPE_RECOMMENDATION", +"SOLUTION_TYPE_SEARCH", +"SOLUTION_TYPE_CHAT", +"SOLUTION_TYPE_GENERATIVE_CHAT" +], +"enumDescriptions": [ +"Default value.", +"Used for Recommendations AI.", +"Used for Discovery Search.", +"Used for use cases related to the Generative AI agent.", +"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution." +], +"type": "string" +}, +"synonymsAction": { +"$ref": "GoogleCloudDiscoveryengineV1ControlSynonymsAction", +"description": "Treats a group of terms as synonyms of one another." +}, +"useCases": { +"description": "Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH.", +"items": { +"enum": [ +"SEARCH_USE_CASE_UNSPECIFIED", +"SEARCH_USE_CASE_SEARCH", +"SEARCH_USE_CASE_BROWSE" +], +"enumDescriptions": [ +"Value used when unset. Will not occur in CSS.", +"Search use case. Expects the traffic has a non-empty query.", +"Browse use case. Expects the traffic has an empty query." +], +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1ControlBoostAction": { +"description": "Adjusts order of products in returned list.", +"id": "GoogleCloudDiscoveryengineV1ControlBoostAction", "properties": { -"contentType": { -"description": "The HTTP Content-Type header value specifying the content type of the body.", +"boost": { +"description": "Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).", +"format": "float", +"type": "number" +}, +"dataStore": { +"description": "Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store", "type": "string" }, -"data": { -"description": "The HTTP request/response body as raw binary.", -"format": "byte", +"filter": { +"description": "Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1ControlFilterAction": { +"description": "Specified which products may be included in results. Uses same filter as boost.", +"id": "GoogleCloudDiscoveryengineV1ControlFilterAction", +"properties": { +"dataStore": { +"description": "Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store", +"type": "string" +}, +"filter": { +"description": "Required. A filter to apply on the matching condition results. Required Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1ControlRedirectAction": { +"description": "Redirects a shopper to the provided URI.", +"id": "GoogleCloudDiscoveryengineV1ControlRedirectAction", +"properties": { +"redirectUri": { +"description": "Required. The URI to which the shopper will be redirected. Required. URI must have length equal or less than 2000 characters. Otherwise an INVALID ARGUMENT error is thrown.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1ControlSynonymsAction": { +"description": "Creates a set of terms that will act as synonyms of one another. Example: \"happy\" will also be considered as \"glad\", \"glad\" will also be considered as \"happy\".", +"id": "GoogleCloudDiscoveryengineV1ControlSynonymsAction", +"properties": { +"synonyms": { +"description": "Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1CreateDataStoreMetadata": { +"description": "Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1CreateDataStoreMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1CreateEngineMetadata": { +"description": "Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1CreateEngineMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1CreateSchemaMetadata": { +"description": "Metadata for Create Schema LRO.", +"id": "GoogleCloudDiscoveryengineV1CreateSchemaMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata": { +"description": "Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1DataStore": { +"description": "DataStore captures global settings and configs at the DataStore level.", +"id": "GoogleCloudDiscoveryengineV1DataStore", +"properties": { +"contentConfig": { +"description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", +"enum": [ +"CONTENT_CONFIG_UNSPECIFIED", +"NO_CONTENT", +"CONTENT_REQUIRED", +"PUBLIC_WEBSITE" +], +"enumDescriptions": [ +"Default value.", +"Only contains documents without any Document.content.", +"Only contains documents with Document.content.", +"The data store is used for public website search." +], +"type": "string" +}, +"createTime": { +"description": "Output only. Timestamp the DataStore was created at.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"defaultSchemaId": { +"description": "Output only. The id of the default Schema asscociated to this data store.", +"readOnly": true, +"type": "string" +}, +"displayName": { +"description": "Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.", +"type": "string" +}, +"documentProcessingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfig", +"description": "Configuration for Document understanding and enrichment." +}, +"industryVertical": { +"description": "Immutable. The industry vertical that the data store registers.", +"enum": [ +"INDUSTRY_VERTICAL_UNSPECIFIED", +"GENERIC", +"MEDIA", +"HEALTHCARE_FHIR" +], +"enumDescriptions": [ +"Value used when unset.", +"The generic vertical for documents that are not specific to any industry vertical.", +"The media industry vertical.", +"The healthcare FHIR vertical." +], +"type": "string" +}, +"name": { +"description": "Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"type": "string" +}, +"solutionTypes": { +"description": "The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.", +"items": { +"enum": [ +"SOLUTION_TYPE_UNSPECIFIED", +"SOLUTION_TYPE_RECOMMENDATION", +"SOLUTION_TYPE_SEARCH", +"SOLUTION_TYPE_CHAT", +"SOLUTION_TYPE_GENERATIVE_CHAT" +], +"enumDescriptions": [ +"Default value.", +"Used for Recommendations AI.", +"Used for Discovery Search.", +"Used for use cases related to the Generative AI agent.", +"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution." +], +"type": "string" +}, +"type": "array" +}, +"startingSchema": { +"$ref": "GoogleCloudDiscoveryengineV1Schema", +"description": "The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema)." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata": { +"description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1DeleteEngineMetadata": { +"description": "Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1DeleteEngineMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1DeleteSchemaMetadata": { +"description": "Metadata for DeleteSchema LRO.", +"id": "GoogleCloudDiscoveryengineV1DeleteSchemaMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", "type": "string" }, -"extensions": { -"description": "Application specific response metadata. Must be set in the first response for streaming APIs.", -"items": { -"additionalProperties": { -"description": "Properties of the object. Contains field @type with type URL.", -"type": "any" +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} }, "type": "object" }, -"type": "array" +"GoogleCloudDiscoveryengineV1DeleteTargetSiteMetadata": { +"description": "Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1DeleteTargetSiteMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineLoggingErrorContext": { -"description": "A description of the context in which an error occurred.", -"id": "GoogleCloudDiscoveryengineLoggingErrorContext", +"GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchMetadata": { +"description": "Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchMetadata", "properties": { -"httpRequest": { -"$ref": "GoogleCloudDiscoveryengineLoggingHttpRequestContext", -"description": "The HTTP request which was processed when the error was triggered." +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" }, -"reportLocation": { -"$ref": "GoogleCloudDiscoveryengineLoggingSourceLocation", -"description": "The location in the source code where the decision was made to report the error, usually the place where it was logged." +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineLoggingErrorLog": { -"description": "An error log which is reported to the Error Reporting system.", -"id": "GoogleCloudDiscoveryengineLoggingErrorLog", +"GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchResponse": { +"description": "Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.", +"id": "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchResponse", +"properties": {}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1DocumentProcessingConfig": { +"description": "A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config.", +"id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfig", "properties": { -"context": { -"$ref": "GoogleCloudDiscoveryengineLoggingErrorContext", -"description": "A description of the context in which the error occurred." +"chunkingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig", +"description": "Whether chunking mode is enabled." }, -"importPayload": { -"$ref": "GoogleCloudDiscoveryengineLoggingImportErrorContext", -"description": "The error payload that is populated on LRO import APIs." +"defaultParsingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig", +"description": "Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing." }, -"message": { -"description": "A message describing the error.", +"name": { +"description": "The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.", "type": "string" }, -"requestPayload": { +"parsingConfigOverrides": { "additionalProperties": { -"description": "Properties of the object.", -"type": "any" +"$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig" }, -"description": "The API request payload, represented as a protocol buffer. Most API request types are supported\u2014for example: * `type.googleapis.com/google.cloud.discoveryengine.v1alpha.DocumentService.CreateDocumentRequest` * `type.googleapis.com/google.cloud.discoveryengine.v1alpha.UserEventService.WriteUserEventRequest`", +"description": "Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported.", "type": "object" +} }, -"responsePayload": { -"additionalProperties": { -"description": "Properties of the object.", -"type": "any" -}, -"description": "The API response payload, represented as a protocol buffer. This is used to log some \"soft errors\", where the response is valid but we consider there are some quality issues like unjoined events. The following API responses are supported, and no PII is included: * `google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend` * `google.cloud.discoveryengine.v1alpha.UserEventService.WriteUserEvent` * `google.cloud.discoveryengine.v1alpha.UserEventService.CollectUserEvent`", "type": "object" }, -"serviceContext": { -"$ref": "GoogleCloudDiscoveryengineLoggingServiceContext", -"description": "The service context in which this error has occurred." -}, -"status": { -"$ref": "GoogleRpcStatus", -"description": "The RPC status associated with the error log." +"GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig": { +"description": "Configuration for chunking config.", +"id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig", +"properties": { +"layoutBasedChunkingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", +"description": "Configuration for the layout based chunking." } }, "type": "object" }, -"GoogleCloudDiscoveryengineLoggingHttpRequestContext": { -"description": "HTTP request data that is related to a reported error.", -"id": "GoogleCloudDiscoveryengineLoggingHttpRequestContext", +"GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig": { +"description": "Configuration for the layout based chunking.", +"id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", "properties": { -"responseStatusCode": { -"description": "The HTTP response status code for the request.", +"chunkSize": { +"description": "The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.", "format": "int32", "type": "integer" +}, +"includeAncestorHeadings": { +"description": "Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False.", +"type": "boolean" } }, "type": "object" }, -"GoogleCloudDiscoveryengineLoggingImportErrorContext": { -"description": "The error payload that is populated on LRO import APIs, including the following: * `google.cloud.discoveryengine.v1alpha.DocumentService.ImportDocuments` * `google.cloud.discoveryengine.v1alpha.UserEventService.ImportUserEvents`", -"id": "GoogleCloudDiscoveryengineLoggingImportErrorContext", +"GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig": { +"description": "Related configurations applied to a specific type of document parser.", +"id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig", "properties": { -"document": { -"description": "The detailed content which caused the error on importing a document.", -"type": "string" -}, -"gcsPath": { -"description": "Google Cloud Storage file path of the import source. Can be set for batch operation error.", -"type": "string" -}, -"lineNumber": { -"description": "Line number of the content in file. Should be empty for permission or batch operation error.", -"type": "string" +"digitalParsingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig", +"description": "Configurations applied to digital parser." }, -"operation": { -"description": "The operation resource name of the LRO.", -"type": "string" +"layoutParsingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig", +"description": "Configurations applied to layout parser." }, -"userEvent": { -"description": "The detailed content which caused the error on importing a user event.", -"type": "string" +"ocrParsingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig", +"description": "Configurations applied to OCR parser. Currently it only applies to PDFs." } }, "type": "object" }, -"GoogleCloudDiscoveryengineLoggingServiceContext": { -"description": "Describes a running service that sends errors.", -"id": "GoogleCloudDiscoveryengineLoggingServiceContext", -"properties": { -"service": { -"description": "An identifier of the service\u2014for example, `discoveryengine.googleapis.com`.", -"type": "string" -} +"GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig": { +"description": "The digital parsing configurations for documents.", +"id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig", +"properties": {}, +"type": "object" }, +"GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig": { +"description": "The layout parsing configurations for documents.", +"id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig", +"properties": {}, "type": "object" }, -"GoogleCloudDiscoveryengineLoggingSourceLocation": { -"description": "Indicates a location in the source code of the service for which errors are reported.", -"id": "GoogleCloudDiscoveryengineLoggingSourceLocation", +"GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig": { +"description": "The OCR parsing configurations for documents.", +"id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig", "properties": { -"functionName": { -"description": "Human-readable name of a function or method\u2014for example, `google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend`.", +"enhancedDocumentElements": { +"deprecated": true, +"description": "[DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.", +"items": { "type": "string" +}, +"type": "array" +}, +"useNativeText": { +"description": "If true, will use native text instead of OCR text on pages containing native text.", +"type": "boolean" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata": { -"description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata", +"GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchMetadata": { +"description": "Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -6341,114 +7382,72 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1BatchCreateTargetSitesResponse": { -"description": "Response message for SiteSearchEngineService.BatchCreateTargetSites method.", -"id": "GoogleCloudDiscoveryengineV1BatchCreateTargetSitesResponse", -"properties": { -"targetSites": { -"description": "TargetSites created.", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1TargetSite" -}, -"type": "array" -} -}, -"type": "object" -}, -"GoogleCloudDiscoveryengineV1Condition": { -"description": "Defines circumstances to be checked before allowing a behavior", -"id": "GoogleCloudDiscoveryengineV1Condition", -"properties": { -"activeTimeRange": { -"description": "Range of time(s) specifying when condition is active. Maximum of 10 time ranges.", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1ConditionTimeRange" -}, -"type": "array" -}, -"queryTerms": { -"description": "Search only A list of terms to match the query on. Maximum of 10 query terms.", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1ConditionQueryTerm" -}, -"type": "array" -} -}, +"GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchResponse": { +"description": "Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.", +"id": "GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchResponse", +"properties": {}, "type": "object" }, -"GoogleCloudDiscoveryengineV1ConditionQueryTerm": { -"description": "Matcher for search request query", -"id": "GoogleCloudDiscoveryengineV1ConditionQueryTerm", +"GoogleCloudDiscoveryengineV1Engine": { +"description": "Metadata that describes the training and serving parameters of an Engine.", +"id": "GoogleCloudDiscoveryengineV1Engine", "properties": { -"fullMatch": { -"description": "Whether the search query needs to exactly match the query term.", -"type": "boolean" -}, -"value": { -"description": "The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters.", -"type": "string" -} +"chatEngineConfig": { +"$ref": "GoogleCloudDiscoveryengineV1EngineChatEngineConfig", +"description": "Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT." }, -"type": "object" +"chatEngineMetadata": { +"$ref": "GoogleCloudDiscoveryengineV1EngineChatEngineMetadata", +"description": "Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.", +"readOnly": true }, -"GoogleCloudDiscoveryengineV1ConditionTimeRange": { -"description": "Used for time-dependent conditions.", -"id": "GoogleCloudDiscoveryengineV1ConditionTimeRange", -"properties": { -"endTime": { -"description": "End of time range. Range is inclusive. Must be in the future.", -"format": "google-datetime", -"type": "string" +"commonConfig": { +"$ref": "GoogleCloudDiscoveryengineV1EngineCommonConfig", +"description": "Common config spec that specifies the metadata of the engine." }, -"startTime": { -"description": "Start of time range. Range is inclusive.", +"createTime": { +"description": "Output only. Timestamp the Recommendation Engine was created at.", "format": "google-datetime", +"readOnly": true, "type": "string" -} }, -"type": "object" -}, -"GoogleCloudDiscoveryengineV1Control": { -"description": "Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`.", -"id": "GoogleCloudDiscoveryengineV1Control", -"properties": { -"associatedServingConfigIds": { -"description": "Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes.", +"dataStoreIds": { +"description": "The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.", "items": { "type": "string" }, -"readOnly": true, -"type": "array" -}, -"boostAction": { -"$ref": "GoogleCloudDiscoveryengineV1ControlBoostAction", -"description": "Defines a boost-type control" -}, -"conditions": { -"description": "Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown.", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1Condition" -}, "type": "array" }, "displayName": { -"description": "Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown.", +"description": "Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.", "type": "string" }, -"filterAction": { -"$ref": "GoogleCloudDiscoveryengineV1ControlFilterAction", -"description": "Defines a filter-type control Currently not supported by Recommendation" +"industryVertical": { +"description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore linked to the engine.", +"enum": [ +"INDUSTRY_VERTICAL_UNSPECIFIED", +"GENERIC", +"MEDIA", +"HEALTHCARE_FHIR" +], +"enumDescriptions": [ +"Value used when unset.", +"The generic vertical for documents that are not specific to any industry vertical.", +"The media industry vertical.", +"The healthcare FHIR vertical." +], +"type": "string" }, "name": { -"description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`", +"description": "Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.", "type": "string" }, -"redirectAction": { -"$ref": "GoogleCloudDiscoveryengineV1ControlRedirectAction", -"description": "Defines a redirect-type control." +"searchEngineConfig": { +"$ref": "GoogleCloudDiscoveryengineV1EngineSearchEngineConfig", +"description": "Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH." }, "solutionType": { -"description": "Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.", +"description": "Required. The solutions of the engine.", "enum": [ "SOLUTION_TYPE_UNSPECIFIED", "SOLUTION_TYPE_RECOMMENDATION", @@ -6465,131 +7464,128 @@ ], "type": "string" }, -"synonymsAction": { -"$ref": "GoogleCloudDiscoveryengineV1ControlSynonymsAction", -"description": "Treats a group of terms as synonyms of one another." -}, -"useCases": { -"description": "Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH.", -"items": { -"enum": [ -"SEARCH_USE_CASE_UNSPECIFIED", -"SEARCH_USE_CASE_SEARCH", -"SEARCH_USE_CASE_BROWSE" -], -"enumDescriptions": [ -"Value used when unset. Will not occur in CSS.", -"Search use case. Expects the traffic has a non-empty query.", -"Browse use case. Expects the traffic has an empty query." -], +"updateTime": { +"description": "Output only. Timestamp the Recommendation Engine was last updated.", +"format": "google-datetime", +"readOnly": true, "type": "string" -}, -"type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1ControlBoostAction": { -"description": "Adjusts order of products in returned list.", -"id": "GoogleCloudDiscoveryengineV1ControlBoostAction", +"GoogleCloudDiscoveryengineV1EngineChatEngineConfig": { +"description": "Configurations for a Chat Engine.", +"id": "GoogleCloudDiscoveryengineV1EngineChatEngineConfig", "properties": { -"boost": { -"description": "Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).", -"format": "float", -"type": "number" -}, -"dataStore": { -"description": "Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store", -"type": "string" +"agentCreationConfig": { +"$ref": "GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig", +"description": "The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation." }, -"filter": { -"description": "Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.", +"dialogflowAgentToLink": { +"description": "The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1ControlFilterAction": { -"description": "Specified which products may be included in results. Uses same filter as boost.", -"id": "GoogleCloudDiscoveryengineV1ControlFilterAction", +"GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig": { +"description": "Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.", +"id": "GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig", "properties": { -"dataStore": { -"description": "Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store", +"business": { +"description": "Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.", "type": "string" }, -"filter": { -"description": "Required. A filter to apply on the matching condition results. Required Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.", +"defaultLanguageCode": { +"description": "Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes.", +"type": "string" +}, +"location": { +"description": "Agent location for Agent creation, supported values: global/us/eu. If not provided, us Engine will create Agent using us-central-1 by default; eu Engine will create Agent using eu-west-1 by default.", +"type": "string" +}, +"timeZone": { +"description": "Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1ControlRedirectAction": { -"description": "Redirects a shopper to the provided URI.", -"id": "GoogleCloudDiscoveryengineV1ControlRedirectAction", +"GoogleCloudDiscoveryengineV1EngineChatEngineMetadata": { +"description": "Additional information of a Chat Engine. Fields in this message are output only.", +"id": "GoogleCloudDiscoveryengineV1EngineChatEngineMetadata", "properties": { -"redirectUri": { -"description": "Required. The URI to which the shopper will be redirected. Required. URI must have length equal or less than 2000 characters. Otherwise an INVALID ARGUMENT error is thrown.", +"dialogflowAgent": { +"description": "The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1ControlSynonymsAction": { -"description": "Creates a set of terms that will act as synonyms of one another. Example: \"happy\" will also be considered as \"glad\", \"glad\" will also be considered as \"happy\".", -"id": "GoogleCloudDiscoveryengineV1ControlSynonymsAction", +"GoogleCloudDiscoveryengineV1EngineCommonConfig": { +"description": "Common configurations for an Engine.", +"id": "GoogleCloudDiscoveryengineV1EngineCommonConfig", "properties": { -"synonyms": { -"description": "Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown.", -"items": { +"companyName": { +"description": "The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.", "type": "string" -}, -"type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1CreateDataStoreMetadata": { -"description": "Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1CreateDataStoreMetadata", +"GoogleCloudDiscoveryengineV1EngineSearchEngineConfig": { +"description": "Configurations for a Search Engine.", +"id": "GoogleCloudDiscoveryengineV1EngineSearchEngineConfig", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"searchAddOns": { +"description": "The add-on that this search engine enables.", +"items": { +"enum": [ +"SEARCH_ADD_ON_UNSPECIFIED", +"SEARCH_ADD_ON_LLM" +], +"enumDescriptions": [ +"Default value when the enum is unspecified. This is invalid to use.", +"Large language model add-on." +], "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"type": "array" +}, +"searchTier": { +"description": "The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified.", +"enum": [ +"SEARCH_TIER_UNSPECIFIED", +"SEARCH_TIER_STANDARD", +"SEARCH_TIER_ENTERPRISE" +], +"enumDescriptions": [ +"Default value when the enum is unspecified. This is invalid to use.", +"Standard tier.", +"Enterprise tier." +], "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1CreateEngineMetadata": { -"description": "Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1CreateEngineMetadata", +"GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsMetadata": { +"description": "Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsMetadata", "properties": { "createTime": { "description": "Operation create time.", "format": "google-datetime", "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"failureCount": { +"description": "Count of CompletionSuggestions that failed to be imported.", +"format": "int64", "type": "string" -} -}, -"type": "object" }, -"GoogleCloudDiscoveryengineV1CreateSchemaMetadata": { -"description": "Metadata for Create Schema LRO.", -"id": "GoogleCloudDiscoveryengineV1CreateSchemaMetadata", -"properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"successCount": { +"description": "Count of CompletionSuggestions successfully imported.", +"format": "int64", "type": "string" }, "updateTime": { @@ -6600,113 +7596,88 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata": { -"description": "Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata", +"GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsResponse": { +"description": "Response of the CompletionService.ImportCompletionSuggestions method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.", +"id": "GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsResponse", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", -"type": "string" +"errorConfig": { +"$ref": "GoogleCloudDiscoveryengineV1ImportErrorConfig", +"description": "The desired location of errors incurred during the Import." }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", -"type": "string" +"errorSamples": { +"description": "A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1DataStore": { -"description": "DataStore captures global settings and configs at the DataStore level.", -"id": "GoogleCloudDiscoveryengineV1DataStore", -"properties": { -"contentConfig": { -"description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", -"enum": [ -"CONTENT_CONFIG_UNSPECIFIED", -"NO_CONTENT", -"CONTENT_REQUIRED", -"PUBLIC_WEBSITE" -], -"enumDescriptions": [ -"Default value.", -"Only contains documents without any Document.content.", -"Only contains documents with Document.content.", -"The data store is used for public website search." -], -"type": "string" -}, +"GoogleCloudDiscoveryengineV1ImportDocumentsMetadata": { +"description": "Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1ImportDocumentsMetadata", +"properties": { "createTime": { -"description": "Output only. Timestamp the DataStore was created at.", +"description": "Operation create time.", "format": "google-datetime", -"readOnly": true, "type": "string" }, -"defaultSchemaId": { -"description": "Output only. The id of the default Schema asscociated to this data store.", -"readOnly": true, +"failureCount": { +"description": "Count of entries that encountered errors while processing.", +"format": "int64", "type": "string" }, -"displayName": { -"description": "Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.", +"successCount": { +"description": "Count of entries that were processed successfully.", +"format": "int64", "type": "string" }, -"documentProcessingConfig": { -"$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfig", -"description": "Configuration for Document understanding and enrichment." -}, -"industryVertical": { -"description": "Immutable. The industry vertical that the data store registers.", -"enum": [ -"INDUSTRY_VERTICAL_UNSPECIFIED", -"GENERIC", -"MEDIA", -"HEALTHCARE_FHIR" -], -"enumDescriptions": [ -"Value used when unset.", -"The generic vertical for documents that are not specific to any industry vertical.", -"The media industry vertical.", -"The healthcare FHIR vertical." -], +"totalCount": { +"description": "Total count of entries that were processed.", +"format": "int64", "type": "string" }, -"name": { -"description": "Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", "type": "string" +} }, -"solutionTypes": { -"description": "The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.", +"type": "object" +}, +"GoogleCloudDiscoveryengineV1ImportDocumentsResponse": { +"description": "Response of the ImportDocumentsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", +"id": "GoogleCloudDiscoveryengineV1ImportDocumentsResponse", +"properties": { +"errorConfig": { +"$ref": "GoogleCloudDiscoveryengineV1ImportErrorConfig", +"description": "Echoes the destination for the complete errors in the request if set." +}, +"errorSamples": { +"description": "A sample of errors encountered while processing the request.", "items": { -"enum": [ -"SOLUTION_TYPE_UNSPECIFIED", -"SOLUTION_TYPE_RECOMMENDATION", -"SOLUTION_TYPE_SEARCH", -"SOLUTION_TYPE_CHAT", -"SOLUTION_TYPE_GENERATIVE_CHAT" -], -"enumDescriptions": [ -"Default value.", -"Used for Recommendations AI.", -"Used for Discovery Search.", -"Used for use cases related to the Generative AI agent.", -"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution." -], -"type": "string" +"$ref": "GoogleRpcStatus" }, "type": "array" +} }, -"startingSchema": { -"$ref": "GoogleCloudDiscoveryengineV1Schema", -"description": "The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema)." +"type": "object" +}, +"GoogleCloudDiscoveryengineV1ImportErrorConfig": { +"description": "Configuration of destination for Import related errors.", +"id": "GoogleCloudDiscoveryengineV1ImportErrorConfig", +"properties": { +"gcsPrefix": { +"description": "Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.", +"type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata": { -"description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata", +"GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesMetadata": { +"description": "Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -6721,32 +7692,49 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1DeleteEngineMetadata": { -"description": "Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1DeleteEngineMetadata", +"GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesResponse": { +"description": "Response message for CompletionService.ImportSuggestionDenyListEntries method.", +"id": "GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesResponse", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"errorSamples": { +"description": "A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"type": "array" +}, +"failedEntriesCount": { +"description": "Count of deny list entries that failed to be imported.", +"format": "int64", "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"importedEntriesCount": { +"description": "Count of deny list entries successfully imported.", +"format": "int64", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1DeleteSchemaMetadata": { -"description": "Metadata for DeleteSchema LRO.", -"id": "GoogleCloudDiscoveryengineV1DeleteSchemaMetadata", +"GoogleCloudDiscoveryengineV1ImportUserEventsMetadata": { +"description": "Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1ImportUserEventsMetadata", "properties": { "createTime": { "description": "Operation create time.", "format": "google-datetime", "type": "string" }, +"failureCount": { +"description": "Count of entries that encountered errors while processing.", +"format": "int64", +"type": "string" +}, +"successCount": { +"description": "Count of entries that were processed successfully.", +"format": "int64", +"type": "string" +}, "updateTime": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime", @@ -6755,152 +7743,202 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1DeleteTargetSiteMetadata": { -"description": "Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1DeleteTargetSiteMetadata", +"GoogleCloudDiscoveryengineV1ImportUserEventsResponse": { +"description": "Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", +"id": "GoogleCloudDiscoveryengineV1ImportUserEventsResponse", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"errorConfig": { +"$ref": "GoogleCloudDiscoveryengineV1ImportErrorConfig", +"description": "Echoes the destination for the complete errors if this field was set in the request." +}, +"errorSamples": { +"description": "A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"type": "array" +}, +"joinedEventsCount": { +"description": "Count of user events imported with complete existing Documents.", +"format": "int64", "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"unjoinedEventsCount": { +"description": "Count of user events imported, but with Document information not found in the existing Branch.", +"format": "int64", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchMetadata": { -"description": "Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchMetadata", +"GoogleCloudDiscoveryengineV1Project": { +"description": "Metadata and configurations for a Google Cloud project in the service.", +"id": "GoogleCloudDiscoveryengineV1Project", "properties": { "createTime": { -"description": "Operation create time.", +"description": "Output only. The timestamp when this project is created.", "format": "google-datetime", +"readOnly": true, "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", +"name": { +"description": "Output only. Full resource name of the project, for example `projects/{project_number}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.", +"readOnly": true, +"type": "string" +}, +"provisionCompletionTime": { +"description": "Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use.", "format": "google-datetime", +"readOnly": true, "type": "string" -} }, +"serviceTermsMap": { +"additionalProperties": { +"$ref": "GoogleCloudDiscoveryengineV1ProjectServiceTerms" +}, +"description": "Output only. A map of terms of services. The key is the `id` of ServiceTerms.", +"readOnly": true, "type": "object" +} }, -"GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchResponse": { -"description": "Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.", -"id": "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchResponse", -"properties": {}, "type": "object" }, -"GoogleCloudDiscoveryengineV1DocumentProcessingConfig": { -"description": "A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config.", -"id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfig", +"GoogleCloudDiscoveryengineV1ProjectServiceTerms": { +"description": "Metadata about the terms of service.", +"id": "GoogleCloudDiscoveryengineV1ProjectServiceTerms", "properties": { -"chunkingConfig": { -"$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig", -"description": "Whether chunking mode is enabled." +"acceptTime": { +"description": "The last time when the project agreed to the terms of service.", +"format": "google-datetime", +"type": "string" }, -"defaultParsingConfig": { -"$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig", -"description": "Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing." +"declineTime": { +"description": "The last time when the project declined or revoked the agreement to terms of service.", +"format": "google-datetime", +"type": "string" }, -"name": { -"description": "The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.", +"id": { +"description": "The unique identifier of this terms of service. Available terms: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this as `id`, the acceptable version to provide is `2022-11-23`.", "type": "string" }, -"parsingConfigOverrides": { -"additionalProperties": { -"$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig" +"state": { +"description": "Whether the project has accepted/rejected the service terms or it is still pending.", +"enum": [ +"STATE_UNSPECIFIED", +"TERMS_ACCEPTED", +"TERMS_PENDING", +"TERMS_DECLINED" +], +"enumDescriptions": [ +"The default value of the enum. This value is not actually used.", +"The project has given consent to the terms of service.", +"The project is pending to review and accept the terms of service.", +"The project has declined or revoked the agreement to terms of service." +], +"type": "string" }, -"description": "Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported.", -"type": "object" +"version": { +"description": "The version string of the terms of service. For acceptable values, see the comments for id above.", +"type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig": { -"description": "Configuration for chunking config.", -"id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig", +"GoogleCloudDiscoveryengineV1ProvisionProjectMetadata": { +"description": "Metadata associated with a project provision operation.", +"id": "GoogleCloudDiscoveryengineV1ProvisionProjectMetadata", +"properties": {}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsMetadata": { +"description": "Metadata related to the progress of the PurgeCompletionSuggestions operation. This is returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsMetadata", "properties": { -"layoutBasedChunkingConfig": { -"$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", -"description": "Configuration for the layout based chunking." +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig": { -"description": "Configuration for the layout based chunking.", -"id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", +"GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsResponse": { +"description": "Response message for CompletionService.PurgeCompletionSuggestions method.", +"id": "GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsResponse", "properties": { -"chunkSize": { -"description": "The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.", -"format": "int32", -"type": "integer" +"errorSamples": { +"description": "A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" }, -"includeAncestorHeadings": { -"description": "Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False.", +"type": "array" +}, +"purgeSucceeded": { +"description": "Whether the completion suggestions were successfully purged.", "type": "boolean" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig": { -"description": "Related configurations applied to a specific type of document parser.", -"id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig", +"GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata": { +"description": "Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata", "properties": { -"digitalParsingConfig": { -"$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig", -"description": "Configurations applied to digital parser." +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" }, -"layoutParsingConfig": { -"$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig", -"description": "Configurations applied to layout parser." +"failureCount": { +"description": "Count of entries that encountered errors while processing.", +"format": "int64", +"type": "string" }, -"ocrParsingConfig": { -"$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig", -"description": "Configurations applied to OCR parser. Currently it only applies to PDFs." -} +"ignoredCount": { +"description": "Count of entries that were ignored as entries were not found.", +"format": "int64", +"type": "string" }, -"type": "object" +"successCount": { +"description": "Count of entries that were deleted successfully.", +"format": "int64", +"type": "string" }, -"GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig": { -"description": "The digital parsing configurations for documents.", -"id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig", -"properties": {}, -"type": "object" +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} }, -"GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig": { -"description": "The layout parsing configurations for documents.", -"id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig", -"properties": {}, "type": "object" }, -"GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig": { -"description": "The OCR parsing configurations for documents.", -"id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig", +"GoogleCloudDiscoveryengineV1PurgeDocumentsResponse": { +"description": "Response message for DocumentService.PurgeDocuments method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.", +"id": "GoogleCloudDiscoveryengineV1PurgeDocumentsResponse", "properties": { -"enhancedDocumentElements": { -"deprecated": true, -"description": "[DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.", +"purgeCount": { +"description": "The total count of documents purged as a result of the operation.", +"format": "int64", +"type": "string" +}, +"purgeSample": { +"description": "A sample of document names that will be deleted. Only populated if `force` is set to false. A max of 100 names will be returned and the names are chosen at random.", "items": { "type": "string" }, "type": "array" -}, -"useNativeText": { -"description": "If true, will use native text instead of OCR text on pages containing native text.", -"type": "boolean" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchMetadata": { -"description": "Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchMetadata", +"GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesMetadata": { +"description": "Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -6915,90 +7953,148 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchResponse": { -"description": "Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.", -"id": "GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchResponse", -"properties": {}, +"GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesResponse": { +"description": "Response message for CompletionService.PurgeSuggestionDenyListEntries method.", +"id": "GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesResponse", +"properties": { +"errorSamples": { +"description": "A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"type": "array" +}, +"purgeCount": { +"description": "Number of suggestion deny list entries purged.", +"format": "int64", +"type": "string" +} +}, "type": "object" }, -"GoogleCloudDiscoveryengineV1Engine": { -"description": "Metadata that describes the training and serving parameters of an Engine.", -"id": "GoogleCloudDiscoveryengineV1Engine", +"GoogleCloudDiscoveryengineV1Schema": { +"description": "Defines the structure and layout of a type of document data.", +"id": "GoogleCloudDiscoveryengineV1Schema", "properties": { -"chatEngineConfig": { -"$ref": "GoogleCloudDiscoveryengineV1EngineChatEngineConfig", -"description": "Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT." +"jsonSchema": { +"description": "The JSON representation of the schema.", +"type": "string" }, -"chatEngineMetadata": { -"$ref": "GoogleCloudDiscoveryengineV1EngineChatEngineMetadata", -"description": "Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.", -"readOnly": true +"name": { +"description": "Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"type": "string" }, -"commonConfig": { -"$ref": "GoogleCloudDiscoveryengineV1EngineCommonConfig", -"description": "Common config spec that specifies the metadata of the engine." +"structSchema": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" }, -"createTime": { -"description": "Output only. Timestamp the Recommendation Engine was created at.", -"format": "google-datetime", -"readOnly": true, +"description": "The structured representation of the schema.", +"type": "object" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1SiteVerificationInfo": { +"description": "Verification information for target sites in advanced site search.", +"id": "GoogleCloudDiscoveryengineV1SiteVerificationInfo", +"properties": { +"siteVerificationState": { +"description": "Site verification state indicating the ownership and validity.", +"enum": [ +"SITE_VERIFICATION_STATE_UNSPECIFIED", +"VERIFIED", +"UNVERIFIED", +"EXEMPTED" +], +"enumDescriptions": [ +"Defaults to VERIFIED.", +"Site ownership verified.", +"Site ownership pending verification or verification failed.", +"Site exempt from verification, e.g., a public website that opens to all." +], "type": "string" }, -"dataStoreIds": { -"description": "The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.", -"items": { +"verifyTime": { +"description": "Latest site verification time.", +"format": "google-datetime", "type": "string" +} }, -"type": "array" +"type": "object" }, -"displayName": { -"description": "Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.", +"GoogleCloudDiscoveryengineV1TargetSite": { +"description": "A target site for the SiteSearchEngine.", +"id": "GoogleCloudDiscoveryengineV1TargetSite", +"properties": { +"exactMatch": { +"description": "Input only. If set to false, a uri_pattern is generated to include all pages whose address contains the provided_uri_pattern. If set to true, an uri_pattern is generated to try to be an exact match of the provided_uri_pattern or just the specific page if the provided_uri_pattern is a specific one. provided_uri_pattern is always normalized to generate the URI pattern to be used by the search engine.", +"type": "boolean" +}, +"failureReason": { +"$ref": "GoogleCloudDiscoveryengineV1TargetSiteFailureReason", +"description": "Output only. Failure reason.", +"readOnly": true +}, +"generatedUriPattern": { +"description": "Output only. This is system-generated based on the provided_uri_pattern.", +"readOnly": true, "type": "string" }, -"industryVertical": { -"description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore linked to the engine.", +"indexingStatus": { +"description": "Output only. Indexing status.", "enum": [ -"INDUSTRY_VERTICAL_UNSPECIFIED", -"GENERIC", -"MEDIA", -"HEALTHCARE_FHIR" +"INDEXING_STATUS_UNSPECIFIED", +"PENDING", +"FAILED", +"SUCCEEDED", +"DELETING" ], "enumDescriptions": [ -"Value used when unset.", -"The generic vertical for documents that are not specific to any industry vertical.", -"The media industry vertical.", -"The healthcare FHIR vertical." +"Defaults to SUCCEEDED.", +"The target site is in the update queue and will be picked up by indexing pipeline.", +"The target site fails to be indexed.", +"The target site has been indexed.", +"The previously indexed target site has been marked to be deleted. This is a transitioning state which will resulted in either: 1. target site deleted if unindexing is successful; 2. state reverts to SUCCEEDED if the unindexing fails." ], +"readOnly": true, "type": "string" }, "name": { -"description": "Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.", +"description": "Output only. The fully qualified resource name of the target site. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}` The `target_site_id` is system-generated.", +"readOnly": true, "type": "string" }, -"searchEngineConfig": { -"$ref": "GoogleCloudDiscoveryengineV1EngineSearchEngineConfig", -"description": "Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH." +"providedUriPattern": { +"description": "Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated.", +"type": "string" }, -"solutionType": { -"description": "Required. The solutions of the engine.", +"rootDomainUri": { +"description": "Output only. Root domain of the provided_uri_pattern.", +"readOnly": true, +"type": "string" +}, +"siteVerificationInfo": { +"$ref": "GoogleCloudDiscoveryengineV1SiteVerificationInfo", +"description": "Output only. Site ownership and validity verification status.", +"readOnly": true +}, +"type": { +"description": "The type of the target site, e.g., whether the site is to be included or excluded.", "enum": [ -"SOLUTION_TYPE_UNSPECIFIED", -"SOLUTION_TYPE_RECOMMENDATION", -"SOLUTION_TYPE_SEARCH", -"SOLUTION_TYPE_CHAT", -"SOLUTION_TYPE_GENERATIVE_CHAT" +"TYPE_UNSPECIFIED", +"INCLUDE", +"EXCLUDE" ], "enumDescriptions": [ -"Default value.", -"Used for Recommendations AI.", -"Used for Discovery Search.", -"Used for use cases related to the Generative AI agent.", -"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution." +"This value is unused. In this case, server behavior defaults to Type.INCLUDE.", +"Include the target site.", +"Exclude the target site." ], "type": "string" }, "updateTime": { -"description": "Output only. Timestamp the Recommendation Engine was last updated.", +"description": "Output only. The target site's last updated time.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -7006,386 +8102,525 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1EngineChatEngineConfig": { -"description": "Configurations for a Chat Engine.", -"id": "GoogleCloudDiscoveryengineV1EngineChatEngineConfig", +"GoogleCloudDiscoveryengineV1TargetSiteFailureReason": { +"description": "Site search indexing failure reasons.", +"id": "GoogleCloudDiscoveryengineV1TargetSiteFailureReason", "properties": { -"agentCreationConfig": { -"$ref": "GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig", -"description": "The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation." -}, -"dialogflowAgentToLink": { -"description": "The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.", -"type": "string" +"quotaFailure": { +"$ref": "GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure", +"description": "Failed due to insufficient quota." } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig": { -"description": "Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.", -"id": "GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig", +"GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure": { +"description": "Failed due to insufficient quota.", +"id": "GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure", "properties": { -"business": { -"description": "Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.", +"totalRequiredQuota": { +"description": "This number is an estimation on how much total quota this project needs to successfully complete indexing.", +"format": "int64", "type": "string" +} }, -"defaultLanguageCode": { -"description": "Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes.", -"type": "string" +"type": "object" }, -"location": { -"description": "Agent location for Agent creation, supported values: global/us/eu. If not provided, us Engine will create Agent using us-central-1 by default; eu Engine will create Agent using eu-west-1 by default.", +"GoogleCloudDiscoveryengineV1UpdateSchemaMetadata": { +"description": "Metadata for UpdateSchema LRO.", +"id": "GoogleCloudDiscoveryengineV1UpdateSchemaMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", "type": "string" }, -"timeZone": { -"description": "Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.", +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1EngineChatEngineMetadata": { -"description": "Additional information of a Chat Engine. Fields in this message are output only.", -"id": "GoogleCloudDiscoveryengineV1EngineChatEngineMetadata", +"GoogleCloudDiscoveryengineV1UpdateTargetSiteMetadata": { +"description": "Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1UpdateTargetSiteMetadata", "properties": { -"dialogflowAgent": { -"description": "The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`.", +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1EngineCommonConfig": { -"description": "Common configurations for an Engine.", -"id": "GoogleCloudDiscoveryengineV1EngineCommonConfig", +"GoogleCloudDiscoveryengineV1alphaAclConfig": { +"description": "Access Control Configuration.", +"id": "GoogleCloudDiscoveryengineV1alphaAclConfig", "properties": { -"companyName": { -"description": "The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.", +"idpConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaIdpConfig", +"description": "Identity provider config." +}, +"name": { +"description": "Immutable. The full resource name of the acl configuration. Format: `projects/{project}/locations/{location}/aclConfig`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1EngineSearchEngineConfig": { -"description": "Configurations for a Search Engine.", -"id": "GoogleCloudDiscoveryengineV1EngineSearchEngineConfig", +"GoogleCloudDiscoveryengineV1alphaAnswer": { +"description": "Defines an answer.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswer", "properties": { -"searchAddOns": { -"description": "The add-on that this search engine enables.", +"answerSkippedReasons": { +"description": "Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.", "items": { "enum": [ -"SEARCH_ADD_ON_UNSPECIFIED", -"SEARCH_ADD_ON_LLM" +"ANSWER_SKIPPED_REASON_UNSPECIFIED", +"ADVERSARIAL_QUERY_IGNORED", +"NON_ANSWER_SEEKING_QUERY_IGNORED", +"OUT_OF_DOMAIN_QUERY_IGNORED", +"POTENTIAL_POLICY_VIOLATION", +"NO_RELEVANT_CONTENT" ], "enumDescriptions": [ -"Default value when the enum is unspecified. This is invalid to use.", -"Large language model add-on." +"Default value. The answer skipped reason is not specified.", +"The adversarial query ignored case.", +"The non-answer seeking query ignored case.", +"The out-of-domain query ignored case. Google skips the answer if there are no high-relevance search results.", +"The potential policy violation case. Google skips the answer if there is a potential policy violation detected. This includes content that may be violent or toxic.", +"The no relevant content case. Google skips the answer if there is no relevant content in the retrieved search results." ], "type": "string" }, "type": "array" }, -"searchTier": { -"description": "The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified.", +"answerText": { +"description": "The textual answer.", +"type": "string" +}, +"citations": { +"description": "Citations.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerCitation" +}, +"type": "array" +}, +"completeTime": { +"description": "Output only. Answer completed timestamp.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"createTime": { +"description": "Output only. Answer creation timestamp.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*`", +"type": "string" +}, +"queryUnderstandingInfo": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo", +"description": "Query understanding information." +}, +"references": { +"description": "References.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReference" +}, +"type": "array" +}, +"relatedQuestions": { +"description": "Suggested related questions.", +"items": { +"type": "string" +}, +"type": "array" +}, +"state": { +"description": "The state of the answer generation.", "enum": [ -"SEARCH_TIER_UNSPECIFIED", -"SEARCH_TIER_STANDARD", -"SEARCH_TIER_ENTERPRISE" +"STATE_UNSPECIFIED", +"IN_PROGRESS", +"FAILED", +"SUCCEEDED" ], "enumDescriptions": [ -"Default value when the enum is unspecified. This is invalid to use.", -"Standard tier.", -"Enterprise tier." +"Unknown.", +"Answer generation is currently in progress.", +"Answer generation currently failed.", +"Answer generation has succeeded." ], "type": "string" +}, +"steps": { +"description": "Answer generation steps.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStep" +}, +"type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsMetadata": { -"description": "Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsMetadata", +"GoogleCloudDiscoveryengineV1alphaAnswerCitation": { +"description": "Citation info for a segment.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerCitation", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"endIndex": { +"description": "End of the attributed segment, exclusive.", +"format": "int64", "type": "string" }, -"failureCount": { -"description": "Count of CompletionSuggestions that failed to be imported.", +"sources": { +"description": "Citation sources for the attributed segment.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerCitationSource" +}, +"type": "array" +}, +"startIndex": { +"description": "Index indicates the start of the segment, measured in bytes (UTF-8 unicode).", "format": "int64", "type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAnswerCitationSource": { +"description": "Citation source.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerCitationSource", +"properties": { +"referenceId": { +"description": "ID of the citation source.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo": { +"description": "Query understanding information.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo", +"properties": { +"queryClassificationInfo": { +"description": "Query classification information.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo": { +"description": "Query classification information.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo", +"properties": { +"positive": { +"description": "Classification output.", +"type": "boolean" +}, +"type": { +"description": "Query classification type.", +"enum": [ +"TYPE_UNSPECIFIED", +"ADVERSARIAL_QUERY", +"NON_ANSWER_SEEKING_QUERY" +], +"enumDescriptions": [ +"Unspecified query classification type.", +"Adversarial query classification type.", +"Non-answer-seeking query classification type." +], +"type": "string" +} }, -"successCount": { -"description": "Count of CompletionSuggestions successfully imported.", -"format": "int64", -"type": "string" +"type": "object" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", -"type": "string" +"GoogleCloudDiscoveryengineV1alphaAnswerReference": { +"description": "Reference.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerReference", +"properties": { +"chunkInfo": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo", +"description": "Chunk information." +}, +"unstructuredDocumentInfo": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo", +"description": "Unstructured document information." } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsResponse": { -"description": "Response of the CompletionService.ImportCompletionSuggestions method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.", -"id": "GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsResponse", +"GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo": { +"description": "Chunk information.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo", "properties": { -"errorConfig": { -"$ref": "GoogleCloudDiscoveryengineV1ImportErrorConfig", -"description": "The desired location of errors incurred during the Import." +"chunk": { +"description": "Chunk resource name.", +"type": "string" }, -"errorSamples": { -"description": "A sample of errors encountered while processing the request.", -"items": { -"$ref": "GoogleRpcStatus" +"content": { +"description": "Chunk textual content.", +"type": "string" }, -"type": "array" +"documentMetadata": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata", +"description": "Document metadata." +}, +"relevanceScore": { +"description": "Relevance score.", +"format": "float", +"type": "number" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1ImportDocumentsMetadata": { -"description": "Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1ImportDocumentsMetadata", +"GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata": { +"description": "Document metadata.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"document": { +"description": "Document resource name.", "type": "string" }, -"failureCount": { -"description": "Count of entries that encountered errors while processing.", -"format": "int64", +"pageIdentifier": { +"description": "Page identifier.", "type": "string" }, -"successCount": { -"description": "Count of entries that were processed successfully.", -"format": "int64", -"type": "string" +"structData": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" }, -"totalCount": { -"description": "Total count of entries that were processed.", -"format": "int64", +"description": "The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result.", +"type": "object" +}, +"title": { +"description": "Title.", "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"uri": { +"description": "URI for the document.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1ImportDocumentsResponse": { -"description": "Response of the ImportDocumentsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", -"id": "GoogleCloudDiscoveryengineV1ImportDocumentsResponse", +"GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo": { +"description": "Unstructured document information.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo", "properties": { -"errorConfig": { -"$ref": "GoogleCloudDiscoveryengineV1ImportErrorConfig", -"description": "Echoes the destination for the complete errors in the request if set." -}, -"errorSamples": { -"description": "A sample of errors encountered while processing the request.", +"chunkContents": { +"description": "List of cited chunk contents derived from document content.", "items": { -"$ref": "GoogleRpcStatus" +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent" }, "type": "array" -} }, +"document": { +"description": "Document resource name.", +"type": "string" +}, +"structData": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result.", "type": "object" }, -"GoogleCloudDiscoveryengineV1ImportErrorConfig": { -"description": "Configuration of destination for Import related errors.", -"id": "GoogleCloudDiscoveryengineV1ImportErrorConfig", -"properties": { -"gcsPrefix": { -"description": "Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.", +"title": { +"description": "Title.", +"type": "string" +}, +"uri": { +"description": "URI for the document.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesMetadata": { -"description": "Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesMetadata", +"GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent": { +"description": "Chunk content.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"content": { +"description": "Chunk textual content.", "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"pageIdentifier": { +"description": "Page identifier.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesResponse": { -"description": "Response message for CompletionService.ImportSuggestionDenyListEntries method.", -"id": "GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesResponse", +"GoogleCloudDiscoveryengineV1alphaAnswerStep": { +"description": "Step information.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerStep", "properties": { -"errorSamples": { -"description": "A sample of errors encountered while processing the request.", +"actions": { +"description": "Actions.", "items": { -"$ref": "GoogleRpcStatus" +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepAction" }, "type": "array" }, -"failedEntriesCount": { -"description": "Count of deny list entries that failed to be imported.", -"format": "int64", +"description": { +"description": "The description of the step.", "type": "string" }, -"importedEntriesCount": { -"description": "Count of deny list entries successfully imported.", -"format": "int64", +"state": { +"description": "The state of the step.", +"enum": [ +"STATE_UNSPECIFIED", +"IN_PROGRESS", +"FAILED", +"SUCCEEDED" +], +"enumDescriptions": [ +"Unknown.", +"Step is currently in progress.", +"Step currently failed.", +"Step has succeeded." +], +"type": "string" +}, +"thought": { +"description": "The thought of the step.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1ImportUserEventsMetadata": { -"description": "Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1ImportUserEventsMetadata", +"GoogleCloudDiscoveryengineV1alphaAnswerStepAction": { +"description": "Action.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerStepAction", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", -"type": "string" -}, -"failureCount": { -"description": "Count of entries that encountered errors while processing.", -"format": "int64", -"type": "string" -}, -"successCount": { -"description": "Count of entries that were processed successfully.", -"format": "int64", -"type": "string" +"observation": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation", +"description": "Observation." }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", -"type": "string" +"searchAction": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction", +"description": "Search action." } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1ImportUserEventsResponse": { -"description": "Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", -"id": "GoogleCloudDiscoveryengineV1ImportUserEventsResponse", +"GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation": { +"description": "Observation.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation", "properties": { -"errorConfig": { -"$ref": "GoogleCloudDiscoveryengineV1ImportErrorConfig", -"description": "Echoes the destination for the complete errors if this field was set in the request." -}, -"errorSamples": { -"description": "A sample of errors encountered while processing the request.", +"searchResults": { +"description": "Search results observed by the search action, it can be snippets info or chunk info, depending on the citation type set by the user.", "items": { -"$ref": "GoogleRpcStatus" +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult" }, "type": "array" -}, -"joinedEventsCount": { -"description": "Count of user events imported with complete existing Documents.", -"format": "int64", -"type": "string" -}, -"unjoinedEventsCount": { -"description": "Count of user events imported, but with Document information not found in the existing Branch.", -"format": "int64", -"type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1Project": { -"description": "Metadata and configurations for a Google Cloud project in the service.", -"id": "GoogleCloudDiscoveryengineV1Project", +"GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult": { +"id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult", "properties": { -"createTime": { -"description": "Output only. The timestamp when this project is created.", -"format": "google-datetime", -"readOnly": true, -"type": "string" +"chunkInfo": { +"description": "If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo" }, -"name": { -"description": "Output only. Full resource name of the project, for example `projects/{project_number}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.", -"readOnly": true, +"type": "array" +}, +"document": { +"description": "Document resource name.", "type": "string" }, -"provisionCompletionTime": { -"description": "Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use.", -"format": "google-datetime", -"readOnly": true, -"type": "string" +"snippetInfo": { +"description": "If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo" }, -"serviceTermsMap": { +"type": "array" +}, +"structData": { "additionalProperties": { -"$ref": "GoogleCloudDiscoveryengineV1ProjectServiceTerms" +"description": "Properties of the object.", +"type": "any" }, -"description": "Output only. A map of terms of services. The key is the `id` of ServiceTerms.", -"readOnly": true, +"description": "Data representation. The structured JSON data for the document. It's populated from the struct data from the Document , or the Chunk in search result .", "type": "object" +}, +"title": { +"description": "Title.", +"type": "string" +}, +"uri": { +"description": "URI for the document.", +"type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1ProjectServiceTerms": { -"description": "Metadata about the terms of service.", -"id": "GoogleCloudDiscoveryengineV1ProjectServiceTerms", +"GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo": { +"description": "Chunk information.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo", "properties": { -"acceptTime": { -"description": "The last time when the project agreed to the terms of service.", -"format": "google-datetime", +"chunk": { +"description": "Chunk resource name.", "type": "string" }, -"declineTime": { -"description": "The last time when the project declined or revoked the agreement to terms of service.", -"format": "google-datetime", +"content": { +"description": "Chunk textual content.", "type": "string" }, -"id": { -"description": "The unique identifier of this terms of service. Available terms: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this as `id`, the acceptable version to provide is `2022-11-23`.", -"type": "string" +"relevanceScore": { +"description": "Relevance score.", +"format": "float", +"type": "number" +} }, -"state": { -"description": "Whether the project has accepted/rejected the service terms or it is still pending.", -"enum": [ -"STATE_UNSPECIFIED", -"TERMS_ACCEPTED", -"TERMS_PENDING", -"TERMS_DECLINED" -], -"enumDescriptions": [ -"The default value of the enum. This value is not actually used.", -"The project has given consent to the terms of service.", -"The project is pending to review and accept the terms of service.", -"The project has declined or revoked the agreement to terms of service." -], +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo": { +"description": "Snippet information.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo", +"properties": { +"snippet": { +"description": "Snippet content.", "type": "string" }, -"version": { -"description": "The version string of the terms of service. For acceptable values, see the comments for id above.", +"snippetStatus": { +"description": "Status of the snippet defined by the search team.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1ProvisionProjectMetadata": { -"description": "Metadata associated with a project provision operation.", -"id": "GoogleCloudDiscoveryengineV1ProvisionProjectMetadata", -"properties": {}, +"GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction": { +"description": "Search action.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction", +"properties": { +"query": { +"description": "The query to search.", +"type": "string" +} +}, "type": "object" }, -"GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsMetadata": { -"description": "Metadata related to the progress of the PurgeCompletionSuggestions operation. This is returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsMetadata", +"GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata": { +"description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -7400,267 +8635,257 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsResponse": { -"description": "Response message for CompletionService.PurgeCompletionSuggestions method.", -"id": "GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsResponse", +"GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse": { +"description": "Response message for SiteSearchEngineService.BatchCreateTargetSites method.", +"id": "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse", "properties": { -"errorSamples": { -"description": "A sample of errors encountered while processing the request.", +"targetSites": { +"description": "TargetSites created.", "items": { -"$ref": "GoogleRpcStatus" +"$ref": "GoogleCloudDiscoveryengineV1alphaTargetSite" }, "type": "array" +} }, -"purgeSucceeded": { -"description": "Whether the completion suggestions were successfully purged.", -"type": "boolean" +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaCondition": { +"description": "Defines circumstances to be checked before allowing a behavior", +"id": "GoogleCloudDiscoveryengineV1alphaCondition", +"properties": { +"activeTimeRange": { +"description": "Range of time(s) specifying when condition is active. Maximum of 10 time ranges.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaConditionTimeRange" +}, +"type": "array" +}, +"queryTerms": { +"description": "Search only A list of terms to match the query on. Maximum of 10 query terms.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaConditionQueryTerm" +}, +"type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata": { -"description": "Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata", +"GoogleCloudDiscoveryengineV1alphaConditionQueryTerm": { +"description": "Matcher for search request query", +"id": "GoogleCloudDiscoveryengineV1alphaConditionQueryTerm", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", -"type": "string" +"fullMatch": { +"description": "Whether the search query needs to exactly match the query term.", +"type": "boolean" }, -"failureCount": { -"description": "Count of entries that encountered errors while processing.", -"format": "int64", +"value": { +"description": "The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters.", "type": "string" +} }, -"ignoredCount": { -"description": "Count of entries that were ignored as entries were not found.", -"format": "int64", -"type": "string" +"type": "object" }, -"successCount": { -"description": "Count of entries that were deleted successfully.", -"format": "int64", +"GoogleCloudDiscoveryengineV1alphaConditionTimeRange": { +"description": "Used for time-dependent conditions.", +"id": "GoogleCloudDiscoveryengineV1alphaConditionTimeRange", +"properties": { +"endTime": { +"description": "End of time range. Range is inclusive. Must be in the future.", +"format": "google-datetime", "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", +"startTime": { +"description": "Start of time range. Range is inclusive.", "format": "google-datetime", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1PurgeDocumentsResponse": { -"description": "Response message for DocumentService.PurgeDocuments method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.", -"id": "GoogleCloudDiscoveryengineV1PurgeDocumentsResponse", +"GoogleCloudDiscoveryengineV1alphaControl": { +"description": "Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`.", +"id": "GoogleCloudDiscoveryengineV1alphaControl", "properties": { -"purgeCount": { -"description": "The total count of documents purged as a result of the operation.", -"format": "int64", +"associatedServingConfigIds": { +"description": "Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes.", +"items": { "type": "string" }, -"purgeSample": { -"description": "A sample of document names that will be deleted. Only populated if `force` is set to false. A max of 100 names will be returned and the names are chosen at random.", +"readOnly": true, +"type": "array" +}, +"boostAction": { +"$ref": "GoogleCloudDiscoveryengineV1alphaControlBoostAction", +"description": "Defines a boost-type control" +}, +"conditions": { +"description": "Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown.", "items": { -"type": "string" +"$ref": "GoogleCloudDiscoveryengineV1alphaCondition" }, "type": "array" -} }, -"type": "object" +"displayName": { +"description": "Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown.", +"type": "string" }, -"GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesMetadata": { -"description": "Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesMetadata", -"properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"filterAction": { +"$ref": "GoogleCloudDiscoveryengineV1alphaControlFilterAction", +"description": "Defines a filter-type control Currently not supported by Recommendation" +}, +"name": { +"description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`", "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"redirectAction": { +"$ref": "GoogleCloudDiscoveryengineV1alphaControlRedirectAction", +"description": "Defines a redirect-type control." +}, +"solutionType": { +"description": "Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.", +"enum": [ +"SOLUTION_TYPE_UNSPECIFIED", +"SOLUTION_TYPE_RECOMMENDATION", +"SOLUTION_TYPE_SEARCH", +"SOLUTION_TYPE_CHAT", +"SOLUTION_TYPE_GENERATIVE_CHAT" +], +"enumDescriptions": [ +"Default value.", +"Used for Recommendations AI.", +"Used for Discovery Search.", +"Used for use cases related to the Generative AI agent.", +"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution." +], "type": "string" -} }, -"type": "object" +"synonymsAction": { +"$ref": "GoogleCloudDiscoveryengineV1alphaControlSynonymsAction", +"description": "Treats a group of terms as synonyms of one another." }, -"GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesResponse": { -"description": "Response message for CompletionService.PurgeSuggestionDenyListEntries method.", -"id": "GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesResponse", -"properties": { -"errorSamples": { -"description": "A sample of errors encountered while processing the request.", +"useCases": { +"description": "Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH.", "items": { -"$ref": "GoogleRpcStatus" +"enum": [ +"SEARCH_USE_CASE_UNSPECIFIED", +"SEARCH_USE_CASE_SEARCH", +"SEARCH_USE_CASE_BROWSE" +], +"enumDescriptions": [ +"Value used when unset. Will not occur in CSS.", +"Search use case. Expects the traffic has a non-empty query.", +"Browse use case. Expects the traffic has an empty query." +], +"type": "string" }, "type": "array" -}, -"purgeCount": { -"description": "Number of suggestion deny list entries purged.", -"format": "int64", -"type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1Schema": { -"description": "Defines the structure and layout of a type of document data.", -"id": "GoogleCloudDiscoveryengineV1Schema", +"GoogleCloudDiscoveryengineV1alphaControlBoostAction": { +"description": "Adjusts order of products in returned list.", +"id": "GoogleCloudDiscoveryengineV1alphaControlBoostAction", "properties": { -"jsonSchema": { -"description": "The JSON representation of the schema.", -"type": "string" +"boost": { +"description": "Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).", +"format": "float", +"type": "number" }, -"name": { -"description": "Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"dataStore": { +"description": "Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store", "type": "string" }, -"structSchema": { -"additionalProperties": { -"description": "Properties of the object.", -"type": "any" -}, -"description": "The structured representation of the schema.", -"type": "object" +"filter": { +"description": "Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.", +"type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1SiteVerificationInfo": { -"description": "Verification information for target sites in advanced site search.", -"id": "GoogleCloudDiscoveryengineV1SiteVerificationInfo", +"GoogleCloudDiscoveryengineV1alphaControlFilterAction": { +"description": "Specified which products may be included in results. Uses same filter as boost.", +"id": "GoogleCloudDiscoveryengineV1alphaControlFilterAction", "properties": { -"siteVerificationState": { -"description": "Site verification state indicating the ownership and validity.", -"enum": [ -"SITE_VERIFICATION_STATE_UNSPECIFIED", -"VERIFIED", -"UNVERIFIED", -"EXEMPTED" -], -"enumDescriptions": [ -"Defaults to VERIFIED.", -"Site ownership verified.", -"Site ownership pending verification or verification failed.", -"Site exempt from verification, e.g., a public website that opens to all." -], +"dataStore": { +"description": "Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store", "type": "string" }, -"verifyTime": { -"description": "Latest site verification time.", -"format": "google-datetime", +"filter": { +"description": "Required. A filter to apply on the matching condition results. Required Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1TargetSite": { -"description": "A target site for the SiteSearchEngine.", -"id": "GoogleCloudDiscoveryengineV1TargetSite", +"GoogleCloudDiscoveryengineV1alphaControlRedirectAction": { +"description": "Redirects a shopper to the provided URI.", +"id": "GoogleCloudDiscoveryengineV1alphaControlRedirectAction", "properties": { -"exactMatch": { -"description": "Input only. If set to false, a uri_pattern is generated to include all pages whose address contains the provided_uri_pattern. If set to true, an uri_pattern is generated to try to be an exact match of the provided_uri_pattern or just the specific page if the provided_uri_pattern is a specific one. provided_uri_pattern is always normalized to generate the URI pattern to be used by the search engine.", -"type": "boolean" -}, -"failureReason": { -"$ref": "GoogleCloudDiscoveryengineV1TargetSiteFailureReason", -"description": "Output only. Failure reason.", -"readOnly": true -}, -"generatedUriPattern": { -"description": "Output only. This is system-generated based on the provided_uri_pattern.", -"readOnly": true, -"type": "string" -}, -"indexingStatus": { -"description": "Output only. Indexing status.", -"enum": [ -"INDEXING_STATUS_UNSPECIFIED", -"PENDING", -"FAILED", -"SUCCEEDED", -"DELETING" -], -"enumDescriptions": [ -"Defaults to SUCCEEDED.", -"The target site is in the update queue and will be picked up by indexing pipeline.", -"The target site fails to be indexed.", -"The target site has been indexed.", -"The previously indexed target site has been marked to be deleted. This is a transitioning state which will resulted in either: 1. target site deleted if unindexing is successful; 2. state reverts to SUCCEEDED if the unindexing fails." -], -"readOnly": true, +"redirectUri": { +"description": "Required. The URI to which the shopper will be redirected. Required. URI must have length equal or less than 2000 characters. Otherwise an INVALID ARGUMENT error is thrown.", "type": "string" +} }, -"name": { -"description": "Output only. The fully qualified resource name of the target site. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}` The `target_site_id` is system-generated.", -"readOnly": true, -"type": "string" +"type": "object" }, -"providedUriPattern": { -"description": "Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated.", +"GoogleCloudDiscoveryengineV1alphaControlSynonymsAction": { +"description": "Creates a set of terms that will act as synonyms of one another. Example: \"happy\" will also be considered as \"glad\", \"glad\" will also be considered as \"happy\".", +"id": "GoogleCloudDiscoveryengineV1alphaControlSynonymsAction", +"properties": { +"synonyms": { +"description": "Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown.", +"items": { "type": "string" }, -"rootDomainUri": { -"description": "Output only. Root domain of the provided_uri_pattern.", -"readOnly": true, -"type": "string" +"type": "array" +} }, -"siteVerificationInfo": { -"$ref": "GoogleCloudDiscoveryengineV1SiteVerificationInfo", -"description": "Output only. Site ownership and validity verification status.", -"readOnly": true +"type": "object" }, -"type": { -"description": "The type of the target site, e.g., whether the site is to be included or excluded.", -"enum": [ -"TYPE_UNSPECIFIED", -"INCLUDE", -"EXCLUDE" -], -"enumDescriptions": [ -"This value is unused. In this case, server behavior defaults to Type.INCLUDE.", -"Include the target site.", -"Exclude the target site." -], +"GoogleCloudDiscoveryengineV1alphaCreateDataStoreMetadata": { +"description": "Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaCreateDataStoreMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", "type": "string" }, "updateTime": { -"description": "Output only. The target site's last updated time.", +"description": "Operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime", -"readOnly": true, "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1TargetSiteFailureReason": { -"description": "Site search indexing failure reasons.", -"id": "GoogleCloudDiscoveryengineV1TargetSiteFailureReason", +"GoogleCloudDiscoveryengineV1alphaCreateEngineMetadata": { +"description": "Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaCreateEngineMetadata", "properties": { -"quotaFailure": { -"$ref": "GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure", -"description": "Failed due to insufficient quota." -} -}, -"type": "object" +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" }, -"GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure": { -"description": "Failed due to insufficient quota.", -"id": "GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure", -"properties": { -"totalRequiredQuota": { -"description": "This number is an estimation on how much total quota this project needs to successfully complete indexing.", -"format": "int64", +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1UpdateSchemaMetadata": { -"description": "Metadata for UpdateSchema LRO.", -"id": "GoogleCloudDiscoveryengineV1UpdateSchemaMetadata", +"GoogleCloudDiscoveryengineV1alphaCreateEvaluationMetadata": { +"description": "Metadata for EvaluationService.CreateEvaluation method.", +"id": "GoogleCloudDiscoveryengineV1alphaCreateEvaluationMetadata", +"properties": {}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata": { +"description": "Metadata for Create Schema LRO.", +"id": "GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -7675,9 +8900,9 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1UpdateTargetSiteMetadata": { -"description": "Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1UpdateTargetSiteMetadata", +"GoogleCloudDiscoveryengineV1alphaCreateTargetSiteMetadata": { +"description": "Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaCreateTargetSiteMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -7692,744 +8917,816 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaAclConfig": { -"description": "Access Control Configuration.", -"id": "GoogleCloudDiscoveryengineV1alphaAclConfig", +"GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec": { +"description": "Defines custom fine tuning spec.", +"id": "GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec", "properties": { -"idpConfig": { -"$ref": "GoogleCloudDiscoveryengineV1alphaIdpConfig", -"description": "Identity provider config." +"enableSearchAdaptor": { +"description": "Whether or not to enable and include custom fine tuned search adaptor model.", +"type": "boolean" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaCustomTuningModel": { +"description": "Metadata that describes a custom tuned model.", +"id": "GoogleCloudDiscoveryengineV1alphaCustomTuningModel", +"properties": { +"createTime": { +"deprecated": true, +"description": "Timestamp the Model was created at.", +"format": "google-datetime", +"type": "string" +}, +"displayName": { +"description": "The display name of the model.", +"type": "string" +}, +"metrics": { +"additionalProperties": { +"format": "double", +"type": "number" +}, +"description": "The metrics of the trained model.", +"type": "object" +}, +"modelState": { +"description": "The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).", +"enum": [ +"MODEL_STATE_UNSPECIFIED", +"TRAINING_PAUSED", +"TRAINING", +"TRAINING_COMPLETE", +"READY_FOR_SERVING", +"TRAINING_FAILED", +"NO_IMPROVEMENT" +], +"enumDescriptions": [ +"Default value.", +"The model is in a paused training state.", +"The model is currently training.", +"The model has successfully completed training.", +"The model is ready for serving.", +"The model training failed.", +"The model training finished successfully but metrics did not improve." +], +"type": "string" +}, +"modelVersion": { +"description": "The version of the model.", +"format": "int64", +"type": "string" }, "name": { -"description": "Immutable. The full resource name of the acl configuration. Format: `projects/{project}/locations/{location}/aclConfig`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"description": "Required. The fully qualified resource name of the model. Format: `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}` model must be an alpha-numerical string with limit of 40 characters.", +"type": "string" +}, +"trainingStartTime": { +"description": "Timestamp the model training was initiated.", +"format": "google-datetime", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaAnswer": { -"description": "Defines an answer.", -"id": "GoogleCloudDiscoveryengineV1alphaAnswer", +"GoogleCloudDiscoveryengineV1alphaDataStore": { +"description": "DataStore captures global settings and configs at the DataStore level.", +"id": "GoogleCloudDiscoveryengineV1alphaDataStore", "properties": { -"answerSkippedReasons": { -"description": "Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.", -"items": { +"aclEnabled": { +"description": "Immutable. Whether data in the DataStore has ACL information. If set to `true`, the source data must have ACL. ACL will be ingested when data is ingested by DocumentService.ImportDocuments methods. When ACL is enabled for the DataStore, Document can't be accessed by calling DocumentService.GetDocument or DocumentService.ListDocuments. Currently ACL is only supported in `GENERIC` industry vertical with non-`PUBLIC_WEBSITE` content config.", +"type": "boolean" +}, +"contentConfig": { +"description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", "enum": [ -"ANSWER_SKIPPED_REASON_UNSPECIFIED", -"ADVERSARIAL_QUERY_IGNORED", -"NON_ANSWER_SEEKING_QUERY_IGNORED", -"OUT_OF_DOMAIN_QUERY_IGNORED", -"POTENTIAL_POLICY_VIOLATION", -"NO_RELEVANT_CONTENT" +"CONTENT_CONFIG_UNSPECIFIED", +"NO_CONTENT", +"CONTENT_REQUIRED", +"PUBLIC_WEBSITE" ], "enumDescriptions": [ -"Default value. The answer skipped reason is not specified.", -"The adversarial query ignored case.", -"The non-answer seeking query ignored case.", -"The out-of-domain query ignored case. Google skips the answer if there are no high-relevance search results.", -"The potential policy violation case. Google skips the answer if there is a potential policy violation detected. This includes content that may be violent or toxic.", -"The no relevant content case. Google skips the answer if there is no relevant content in the retrieved search results." +"Default value.", +"Only contains documents without any Document.content.", +"Only contains documents with Document.content.", +"The data store is used for public website search." ], "type": "string" }, -"type": "array" -}, -"answerText": { -"description": "The textual answer.", -"type": "string" -}, -"citations": { -"description": "Citations.", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerCitation" -}, -"type": "array" -}, -"completeTime": { -"description": "Output only. Answer completed timestamp.", +"createTime": { +"description": "Output only. Timestamp the DataStore was created at.", "format": "google-datetime", "readOnly": true, "type": "string" }, -"createTime": { -"description": "Output only. Answer creation timestamp.", -"format": "google-datetime", +"defaultSchemaId": { +"description": "Output only. The id of the default Schema asscociated to this data store.", "readOnly": true, "type": "string" }, -"name": { -"description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*`", +"displayName": { +"description": "Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.", "type": "string" }, -"queryUnderstandingInfo": { -"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo", -"description": "Query understanding information." -}, -"references": { -"description": "References.", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReference" -}, -"type": "array" -}, -"relatedQuestions": { -"description": "Suggested related questions.", -"items": { -"type": "string" +"documentProcessingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig", +"description": "Configuration for Document understanding and enrichment." }, -"type": "array" +"idpConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaIdpConfig", +"description": "Output only. Data store level identity provider config.", +"readOnly": true }, -"state": { -"description": "The state of the answer generation.", +"industryVertical": { +"description": "Immutable. The industry vertical that the data store registers.", "enum": [ -"STATE_UNSPECIFIED", -"IN_PROGRESS", -"FAILED", -"SUCCEEDED" +"INDUSTRY_VERTICAL_UNSPECIFIED", +"GENERIC", +"MEDIA", +"HEALTHCARE_FHIR" ], "enumDescriptions": [ -"Unknown.", -"Answer generation is currently in progress.", -"Answer generation currently failed.", -"Answer generation has succeeded." +"Value used when unset.", +"The generic vertical for documents that are not specific to any industry vertical.", +"The media industry vertical.", +"The healthcare FHIR vertical." ], "type": "string" }, -"steps": { -"description": "Answer generation steps.", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStep" -}, -"type": "array" -} -}, -"type": "object" +"languageInfo": { +"$ref": "GoogleCloudDiscoveryengineV1alphaLanguageInfo", +"description": "Language info for DataStore." }, -"GoogleCloudDiscoveryengineV1alphaAnswerCitation": { -"description": "Citation info for a segment.", -"id": "GoogleCloudDiscoveryengineV1alphaAnswerCitation", -"properties": { -"endIndex": { -"description": "End of the attributed segment, exclusive.", -"format": "int64", +"name": { +"description": "Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" }, -"sources": { -"description": "Citation sources for the attributed segment.", +"solutionTypes": { +"description": "The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.", "items": { -"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerCitationSource" +"enum": [ +"SOLUTION_TYPE_UNSPECIFIED", +"SOLUTION_TYPE_RECOMMENDATION", +"SOLUTION_TYPE_SEARCH", +"SOLUTION_TYPE_CHAT", +"SOLUTION_TYPE_GENERATIVE_CHAT" +], +"enumDescriptions": [ +"Default value.", +"Used for Recommendations AI.", +"Used for Discovery Search.", +"Used for use cases related to the Generative AI agent.", +"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution." +], +"type": "string" }, "type": "array" }, -"startIndex": { -"description": "Index indicates the start of the segment, measured in bytes (UTF-8 unicode).", -"format": "int64", -"type": "string" +"startingSchema": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSchema", +"description": "The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema)." } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaAnswerCitationSource": { -"description": "Citation source.", -"id": "GoogleCloudDiscoveryengineV1alphaAnswerCitationSource", +"GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata": { +"description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata", "properties": { -"referenceId": { -"description": "ID of the citation source.", +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", "type": "string" -} -}, -"type": "object" -}, -"GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo": { -"description": "Query understanding information.", -"id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo", -"properties": { -"queryClassificationInfo": { -"description": "Query classification information.", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo" -}, -"type": "array" -} -}, -"type": "object" -}, -"GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo": { -"description": "Query classification information.", -"id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo", -"properties": { -"positive": { -"description": "Classification output.", -"type": "boolean" }, -"type": { -"description": "Query classification type.", -"enum": [ -"TYPE_UNSPECIFIED", -"ADVERSARIAL_QUERY", -"NON_ANSWER_SEEKING_QUERY" -], -"enumDescriptions": [ -"Unspecified query classification type.", -"Adversarial query classification type.", -"Non-answer-seeking query classification type." -], +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaAnswerReference": { -"description": "Reference.", -"id": "GoogleCloudDiscoveryengineV1alphaAnswerReference", +"GoogleCloudDiscoveryengineV1alphaDeleteEngineMetadata": { +"description": "Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaDeleteEngineMetadata", "properties": { -"chunkInfo": { -"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo", -"description": "Chunk information." +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" }, -"unstructuredDocumentInfo": { -"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo", -"description": "Unstructured document information." +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo": { -"description": "Chunk information.", -"id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo", +"GoogleCloudDiscoveryengineV1alphaDeleteSchemaMetadata": { +"description": "Metadata for DeleteSchema LRO.", +"id": "GoogleCloudDiscoveryengineV1alphaDeleteSchemaMetadata", "properties": { -"chunk": { -"description": "Chunk resource name.", +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", "type": "string" }, -"content": { -"description": "Chunk textual content.", +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", "type": "string" -}, -"documentMetadata": { -"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata", -"description": "Document metadata." -}, -"relevanceScore": { -"description": "Relevance score.", -"format": "float", -"type": "number" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata": { -"description": "Document metadata.", -"id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata", +"GoogleCloudDiscoveryengineV1alphaDeleteTargetSiteMetadata": { +"description": "Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaDeleteTargetSiteMetadata", "properties": { -"document": { -"description": "Document resource name.", +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", "type": "string" }, -"pageIdentifier": { -"description": "Page identifier.", +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", "type": "string" +} }, -"structData": { -"additionalProperties": { -"description": "Properties of the object.", -"type": "any" -}, -"description": "The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result.", "type": "object" }, -"title": { -"description": "Title.", +"GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchMetadata": { +"description": "Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", "type": "string" }, -"uri": { -"description": "URI for the document.", +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo": { -"description": "Unstructured document information.", -"id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo", +"GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchResponse": { +"description": "Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.", +"id": "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchResponse", +"properties": {}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig": { +"description": "A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config.", +"id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig", "properties": { -"chunkContents": { -"description": "List of cited chunk contents derived from document content.", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent" +"chunkingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig", +"description": "Whether chunking mode is enabled." }, -"type": "array" +"defaultParsingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig", +"description": "Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing." }, -"document": { -"description": "Document resource name.", +"name": { +"description": "The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.", "type": "string" }, -"structData": { +"parsingConfigOverrides": { "additionalProperties": { -"description": "Properties of the object.", -"type": "any" +"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig" }, -"description": "The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result.", +"description": "Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported.", "type": "object" +} }, -"title": { -"description": "Title.", -"type": "string" +"type": "object" }, -"uri": { -"description": "URI for the document.", -"type": "string" +"GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig": { +"description": "Configuration for chunking config.", +"id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig", +"properties": { +"layoutBasedChunkingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", +"description": "Configuration for the layout based chunking." } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent": { -"description": "Chunk content.", -"id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent", +"GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig": { +"description": "Configuration for the layout based chunking.", +"id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", "properties": { -"content": { -"description": "Chunk textual content.", -"type": "string" +"chunkSize": { +"description": "The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.", +"format": "int32", +"type": "integer" }, -"pageIdentifier": { -"description": "Page identifier.", -"type": "string" +"includeAncestorHeadings": { +"description": "Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False.", +"type": "boolean" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaAnswerStep": { -"description": "Step information.", -"id": "GoogleCloudDiscoveryengineV1alphaAnswerStep", +"GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig": { +"description": "Related configurations applied to a specific type of document parser.", +"id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig", "properties": { -"actions": { -"description": "Actions.", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepAction" +"digitalParsingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig", +"description": "Configurations applied to digital parser." }, -"type": "array" +"layoutParsingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig", +"description": "Configurations applied to layout parser." }, -"description": { -"description": "The description of the step.", -"type": "string" +"ocrParsingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig", +"description": "Configurations applied to OCR parser. Currently it only applies to PDFs." +} }, -"state": { -"description": "The state of the step.", -"enum": [ -"STATE_UNSPECIFIED", -"IN_PROGRESS", -"FAILED", -"SUCCEEDED" -], -"enumDescriptions": [ -"Unknown.", -"Step is currently in progress.", -"Step currently failed.", -"Step has succeeded." -], -"type": "string" +"type": "object" }, -"thought": { -"description": "The thought of the step.", -"type": "string" -} +"GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig": { +"description": "The digital parsing configurations for documents.", +"id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig", +"properties": {}, +"type": "object" }, +"GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig": { +"description": "The layout parsing configurations for documents.", +"id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig", +"properties": {}, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaAnswerStepAction": { -"description": "Action.", -"id": "GoogleCloudDiscoveryengineV1alphaAnswerStepAction", +"GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig": { +"description": "The OCR parsing configurations for documents.", +"id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig", "properties": { -"observation": { -"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation", -"description": "Observation." +"enhancedDocumentElements": { +"deprecated": true, +"description": "[DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.", +"items": { +"type": "string" }, -"searchAction": { -"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction", -"description": "Search action." +"type": "array" +}, +"useNativeText": { +"description": "If true, will use native text instead of OCR text on pages containing native text.", +"type": "boolean" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation": { -"description": "Observation.", -"id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation", +"GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchMetadata": { +"description": "Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchMetadata", "properties": { -"searchResults": { -"description": "Search results observed by the search action, it can be snippets info or chunk info, depending on the citation type set by the user.", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult" +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" }, -"type": "array" +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult": { -"id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult", +"GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchResponse": { +"description": "Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.", +"id": "GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchResponse", +"properties": {}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaEngine": { +"description": "Metadata that describes the training and serving parameters of an Engine.", +"id": "GoogleCloudDiscoveryengineV1alphaEngine", "properties": { -"chunkInfo": { -"description": "If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info.", +"chatEngineConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig", +"description": "Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT." +}, +"chatEngineMetadata": { +"$ref": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata", +"description": "Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.", +"readOnly": true +}, +"commonConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaEngineCommonConfig", +"description": "Common config spec that specifies the metadata of the engine." +}, +"createTime": { +"description": "Output only. Timestamp the Recommendation Engine was created at.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"dataStoreIds": { +"description": "The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.", "items": { -"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo" +"type": "string" }, "type": "array" }, -"document": { -"description": "Document resource name.", +"displayName": { +"description": "Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.", "type": "string" }, -"snippetInfo": { -"description": "If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo" +"industryVertical": { +"description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore linked to the engine.", +"enum": [ +"INDUSTRY_VERTICAL_UNSPECIFIED", +"GENERIC", +"MEDIA", +"HEALTHCARE_FHIR" +], +"enumDescriptions": [ +"Value used when unset.", +"The generic vertical for documents that are not specific to any industry vertical.", +"The media industry vertical.", +"The healthcare FHIR vertical." +], +"type": "string" +}, +"mediaRecommendationEngineConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig", +"description": "Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical." +}, +"name": { +"description": "Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.", +"type": "string" }, -"type": "array" +"recommendationMetadata": { +"$ref": "GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata", +"description": "Output only. Additional information of a recommendation engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION.", +"readOnly": true }, -"structData": { -"additionalProperties": { -"description": "Properties of the object.", -"type": "any" +"searchEngineConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig", +"description": "Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH." }, -"description": "Data representation. The structured JSON data for the document. It's populated from the struct data from the Document (code pointer: http://shortn/_objzAfIiHq), or the Chunk in search result (code pointer: http://shortn/_Ipo6KFFGBL).", -"type": "object" +"similarDocumentsConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig", +"description": "Additional config specs for a `similar-items` engine." }, -"title": { -"description": "Title.", +"solutionType": { +"description": "Required. The solutions of the engine.", +"enum": [ +"SOLUTION_TYPE_UNSPECIFIED", +"SOLUTION_TYPE_RECOMMENDATION", +"SOLUTION_TYPE_SEARCH", +"SOLUTION_TYPE_CHAT", +"SOLUTION_TYPE_GENERATIVE_CHAT" +], +"enumDescriptions": [ +"Default value.", +"Used for Recommendations AI.", +"Used for Discovery Search.", +"Used for use cases related to the Generative AI agent.", +"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution." +], "type": "string" }, -"uri": { -"description": "URI for the document.", +"updateTime": { +"description": "Output only. Timestamp the Recommendation Engine was last updated.", +"format": "google-datetime", +"readOnly": true, "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo": { -"description": "Chunk information.", -"id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo", +"GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig": { +"description": "Configurations for a Chat Engine.", +"id": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig", "properties": { -"chunk": { -"description": "Chunk resource name.", -"type": "string" +"agentCreationConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig", +"description": "The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation." }, -"content": { -"description": "Chunk textual content.", +"dialogflowAgentToLink": { +"description": "The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.", "type": "string" -}, -"relevanceScore": { -"description": "Relevance score.", -"format": "float", -"type": "number" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo": { -"description": "Snippet information.", -"id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo", +"GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig": { +"description": "Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.", +"id": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig", "properties": { -"snippet": { -"description": "Snippet content.", +"business": { +"description": "Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.", "type": "string" }, -"snippetStatus": { -"description": "Status of the snippet defined by the search team.", +"defaultLanguageCode": { +"description": "Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes.", "type": "string" -} }, -"type": "object" +"location": { +"description": "Agent location for Agent creation, supported values: global/us/eu. If not provided, us Engine will create Agent using us-central-1 by default; eu Engine will create Agent using eu-west-1 by default.", +"type": "string" }, -"GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction": { -"description": "Search action.", -"id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction", -"properties": { -"query": { -"description": "The query to search.", +"timeZone": { +"description": "Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata": { -"description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata", +"GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata": { +"description": "Additional information of a Chat Engine. Fields in this message are output only.", +"id": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", -"type": "string" -}, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"dialogflowAgent": { +"description": "The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse": { -"description": "Response message for SiteSearchEngineService.BatchCreateTargetSites method.", -"id": "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse", +"GoogleCloudDiscoveryengineV1alphaEngineCommonConfig": { +"description": "Common configurations for an Engine.", +"id": "GoogleCloudDiscoveryengineV1alphaEngineCommonConfig", "properties": { -"targetSites": { -"description": "TargetSites created.", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1alphaTargetSite" -}, -"type": "array" +"companyName": { +"description": "The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.", +"type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaCondition": { -"description": "Defines circumstances to be checked before allowing a behavior", -"id": "GoogleCloudDiscoveryengineV1alphaCondition", +"GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig": { +"description": "Additional config specs for a Media Recommendation engine.", +"id": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig", "properties": { -"activeTimeRange": { -"description": "Range of time(s) specifying when condition is active. Maximum of 10 time ranges.", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1alphaConditionTimeRange" -}, -"type": "array" -}, -"queryTerms": { -"description": "Search only A list of terms to match the query on. Maximum of 10 query terms.", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1alphaConditionQueryTerm" -}, -"type": "array" -} +"optimizationObjective": { +"description": "The optimization objective. e.g., `cvr`. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: `ctr`, `cvr`. If not specified, we choose default based on engine type. Default depends on type of recommendation: `recommended-for-you` => `ctr` `others-you-may-like` => `ctr`", +"type": "string" }, -"type": "object" +"optimizationObjectiveConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig", +"description": "Name and value of the custom threshold for cvr optimization_objective. For target_field `watch-time`, target_field_value must be an integer value indicating the media progress time in seconds between (0, 86400] (excludes 0, includes 86400) (e.g., 90). For target_field `watch-percentage`, the target_field_value must be a valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g., 0.5)." }, -"GoogleCloudDiscoveryengineV1alphaConditionQueryTerm": { -"description": "Matcher for search request query", -"id": "GoogleCloudDiscoveryengineV1alphaConditionQueryTerm", -"properties": { -"fullMatch": { -"description": "Whether the search query needs to exactly match the query term.", -"type": "boolean" +"trainingState": { +"description": "The training state that the engine is in (e.g. `TRAINING` or `PAUSED`). Since part of the cost of running the service is frequency of training - this can be used to determine when to train engine in order to control cost. If not specified: the default value for `CreateEngine` method is `TRAINING`. The default value for `UpdateEngine` method is to keep the state the same as before.", +"enum": [ +"TRAINING_STATE_UNSPECIFIED", +"PAUSED", +"TRAINING" +], +"enumDescriptions": [ +"Unspecified training state.", +"The engine training is paused.", +"The engine is training." +], +"type": "string" }, -"value": { -"description": "The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters.", +"type": { +"description": "Required. The type of engine. e.g., `recommended-for-you`. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: `recommended-for-you`, `others-you-may-like`, `more-like-this`, `most-popular-items`.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaConditionTimeRange": { -"description": "Used for time-dependent conditions.", -"id": "GoogleCloudDiscoveryengineV1alphaConditionTimeRange", +"GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig": { +"description": "Custom threshold for `cvr` optimization_objective.", +"id": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig", "properties": { -"endTime": { -"description": "End of time range. Range is inclusive. Must be in the future.", -"format": "google-datetime", +"targetField": { +"description": "Required. The name of the field to target. Currently supported values: `watch-percentage`, `watch-time`.", "type": "string" }, -"startTime": { -"description": "Start of time range. Range is inclusive.", -"format": "google-datetime", -"type": "string" +"targetFieldValueFloat": { +"description": "Required. The threshold to be applied to the target (e.g., 0.5).", +"format": "float", +"type": "number" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaControl": { -"description": "Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`.", -"id": "GoogleCloudDiscoveryengineV1alphaControl", +"GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata": { +"description": "Additional information of a recommendation engine.", +"id": "GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata", "properties": { -"associatedServingConfigIds": { -"description": "Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes.", -"items": { +"dataState": { +"description": "Output only. The state of data requirements for this engine: `DATA_OK` and `DATA_ERROR`. Engine cannot be trained if the data is in `DATA_ERROR` state. Engine can have `DATA_ERROR` state even if serving state is `ACTIVE`: engines were trained successfully before, but cannot be refreshed because the underlying engine no longer has sufficient data for training.", +"enum": [ +"DATA_STATE_UNSPECIFIED", +"DATA_OK", +"DATA_ERROR" +], +"enumDescriptions": [ +"Unspecified default value, should never be explicitly set.", +"The engine has sufficient training data.", +"The engine does not have sufficient training data. Error messages can be queried via Stackdriver." +], +"readOnly": true, "type": "string" }, +"lastTuneTime": { +"description": "Output only. The timestamp when the latest successful tune finished. Only applicable on Media Recommendation engines.", +"format": "google-datetime", "readOnly": true, -"type": "array" -}, -"boostAction": { -"$ref": "GoogleCloudDiscoveryengineV1alphaControlBoostAction", -"description": "Defines a boost-type control" -}, -"conditions": { -"description": "Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown.", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1alphaCondition" -}, -"type": "array" -}, -"displayName": { -"description": "Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown.", "type": "string" }, -"filterAction": { -"$ref": "GoogleCloudDiscoveryengineV1alphaControlFilterAction", -"description": "Defines a filter-type control Currently not supported by Recommendation" +"servingState": { +"description": "Output only. The serving state of the engine: `ACTIVE`, `NOT_ACTIVE`.", +"enum": [ +"SERVING_STATE_UNSPECIFIED", +"INACTIVE", +"ACTIVE", +"TUNED" +], +"enumDescriptions": [ +"Unspecified serving state.", +"The engine is not serving.", +"The engine is serving and can be queried.", +"The engine is trained on tuned hyperparameters and can be queried." +], +"readOnly": true, +"type": "string" }, -"name": { -"description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`", +"tuningOperation": { +"description": "Output only. The latest tune operation id associated with the engine. Only applicable on Media Recommendation engines. If present, this operation id can be used to determine if there is an ongoing tune for this engine. To check the operation status, send the GetOperation request with this operation id in the engine resource format. If no tuning has happened for this engine, the string is empty.", +"readOnly": true, "type": "string" +} }, -"redirectAction": { -"$ref": "GoogleCloudDiscoveryengineV1alphaControlRedirectAction", -"description": "Defines a redirect-type control." +"type": "object" }, -"solutionType": { -"description": "Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.", +"GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig": { +"description": "Configurations for a Search Engine.", +"id": "GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig", +"properties": { +"searchAddOns": { +"description": "The add-on that this search engine enables.", +"items": { "enum": [ -"SOLUTION_TYPE_UNSPECIFIED", -"SOLUTION_TYPE_RECOMMENDATION", -"SOLUTION_TYPE_SEARCH", -"SOLUTION_TYPE_CHAT", -"SOLUTION_TYPE_GENERATIVE_CHAT" +"SEARCH_ADD_ON_UNSPECIFIED", +"SEARCH_ADD_ON_LLM" ], "enumDescriptions": [ -"Default value.", -"Used for Recommendations AI.", -"Used for Discovery Search.", -"Used for use cases related to the Generative AI agent.", -"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution." +"Default value when the enum is unspecified. This is invalid to use.", +"Large language model add-on." ], "type": "string" }, -"synonymsAction": { -"$ref": "GoogleCloudDiscoveryengineV1alphaControlSynonymsAction", -"description": "Treats a group of terms as synonyms of one another." +"type": "array" }, -"useCases": { -"description": "Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH.", -"items": { +"searchTier": { +"description": "The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified.", "enum": [ -"SEARCH_USE_CASE_UNSPECIFIED", -"SEARCH_USE_CASE_SEARCH", -"SEARCH_USE_CASE_BROWSE" +"SEARCH_TIER_UNSPECIFIED", +"SEARCH_TIER_STANDARD", +"SEARCH_TIER_ENTERPRISE" ], "enumDescriptions": [ -"Value used when unset. Will not occur in CSS.", -"Search use case. Expects the traffic has a non-empty query.", -"Browse use case. Expects the traffic has an empty query." +"Default value when the enum is unspecified. This is invalid to use.", +"Standard tier.", +"Enterprise tier." ], "type": "string" -}, -"type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaControlBoostAction": { -"description": "Adjusts order of products in returned list.", -"id": "GoogleCloudDiscoveryengineV1alphaControlBoostAction", -"properties": { -"boost": { -"description": "Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).", -"format": "float", -"type": "number" -}, -"dataStore": { -"description": "Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store", -"type": "string" +"GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig": { +"description": "Additional config specs for a `similar-items` engine.", +"id": "GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig", +"properties": {}, +"type": "object" }, -"filter": { -"description": "Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.", +"GoogleCloudDiscoveryengineV1alphaEstimateDataSizeMetadata": { +"description": "Metadata related to the progress of the EstimateDataSize operation. This is returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaControlFilterAction": { -"description": "Specified which products may be included in results. Uses same filter as boost.", -"id": "GoogleCloudDiscoveryengineV1alphaControlFilterAction", +"GoogleCloudDiscoveryengineV1alphaEstimateDataSizeResponse": { +"description": "Response of the EstimateDataSize request. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", +"id": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeResponse", "properties": { -"dataStore": { -"description": "Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store", +"dataSizeBytes": { +"description": "Data size in terms of bytes.", +"format": "int64", "type": "string" }, -"filter": { -"description": "Required. A filter to apply on the matching condition results. Required Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.", +"documentCount": { +"description": "Total number of documents.", +"format": "int64", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaControlRedirectAction": { -"description": "Redirects a shopper to the provided URI.", -"id": "GoogleCloudDiscoveryengineV1alphaControlRedirectAction", +"GoogleCloudDiscoveryengineV1alphaEvaluation": { +"description": "An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data.", +"id": "GoogleCloudDiscoveryengineV1alphaEvaluation", "properties": { -"redirectUri": { -"description": "Required. The URI to which the shopper will be redirected. Required. URI must have length equal or less than 2000 characters. Otherwise an INVALID ARGUMENT error is thrown.", +"createTime": { +"description": "Output only. Timestamp the Evaluation was created at.", +"format": "google-datetime", +"readOnly": true, "type": "string" -} }, -"type": "object" +"endTime": { +"description": "Output only. Timestamp the Evaluation was completed at.", +"format": "google-datetime", +"readOnly": true, +"type": "string" }, -"GoogleCloudDiscoveryengineV1alphaControlSynonymsAction": { -"description": "Creates a set of terms that will act as synonyms of one another. Example: \"happy\" will also be considered as \"glad\", \"glad\" will also be considered as \"happy\".", -"id": "GoogleCloudDiscoveryengineV1alphaControlSynonymsAction", -"properties": { -"synonyms": { -"description": "Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown.", +"error": { +"$ref": "GoogleRpcStatus", +"description": "Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED.", +"readOnly": true +}, +"errorSamples": { +"description": "Output only. A sample of errors encountered while processing the request.", "items": { -"type": "string" +"$ref": "GoogleRpcStatus" }, +"readOnly": true, "type": "array" -} }, -"type": "object" +"evaluationSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec", +"description": "Required. The specification of the evaluation." }, -"GoogleCloudDiscoveryengineV1alphaCreateDataStoreMetadata": { -"description": "Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1alphaCreateDataStoreMetadata", -"properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"name": { +"description": "Immutable. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"qualityMetrics": { +"$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetrics", +"description": "Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet. Only populated when the evaluation's state is SUCCEEDED.", +"readOnly": true +}, +"state": { +"description": "Output only. The state of the evaluation.", +"enum": [ +"STATE_UNSPECIFIED", +"PENDING", +"RUNNING", +"SUCCEEDED", +"FAILED" +], +"enumDescriptions": [ +"The evaluation is unspecified.", +"The service is preparing to run the evaluation.", +"The evaluation is in progress.", +"The evaluation completed successfully.", +"The evaluation failed." +], +"readOnly": true, "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaCreateEngineMetadata": { -"description": "Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1alphaCreateEngineMetadata", +"GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec": { +"description": "Describes the specification of the evaluation.", +"id": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", -"type": "string" +"querySetSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec", +"description": "Required. The specification of the query set." }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", -"type": "string" +"searchRequest": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequest", +"description": "Required. The search request that is used to perform the evaluation. Only the following fields within SearchRequest are supported; if any other fields are provided, an UNSUPPORTED error will be returned: * SearchRequest.serving_config * SearchRequest.branch * SearchRequest.canonical_filter * SearchRequest.query_expansion_spec * SearchRequest.spell_correction_spec * SearchRequest.content_search_spec * SearchRequest.user_pseudo_id" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata": { -"description": "Metadata for Create Schema LRO.", -"id": "GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata", +"GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec": { +"description": "Describes the specification of the query set.", +"id": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", -"type": "string" -}, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"sampleQuerySet": { +"description": "Required. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaCreateTargetSiteMetadata": { -"description": "Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1alphaCreateTargetSiteMetadata", +"GoogleCloudDiscoveryengineV1alphaExportUserEventsMetadata": { +"description": "Metadata related to the progress of the Export operation. This is returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaExportUserEventsMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -8444,193 +9741,245 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaCustomTuningModel": { -"description": "Metadata that describes a custom tuned model.", -"id": "GoogleCloudDiscoveryengineV1alphaCustomTuningModel", +"GoogleCloudDiscoveryengineV1alphaExportUserEventsResponse": { +"description": "Response of the ExportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field.", +"id": "GoogleCloudDiscoveryengineV1alphaExportUserEventsResponse", "properties": { -"createTime": { -"deprecated": true, -"description": "Timestamp the Model was created at.", -"format": "google-datetime", -"type": "string" +"outputResult": { +"$ref": "GoogleCloudDiscoveryengineV1alphaOutputResult", +"description": "Output result indicating where the data were exported to." }, -"displayName": { -"description": "The display name of the model.", +"status": { +"$ref": "GoogleRpcStatus", +"description": "The status of the export operation." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaFieldConfig": { +"description": "Configurations for fields of a schema. For example, configuring a field is indexable, or searchable.", +"id": "GoogleCloudDiscoveryengineV1alphaFieldConfig", +"properties": { +"advancedSiteSearchDataSources": { +"description": "If this field is set, only the corresponding source will be indexed for this field. Otherwise, the values from different sources are merged. Assuming a page with `` in meta tag, and `` in page map: if this enum is set to METATAGS, we will only index ``; if this enum is not set, we will merge them and index ``.", +"items": { +"enum": [ +"ADVANCED_SITE_SEARCH_DATA_SOURCE_UNSPECIFIED", +"METATAGS", +"PAGEMAP", +"SCHEMA_ORG" +], +"enumDescriptions": [ +"Value used when unset.", +"Retrieve value from meta tag.", +"Retrieve value from page map.", +"Retrieve value from schema.org data." +], "type": "string" }, -"metrics": { -"additionalProperties": { -"format": "double", -"type": "number" +"type": "array" }, -"description": "The metrics of the trained model.", -"type": "object" +"completableOption": { +"description": "If completable_option is COMPLETABLE_ENABLED, field values are directly used and returned as suggestions for Autocomplete in CompletionService.CompleteQuery. If completable_option is unset, the server behavior defaults to COMPLETABLE_DISABLED for fields that support setting completable options, which are just `string` fields. For those fields that do not support setting completable options, the server will skip completable option setting, and setting completable_option for those fields will throw `INVALID_ARGUMENT` error.", +"enum": [ +"COMPLETABLE_OPTION_UNSPECIFIED", +"COMPLETABLE_ENABLED", +"COMPLETABLE_DISABLED" +], +"enumDescriptions": [ +"Value used when unset.", +"Completable option enabled for a schema field.", +"Completable option disabled for a schema field." +], +"type": "string" }, -"modelState": { -"description": "The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).", +"dynamicFacetableOption": { +"description": "If dynamic_facetable_option is DYNAMIC_FACETABLE_ENABLED, field values are available for dynamic facet. Could only be DYNAMIC_FACETABLE_DISABLED if FieldConfig.indexable_option is INDEXABLE_DISABLED. Otherwise, an `INVALID_ARGUMENT` error will be returned. If dynamic_facetable_option is unset, the server behavior defaults to DYNAMIC_FACETABLE_DISABLED for fields that support setting dynamic facetable options. For those fields that do not support setting dynamic facetable options, such as `object` and `boolean`, the server will skip dynamic facetable option setting, and setting dynamic_facetable_option for those fields will throw `INVALID_ARGUMENT` error.", "enum": [ -"MODEL_STATE_UNSPECIFIED", -"TRAINING_PAUSED", -"TRAINING", -"TRAINING_COMPLETE", -"READY_FOR_SERVING", -"TRAINING_FAILED", -"NO_IMPROVEMENT" +"DYNAMIC_FACETABLE_OPTION_UNSPECIFIED", +"DYNAMIC_FACETABLE_ENABLED", +"DYNAMIC_FACETABLE_DISABLED" ], "enumDescriptions": [ -"Default value.", -"The model is in a paused training state.", -"The model is currently training.", -"The model has successfully completed training.", -"The model is ready for serving.", -"The model training failed.", -"The model training finished successfully but metrics did not improve." +"Value used when unset.", +"Dynamic facetable option enabled for a schema field.", +"Dynamic facetable option disabled for a schema field." ], "type": "string" }, -"modelVersion": { -"description": "The version of the model.", -"format": "int64", -"type": "string" -}, -"name": { -"description": "Required. The fully qualified resource name of the model. Format: `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}` model must be an alpha-numerical string with limit of 40 characters.", -"type": "string" -}, -"trainingStartTime": { -"description": "Timestamp the model training was initiated.", -"format": "google-datetime", +"fieldPath": { +"description": "Required. Field path of the schema field. For example: `title`, `description`, `release_info.release_year`.", "type": "string" -} -}, -"type": "object" -}, -"GoogleCloudDiscoveryengineV1alphaDataStore": { -"description": "DataStore captures global settings and configs at the DataStore level.", -"id": "GoogleCloudDiscoveryengineV1alphaDataStore", -"properties": { -"aclEnabled": { -"description": "Immutable. Whether data in the DataStore has ACL information. If set to `true`, the source data must have ACL. ACL will be ingested when data is ingested by DocumentService.ImportDocuments methods. When ACL is enabled for the DataStore, Document can't be accessed by calling DocumentService.GetDocument or DocumentService.ListDocuments. Currently ACL is only supported in `GENERIC` industry vertical with non-`PUBLIC_WEBSITE` content config.", -"type": "boolean" }, -"contentConfig": { -"description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", +"fieldType": { +"description": "Output only. Raw type of the field.", "enum": [ -"CONTENT_CONFIG_UNSPECIFIED", -"NO_CONTENT", -"CONTENT_REQUIRED", -"PUBLIC_WEBSITE" +"FIELD_TYPE_UNSPECIFIED", +"OBJECT", +"STRING", +"NUMBER", +"INTEGER", +"BOOLEAN", +"GEOLOCATION", +"DATETIME" ], "enumDescriptions": [ -"Default value.", -"Only contains documents without any Document.content.", -"Only contains documents with Document.content.", -"The data store is used for public website search." +"Field type is unspecified.", +"Field value type is Object.", +"Field value type is String.", +"Field value type is Number.", +"Field value type is Integer.", +"Field value type is Boolean.", +"Field value type is Geolocation. Geolocation is expressed as an object with the following keys: * `id`: a string representing the location id * `longitude`: a number representing the longitude coordinate of the location * `latitude`: a number repesenting the latitude coordinate of the location * `address`: a string representing the full address of the location `latitude` and `longitude` must always be provided together. At least one of a) `address` or b) `latitude`-`longitude` pair must be provided.", +"Field value type is Datetime. Datetime can be expressed as either: * a number representing milliseconds-since-the-epoch * a string representing milliseconds-since-the-epoch. e.g. `\"1420070400001\"` * a string representing the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date or date and time. e.g. `\"2015-01-01\"` or `\"2015-01-01T12:10:30Z\"`" ], +"readOnly": true, "type": "string" }, -"createTime": { -"description": "Output only. Timestamp the DataStore was created at.", -"format": "google-datetime", -"readOnly": true, +"indexableOption": { +"description": "If indexable_option is INDEXABLE_ENABLED, field values are indexed so that it can be filtered or faceted in SearchService.Search. If indexable_option is unset, the server behavior defaults to INDEXABLE_DISABLED for fields that support setting indexable options. For those fields that do not support setting indexable options, such as `object` and `boolean` and key properties, the server will skip indexable_option setting, and setting indexable_option for those fields will throw `INVALID_ARGUMENT` error.", +"enum": [ +"INDEXABLE_OPTION_UNSPECIFIED", +"INDEXABLE_ENABLED", +"INDEXABLE_DISABLED" +], +"enumDescriptions": [ +"Value used when unset.", +"Indexable option enabled for a schema field.", +"Indexable option disabled for a schema field." +], "type": "string" }, -"defaultSchemaId": { -"description": "Output only. The id of the default Schema asscociated to this data store.", +"keyPropertyType": { +"description": "Output only. Type of the key property that this field is mapped to. Empty string if this is not annotated as mapped to a key property. Example types are `title`, `description`. Full list is defined by `keyPropertyMapping` in the schema field annotation. If the schema field has a `KeyPropertyMapping` annotation, `indexable_option` and `searchable_option` of this field cannot be modified.", "readOnly": true, "type": "string" }, -"displayName": { -"description": "Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.", +"recsFilterableOption": { +"description": "If recs_filterable_option is FILTERABLE_ENABLED, field values are filterable by filter expression in RecommendationService.Recommend. If FILTERABLE_ENABLED but the field type is numerical, field values are not filterable by text queries in RecommendationService.Recommend. Only textual fields are supported. If recs_filterable_option is unset, the default setting is FILTERABLE_DISABLED for fields that support setting filterable options. When a field set to [FILTERABLE_DISABLED] is filtered, a warning is generated and an empty result is returned.", +"enum": [ +"FILTERABLE_OPTION_UNSPECIFIED", +"FILTERABLE_ENABLED", +"FILTERABLE_DISABLED" +], +"enumDescriptions": [ +"Value used when unset.", +"Filterable option enabled for a schema field.", +"Filterable option disabled for a schema field." +], "type": "string" }, -"documentProcessingConfig": { -"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig", -"description": "Configuration for Document understanding and enrichment." -}, -"idpConfig": { -"$ref": "GoogleCloudDiscoveryengineV1alphaIdpConfig", -"description": "Output only. Data store level identity provider config.", -"readOnly": true -}, -"industryVertical": { -"description": "Immutable. The industry vertical that the data store registers.", +"retrievableOption": { +"description": "If retrievable_option is RETRIEVABLE_ENABLED, field values are included in the search results. If retrievable_option is unset, the server behavior defaults to RETRIEVABLE_DISABLED for fields that support setting retrievable options. For those fields that do not support setting retrievable options, such as `object` and `boolean`, the server will skip retrievable option setting, and setting retrievable_option for those fields will throw `INVALID_ARGUMENT` error.", "enum": [ -"INDUSTRY_VERTICAL_UNSPECIFIED", -"GENERIC", -"MEDIA", -"HEALTHCARE_FHIR" +"RETRIEVABLE_OPTION_UNSPECIFIED", +"RETRIEVABLE_ENABLED", +"RETRIEVABLE_DISABLED" ], "enumDescriptions": [ "Value used when unset.", -"The generic vertical for documents that are not specific to any industry vertical.", -"The media industry vertical.", -"The healthcare FHIR vertical." +"Retrievable option enabled for a schema field.", +"Retrievable option disabled for a schema field." ], "type": "string" }, -"languageInfo": { -"$ref": "GoogleCloudDiscoveryengineV1alphaLanguageInfo", -"description": "Language info for DataStore." -}, -"name": { -"description": "Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"schemaOrgPaths": { +"description": "Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished", +"items": { "type": "string" }, -"solutionTypes": { -"description": "The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.", -"items": { +"type": "array" +}, +"searchableOption": { +"description": "If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error.", "enum": [ -"SOLUTION_TYPE_UNSPECIFIED", -"SOLUTION_TYPE_RECOMMENDATION", -"SOLUTION_TYPE_SEARCH", -"SOLUTION_TYPE_CHAT", -"SOLUTION_TYPE_GENERATIVE_CHAT" +"SEARCHABLE_OPTION_UNSPECIFIED", +"SEARCHABLE_ENABLED", +"SEARCHABLE_DISABLED" ], "enumDescriptions": [ -"Default value.", -"Used for Recommendations AI.", -"Used for Discovery Search.", -"Used for use cases related to the Generative AI agent.", -"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution." +"Value used when unset.", +"Searchable option enabled for a schema field.", +"Searchable option disabled for a schema field." ], "type": "string" +} }, -"type": "array" +"type": "object" }, -"startingSchema": { -"$ref": "GoogleCloudDiscoveryengineV1alphaSchema", -"description": "The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema)." +"GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse": { +"description": "Response message for SiteSearchEngineService.GetUriPatternDocumentData method.", +"id": "GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse", +"properties": { +"documentDataMap": { +"additionalProperties": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" +}, +"description": "Document data keyed by URI pattern. For example: document_data_map = { \"www.url1.com/*\": { \"Categories\": [\"category1\", \"category2\"] }, \"www.url2.com/*\": { \"Categories\": [\"category3\"] } }", +"type": "object" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata": { -"description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata", +"GoogleCloudDiscoveryengineV1alphaIdpConfig": { +"description": "Identity Provider Config.", +"id": "GoogleCloudDiscoveryengineV1alphaIdpConfig", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"externalIdpConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig", +"description": "External Identity provider config." +}, +"idpType": { +"description": "Identity provider type configured.", +"enum": [ +"IDP_TYPE_UNSPECIFIED", +"GSUITE", +"THIRD_PARTY" +], +"enumDescriptions": [ +"Default value. ACL search not enabled.", +"Google 1P provider.", +"Third party provider." +], "type": "string" +} }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig": { +"description": "Third party IDP Config.", +"id": "GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig", +"properties": { +"workforcePoolName": { +"description": "Workforce pool name. Example: \"locations/global/workforcePools/pool_id\"", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaDeleteEngineMetadata": { -"description": "Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1alphaDeleteEngineMetadata", +"GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsMetadata": { +"description": "Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsMetadata", "properties": { "createTime": { "description": "Operation create time.", "format": "google-datetime", "type": "string" }, +"failureCount": { +"description": "Count of CompletionSuggestions that failed to be imported.", +"format": "int64", +"type": "string" +}, +"successCount": { +"description": "Count of CompletionSuggestions successfully imported.", +"format": "int64", +"type": "string" +}, "updateTime": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime", @@ -8639,47 +9988,46 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaDeleteSchemaMetadata": { -"description": "Metadata for DeleteSchema LRO.", -"id": "GoogleCloudDiscoveryengineV1alphaDeleteSchemaMetadata", +"GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsResponse": { +"description": "Response of the CompletionService.ImportCompletionSuggestions method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.", +"id": "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsResponse", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", -"type": "string" +"errorConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", +"description": "The desired location of errors incurred during the Import." }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", -"type": "string" +"errorSamples": { +"description": "A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaDeleteTargetSiteMetadata": { -"description": "Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1alphaDeleteTargetSiteMetadata", +"GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata": { +"description": "Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata", "properties": { "createTime": { "description": "Operation create time.", "format": "google-datetime", "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"failureCount": { +"description": "Count of entries that encountered errors while processing.", +"format": "int64", "type": "string" -} }, -"type": "object" +"successCount": { +"description": "Count of entries that were processed successfully.", +"format": "int64", +"type": "string" }, -"GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchMetadata": { -"description": "Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchMetadata", -"properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"totalCount": { +"description": "Total count of entries that were processed.", +"format": "int64", "type": "string" }, "updateTime": { @@ -8690,118 +10038,88 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchResponse": { -"description": "Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.", -"id": "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchResponse", -"properties": {}, -"type": "object" -}, -"GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig": { -"description": "A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config.", -"id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig", +"GoogleCloudDiscoveryengineV1alphaImportDocumentsResponse": { +"description": "Response of the ImportDocumentsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", +"id": "GoogleCloudDiscoveryengineV1alphaImportDocumentsResponse", "properties": { -"chunkingConfig": { -"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig", -"description": "Whether chunking mode is enabled." -}, -"defaultParsingConfig": { -"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig", -"description": "Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing." -}, -"name": { -"description": "The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.", -"type": "string" +"errorConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", +"description": "Echoes the destination for the complete errors in the request if set." }, -"parsingConfigOverrides": { -"additionalProperties": { -"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig" +"errorSamples": { +"description": "A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" }, -"description": "Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported.", -"type": "object" +"type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig": { -"description": "Configuration for chunking config.", -"id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig", +"GoogleCloudDiscoveryengineV1alphaImportErrorConfig": { +"description": "Configuration of destination for Import related errors.", +"id": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", "properties": { -"layoutBasedChunkingConfig": { -"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", -"description": "Configuration for the layout based chunking." +"gcsPrefix": { +"description": "Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.", +"type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig": { -"description": "Configuration for the layout based chunking.", -"id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", +"GoogleCloudDiscoveryengineV1alphaImportSampleQueriesMetadata": { +"description": "Metadata related to the progress of the ImportSampleQueries operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesMetadata", "properties": { -"chunkSize": { -"description": "The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.", -"format": "int32", -"type": "integer" -}, -"includeAncestorHeadings": { -"description": "Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False.", -"type": "boolean" -} +"createTime": { +"description": "ImportSampleQueries operation create time.", +"format": "google-datetime", +"type": "string" }, -"type": "object" +"failureCount": { +"description": "Count of SampleQuerys that failed to be imported.", +"format": "int64", +"type": "string" }, -"GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig": { -"description": "Related configurations applied to a specific type of document parser.", -"id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig", -"properties": { -"digitalParsingConfig": { -"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig", -"description": "Configurations applied to digital parser." +"successCount": { +"description": "Count of SampleQuerys successfully imported.", +"format": "int64", +"type": "string" }, -"layoutParsingConfig": { -"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig", -"description": "Configurations applied to layout parser." +"totalCount": { +"description": "Total count of SampleQuerys that were processed.", +"format": "int64", +"type": "string" }, -"ocrParsingConfig": { -"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig", -"description": "Configurations applied to OCR parser. Currently it only applies to PDFs." +"updateTime": { +"description": "ImportSampleQueries operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig": { -"description": "The digital parsing configurations for documents.", -"id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig", -"properties": {}, -"type": "object" -}, -"GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig": { -"description": "The layout parsing configurations for documents.", -"id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig", -"properties": {}, -"type": "object" -}, -"GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig": { -"description": "The OCR parsing configurations for documents.", -"id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig", +"GoogleCloudDiscoveryengineV1alphaImportSampleQueriesResponse": { +"description": "Response of the SampleQueryService.ImportSampleQueries method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.", +"id": "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesResponse", "properties": { -"enhancedDocumentElements": { -"deprecated": true, -"description": "[DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.", +"errorConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", +"description": "The desired location of errors incurred during the Import." +}, +"errorSamples": { +"description": "A sample of errors encountered while processing the request.", "items": { -"type": "string" +"$ref": "GoogleRpcStatus" }, "type": "array" -}, -"useNativeText": { -"description": "If true, will use native text instead of OCR text on pages containing native text.", -"type": "boolean" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchMetadata": { -"description": "Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchMetadata", +"GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata": { +"description": "Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -8816,343 +10134,346 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchResponse": { -"description": "Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.", -"id": "GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchResponse", -"properties": {}, -"type": "object" -}, -"GoogleCloudDiscoveryengineV1alphaEngine": { -"description": "Metadata that describes the training and serving parameters of an Engine.", -"id": "GoogleCloudDiscoveryengineV1alphaEngine", +"GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesResponse": { +"description": "Response message for CompletionService.ImportSuggestionDenyListEntries method.", +"id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesResponse", "properties": { -"chatEngineConfig": { -"$ref": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig", -"description": "Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT." -}, -"chatEngineMetadata": { -"$ref": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata", -"description": "Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.", -"readOnly": true +"errorSamples": { +"description": "A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" }, -"commonConfig": { -"$ref": "GoogleCloudDiscoveryengineV1alphaEngineCommonConfig", -"description": "Common config spec that specifies the metadata of the engine." +"type": "array" }, -"createTime": { -"description": "Output only. Timestamp the Recommendation Engine was created at.", -"format": "google-datetime", -"readOnly": true, +"failedEntriesCount": { +"description": "Count of deny list entries that failed to be imported.", +"format": "int64", "type": "string" }, -"dataStoreIds": { -"description": "The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.", -"items": { +"importedEntriesCount": { +"description": "Count of deny list entries successfully imported.", +"format": "int64", "type": "string" +} }, -"type": "array" +"type": "object" }, -"displayName": { -"description": "Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.", +"GoogleCloudDiscoveryengineV1alphaImportUserEventsMetadata": { +"description": "Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaImportUserEventsMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", "type": "string" }, -"industryVertical": { -"description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore linked to the engine.", -"enum": [ -"INDUSTRY_VERTICAL_UNSPECIFIED", -"GENERIC", -"MEDIA", -"HEALTHCARE_FHIR" -], -"enumDescriptions": [ -"Value used when unset.", -"The generic vertical for documents that are not specific to any industry vertical.", -"The media industry vertical.", -"The healthcare FHIR vertical." -], +"failureCount": { +"description": "Count of entries that encountered errors while processing.", +"format": "int64", "type": "string" }, -"mediaRecommendationEngineConfig": { -"$ref": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig", -"description": "Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical." +"successCount": { +"description": "Count of entries that were processed successfully.", +"format": "int64", +"type": "string" }, -"name": { -"description": "Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.", +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", "type": "string" +} }, -"recommendationMetadata": { -"$ref": "GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata", -"description": "Output only. Additional information of a recommendation engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION.", -"readOnly": true +"type": "object" }, -"searchEngineConfig": { -"$ref": "GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig", -"description": "Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH." +"GoogleCloudDiscoveryengineV1alphaImportUserEventsResponse": { +"description": "Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", +"id": "GoogleCloudDiscoveryengineV1alphaImportUserEventsResponse", +"properties": { +"errorConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", +"description": "Echoes the destination for the complete errors if this field was set in the request." }, -"similarDocumentsConfig": { -"$ref": "GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig", -"description": "Additional config specs for a `similar-items` engine." +"errorSamples": { +"description": "A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" }, -"solutionType": { -"description": "Required. The solutions of the engine.", -"enum": [ -"SOLUTION_TYPE_UNSPECIFIED", -"SOLUTION_TYPE_RECOMMENDATION", -"SOLUTION_TYPE_SEARCH", -"SOLUTION_TYPE_CHAT", -"SOLUTION_TYPE_GENERATIVE_CHAT" -], -"enumDescriptions": [ -"Default value.", -"Used for Recommendations AI.", -"Used for Discovery Search.", -"Used for use cases related to the Generative AI agent.", -"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution." -], +"type": "array" +}, +"joinedEventsCount": { +"description": "Count of user events imported with complete existing Documents.", +"format": "int64", "type": "string" }, -"updateTime": { -"description": "Output only. Timestamp the Recommendation Engine was last updated.", -"format": "google-datetime", -"readOnly": true, +"unjoinedEventsCount": { +"description": "Count of user events imported, but with Document information not found in the existing Branch.", +"format": "int64", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig": { -"description": "Configurations for a Chat Engine.", -"id": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig", +"GoogleCloudDiscoveryengineV1alphaInterval": { +"description": "A floating point interval.", +"id": "GoogleCloudDiscoveryengineV1alphaInterval", "properties": { -"agentCreationConfig": { -"$ref": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig", -"description": "The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation." +"exclusiveMaximum": { +"description": "Exclusive upper bound.", +"format": "double", +"type": "number" }, -"dialogflowAgentToLink": { -"description": "The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.", -"type": "string" +"exclusiveMinimum": { +"description": "Exclusive lower bound.", +"format": "double", +"type": "number" +}, +"maximum": { +"description": "Inclusive upper bound.", +"format": "double", +"type": "number" +}, +"minimum": { +"description": "Inclusive lower bound.", +"format": "double", +"type": "number" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig": { -"description": "Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.", -"id": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig", +"GoogleCloudDiscoveryengineV1alphaLanguageInfo": { +"description": "Language info for DataStore.", +"id": "GoogleCloudDiscoveryengineV1alphaLanguageInfo", "properties": { -"business": { -"description": "Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.", +"language": { +"description": "Output only. Language part of normalized_language_code. E.g.: `en-US` -> `en`, `zh-Hans-HK` -> `zh`, `en` -> `en`.", +"readOnly": true, "type": "string" }, -"defaultLanguageCode": { -"description": "Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes.", +"languageCode": { +"description": "The language code for the DataStore.", "type": "string" }, -"location": { -"description": "Agent location for Agent creation, supported values: global/us/eu. If not provided, us Engine will create Agent using us-central-1 by default; eu Engine will create Agent using eu-west-1 by default.", +"normalizedLanguageCode": { +"description": "Output only. This is the normalized form of language_code. E.g.: language_code of `en-GB`, `en_GB`, `en-UK` or `en-gb` will have normalized_language_code of `en-GB`.", +"readOnly": true, "type": "string" }, -"timeZone": { -"description": "Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.", +"region": { +"description": "Output only. Region part of normalized_language_code, if present. E.g.: `en-US` -> `US`, `zh-Hans-HK` -> `HK`, `en` -> ``.", +"readOnly": true, "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata": { -"description": "Additional information of a Chat Engine. Fields in this message are output only.", -"id": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata", +"GoogleCloudDiscoveryengineV1alphaListCustomModelsResponse": { +"description": "Response message for SearchTuningService.ListCustomModels method.", +"id": "GoogleCloudDiscoveryengineV1alphaListCustomModelsResponse", "properties": { -"dialogflowAgent": { -"description": "The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`.", -"type": "string" +"models": { +"description": "List of custom tuning models.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaCustomTuningModel" +}, +"type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaEngineCommonConfig": { -"description": "Common configurations for an Engine.", -"id": "GoogleCloudDiscoveryengineV1alphaEngineCommonConfig", +"GoogleCloudDiscoveryengineV1alphaOutputResult": { +"description": "Output result that stores the information about where the exported data is stored.", +"id": "GoogleCloudDiscoveryengineV1alphaOutputResult", "properties": { -"companyName": { -"description": "The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.", -"type": "string" +"bigqueryResult": { +"$ref": "GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult", +"description": "The BigQuery location where the result is stored." } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig": { -"description": "Additional config specs for a Media Recommendation engine.", -"id": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig", +"GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult": { +"description": "A BigQuery output result.", +"id": "GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult", "properties": { -"optimizationObjective": { -"description": "The optimization objective. e.g., `cvr`. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: `ctr`, `cvr`. If not specified, we choose default based on engine type. Default depends on type of recommendation: `recommended-for-you` => `ctr` `others-you-may-like` => `ctr`", -"type": "string" -}, -"optimizationObjectiveConfig": { -"$ref": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig", -"description": "Name and value of the custom threshold for cvr optimization_objective. For target_field `watch-time`, target_field_value must be an integer value indicating the media progress time in seconds between (0, 86400] (excludes 0, includes 86400) (e.g., 90). For target_field `watch-percentage`, the target_field_value must be a valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g., 0.5)." -}, -"trainingState": { -"description": "The training state that the engine is in (e.g. `TRAINING` or `PAUSED`). Since part of the cost of running the service is frequency of training - this can be used to determine when to train engine in order to control cost. If not specified: the default value for `CreateEngine` method is `TRAINING`. The default value for `UpdateEngine` method is to keep the state the same as before.", -"enum": [ -"TRAINING_STATE_UNSPECIFIED", -"PAUSED", -"TRAINING" -], -"enumDescriptions": [ -"Unspecified training state.", -"The engine training is paused.", -"The engine is training." -], +"datasetId": { +"description": "The ID of a BigQuery Dataset.", "type": "string" }, -"type": { -"description": "Required. The type of engine. e.g., `recommended-for-you`. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: `recommended-for-you`, `others-you-may-like`, `more-like-this`, `most-popular-items`.", +"tableId": { +"description": "The ID of a BigQuery Table.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig": { -"description": "Custom threshold for `cvr` optimization_objective.", -"id": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig", +"GoogleCloudDiscoveryengineV1alphaProject": { +"description": "Metadata and configurations for a Google Cloud project in the service.", +"id": "GoogleCloudDiscoveryengineV1alphaProject", "properties": { -"targetField": { -"description": "Required. The name of the field to target. Currently supported values: `watch-percentage`, `watch-time`.", +"createTime": { +"description": "Output only. The timestamp when this project is created.", +"format": "google-datetime", +"readOnly": true, "type": "string" }, -"targetFieldValueFloat": { -"description": "Required. The threshold to be applied to the target (e.g., 0.5).", -"format": "float", -"type": "number" +"name": { +"description": "Output only. Full resource name of the project, for example `projects/{project_number}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.", +"readOnly": true, +"type": "string" +}, +"provisionCompletionTime": { +"description": "Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"serviceTermsMap": { +"additionalProperties": { +"$ref": "GoogleCloudDiscoveryengineV1alphaProjectServiceTerms" +}, +"description": "Output only. A map of terms of services. The key is the `id` of ServiceTerms.", +"readOnly": true, +"type": "object" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata": { -"description": "Additional information of a recommendation engine.", -"id": "GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata", +"GoogleCloudDiscoveryengineV1alphaProjectServiceTerms": { +"description": "Metadata about the terms of service.", +"id": "GoogleCloudDiscoveryengineV1alphaProjectServiceTerms", "properties": { -"dataState": { -"description": "Output only. The state of data requirements for this engine: `DATA_OK` and `DATA_ERROR`. Engine cannot be trained if the data is in `DATA_ERROR` state. Engine can have `DATA_ERROR` state even if serving state is `ACTIVE`: engines were trained successfully before, but cannot be refreshed because the underlying engine no longer has sufficient data for training.", -"enum": [ -"DATA_STATE_UNSPECIFIED", -"DATA_OK", -"DATA_ERROR" -], -"enumDescriptions": [ -"Unspecified default value, should never be explicitly set.", -"The engine has sufficient training data.", -"The engine does not have sufficient training data. Error messages can be queried via Stackdriver." -], -"readOnly": true, +"acceptTime": { +"description": "The last time when the project agreed to the terms of service.", +"format": "google-datetime", "type": "string" }, -"lastTuneTime": { -"description": "Output only. The timestamp when the latest successful tune finished. Only applicable on Media Recommendation engines.", +"declineTime": { +"description": "The last time when the project declined or revoked the agreement to terms of service.", "format": "google-datetime", -"readOnly": true, "type": "string" }, -"servingState": { -"description": "Output only. The serving state of the engine: `ACTIVE`, `NOT_ACTIVE`.", +"id": { +"description": "The unique identifier of this terms of service. Available terms: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this as `id`, the acceptable version to provide is `2022-11-23`.", +"type": "string" +}, +"state": { +"description": "Whether the project has accepted/rejected the service terms or it is still pending.", "enum": [ -"SERVING_STATE_UNSPECIFIED", -"INACTIVE", -"ACTIVE", -"TUNED" +"STATE_UNSPECIFIED", +"TERMS_ACCEPTED", +"TERMS_PENDING", +"TERMS_DECLINED" ], "enumDescriptions": [ -"Unspecified serving state.", -"The engine is not serving.", -"The engine is serving and can be queried.", -"The engine is trained on tuned hyperparameters and can be queried." +"The default value of the enum. This value is not actually used.", +"The project has given consent to the terms of service.", +"The project is pending to review and accept the terms of service.", +"The project has declined or revoked the agreement to terms of service." ], -"readOnly": true, "type": "string" }, -"tuningOperation": { -"description": "Output only. The latest tune operation id associated with the engine. Only applicable on Media Recommendation engines. If present, this operation id can be used to determine if there is an ongoing tune for this engine. To check the operation status, send the GetOperation request with this operation id in the engine resource format. If no tuning has happened for this engine, the string is empty.", -"readOnly": true, +"version": { +"description": "The version string of the terms of service. For acceptable values, see the comments for id above.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig": { -"description": "Configurations for a Search Engine.", -"id": "GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig", +"GoogleCloudDiscoveryengineV1alphaProvisionProjectMetadata": { +"description": "Metadata associated with a project provision operation.", +"id": "GoogleCloudDiscoveryengineV1alphaProvisionProjectMetadata", +"properties": {}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsMetadata": { +"description": "Metadata related to the progress of the PurgeCompletionSuggestions operation. This is returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsMetadata", "properties": { -"searchAddOns": { -"description": "The add-on that this search engine enables.", -"items": { -"enum": [ -"SEARCH_ADD_ON_UNSPECIFIED", -"SEARCH_ADD_ON_LLM" -], -"enumDescriptions": [ -"Default value when the enum is unspecified. This is invalid to use.", -"Large language model add-on." -], +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", "type": "string" }, -"type": "array" -}, -"searchTier": { -"description": "The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified.", -"enum": [ -"SEARCH_TIER_UNSPECIFIED", -"SEARCH_TIER_STANDARD", -"SEARCH_TIER_ENTERPRISE" -], -"enumDescriptions": [ -"Default value when the enum is unspecified. This is invalid to use.", -"Standard tier.", -"Enterprise tier." -], +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig": { -"description": "Additional config specs for a `similar-items` engine.", -"id": "GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig", -"properties": {}, +"GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsResponse": { +"description": "Response message for CompletionService.PurgeCompletionSuggestions method.", +"id": "GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsResponse", +"properties": { +"errorSamples": { +"description": "A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"type": "array" +}, +"purgeSucceeded": { +"description": "Whether the completion suggestions were successfully purged.", +"type": "boolean" +} +}, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaEstimateDataSizeMetadata": { -"description": "Metadata related to the progress of the EstimateDataSize operation. This is returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeMetadata", +"GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata": { +"description": "Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata", "properties": { "createTime": { "description": "Operation create time.", "format": "google-datetime", "type": "string" +}, +"failureCount": { +"description": "Count of entries that encountered errors while processing.", +"format": "int64", +"type": "string" +}, +"ignoredCount": { +"description": "Count of entries that were ignored as entries were not found.", +"format": "int64", +"type": "string" +}, +"successCount": { +"description": "Count of entries that were deleted successfully.", +"format": "int64", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaEstimateDataSizeResponse": { -"description": "Response of the EstimateDataSize request. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", -"id": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeResponse", +"GoogleCloudDiscoveryengineV1alphaPurgeDocumentsResponse": { +"description": "Response message for DocumentService.PurgeDocuments method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.", +"id": "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsResponse", "properties": { -"dataSizeBytes": { -"description": "Data size in terms of bytes.", +"purgeCount": { +"description": "The total count of documents purged as a result of the operation.", "format": "int64", "type": "string" }, -"documentCount": { -"description": "Total number of documents.", -"format": "int64", +"purgeSample": { +"description": "A sample of document names that will be deleted. Only populated if `force` is set to false. A max of 100 names will be returned and the names are chosen at random.", +"items": { "type": "string" +}, +"type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaExportUserEventsMetadata": { -"description": "Metadata related to the progress of the Export operation. This is returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1alphaExportUserEventsMetadata", +"GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesMetadata": { +"description": "Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -9167,866 +10488,930 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaExportUserEventsResponse": { -"description": "Response of the ExportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field.", -"id": "GoogleCloudDiscoveryengineV1alphaExportUserEventsResponse", +"GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesResponse": { +"description": "Response message for CompletionService.PurgeSuggestionDenyListEntries method.", +"id": "GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesResponse", "properties": { -"outputResult": { -"$ref": "GoogleCloudDiscoveryengineV1alphaOutputResult", -"description": "Output result indicating where the data were exported to." +"errorSamples": { +"description": "A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" }, -"status": { -"$ref": "GoogleRpcStatus", -"description": "The status of the export operation." +"type": "array" +}, +"purgeCount": { +"description": "Number of suggestion deny list entries purged.", +"format": "int64", +"type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaFieldConfig": { -"description": "Configurations for fields of a schema. For example, configuring a field is indexable, or searchable.", -"id": "GoogleCloudDiscoveryengineV1alphaFieldConfig", +"GoogleCloudDiscoveryengineV1alphaPurgeUserEventsMetadata": { +"description": "Metadata related to the progress of the PurgeUserEvents operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaPurgeUserEventsMetadata", "properties": { -"advancedSiteSearchDataSources": { -"description": "If this field is set, only the corresponding source will be indexed for this field. Otherwise, the values from different sources are merged. Assuming a page with `` in meta tag, and `` in page map: if this enum is set to METATAGS, we will only index ``; if this enum is not set, we will merge them and index ``.", -"items": { -"enum": [ -"ADVANCED_SITE_SEARCH_DATA_SOURCE_UNSPECIFIED", -"METATAGS", -"PAGEMAP", -"SCHEMA_ORG" -], -"enumDescriptions": [ -"Value used when unset.", -"Retrieve value from meta tag.", -"Retrieve value from page map.", -"Retrieve value from schema.org data." -], +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", "type": "string" }, -"type": "array" -}, -"completableOption": { -"description": "If completable_option is COMPLETABLE_ENABLED, field values are directly used and returned as suggestions for Autocomplete in CompletionService.CompleteQuery. If completable_option is unset, the server behavior defaults to COMPLETABLE_DISABLED for fields that support setting completable options, which are just `string` fields. For those fields that do not support setting completable options, the server will skip completable option setting, and setting completable_option for those fields will throw `INVALID_ARGUMENT` error.", -"enum": [ -"COMPLETABLE_OPTION_UNSPECIFIED", -"COMPLETABLE_ENABLED", -"COMPLETABLE_DISABLED" -], -"enumDescriptions": [ -"Value used when unset.", -"Completable option enabled for a schema field.", -"Completable option disabled for a schema field." -], +"failureCount": { +"description": "Count of entries that encountered errors while processing.", +"format": "int64", "type": "string" }, -"dynamicFacetableOption": { -"description": "If dynamic_facetable_option is DYNAMIC_FACETABLE_ENABLED, field values are available for dynamic facet. Could only be DYNAMIC_FACETABLE_DISABLED if FieldConfig.indexable_option is INDEXABLE_DISABLED. Otherwise, an `INVALID_ARGUMENT` error will be returned. If dynamic_facetable_option is unset, the server behavior defaults to DYNAMIC_FACETABLE_DISABLED for fields that support setting dynamic facetable options. For those fields that do not support setting dynamic facetable options, such as `object` and `boolean`, the server will skip dynamic facetable option setting, and setting dynamic_facetable_option for those fields will throw `INVALID_ARGUMENT` error.", -"enum": [ -"DYNAMIC_FACETABLE_OPTION_UNSPECIFIED", -"DYNAMIC_FACETABLE_ENABLED", -"DYNAMIC_FACETABLE_DISABLED" -], -"enumDescriptions": [ -"Value used when unset.", -"Dynamic facetable option enabled for a schema field.", -"Dynamic facetable option disabled for a schema field." -], +"successCount": { +"description": "Count of entries that were deleted successfully.", +"format": "int64", "type": "string" }, -"fieldPath": { -"description": "Required. Field path of the schema field. For example: `title`, `description`, `release_info.release_year`.", +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", "type": "string" +} }, -"fieldType": { -"description": "Output only. Raw type of the field.", -"enum": [ -"FIELD_TYPE_UNSPECIFIED", -"OBJECT", -"STRING", -"NUMBER", -"INTEGER", -"BOOLEAN", -"GEOLOCATION", -"DATETIME" -], -"enumDescriptions": [ -"Field type is unspecified.", -"Field value type is Object.", -"Field value type is String.", -"Field value type is Number.", -"Field value type is Integer.", -"Field value type is Boolean.", -"Field value type is Geolocation. Geolocation is expressed as an object with the following keys: * `id`: a string representing the location id * `longitude`: a number representing the longitude coordinate of the location * `latitude`: a number repesenting the latitude coordinate of the location * `address`: a string representing the full address of the location `latitude` and `longitude` must always be provided together. At least one of a) `address` or b) `latitude`-`longitude` pair must be provided.", -"Field value type is Datetime. Datetime can be expressed as either: * a number representing milliseconds-since-the-epoch * a string representing milliseconds-since-the-epoch. e.g. `\"1420070400001\"` * a string representing the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date or date and time. e.g. `\"2015-01-01\"` or `\"2015-01-01T12:10:30Z\"`" -], -"readOnly": true, -"type": "string" +"type": "object" }, -"indexableOption": { -"description": "If indexable_option is INDEXABLE_ENABLED, field values are indexed so that it can be filtered or faceted in SearchService.Search. If indexable_option is unset, the server behavior defaults to INDEXABLE_DISABLED for fields that support setting indexable options. For those fields that do not support setting indexable options, such as `object` and `boolean` and key properties, the server will skip indexable_option setting, and setting indexable_option for those fields will throw `INVALID_ARGUMENT` error.", -"enum": [ -"INDEXABLE_OPTION_UNSPECIFIED", -"INDEXABLE_ENABLED", -"INDEXABLE_DISABLED" -], -"enumDescriptions": [ -"Value used when unset.", -"Indexable option enabled for a schema field.", -"Indexable option disabled for a schema field." -], +"GoogleCloudDiscoveryengineV1alphaPurgeUserEventsResponse": { +"description": "Response of the PurgeUserEventsRequest. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.", +"id": "GoogleCloudDiscoveryengineV1alphaPurgeUserEventsResponse", +"properties": { +"purgeCount": { +"description": "The total count of events purged as a result of the operation.", +"format": "int64", "type": "string" +} }, -"keyPropertyType": { -"description": "Output only. Type of the key property that this field is mapped to. Empty string if this is not annotated as mapped to a key property. Example types are `title`, `description`. Full list is defined by `keyPropertyMapping` in the schema field annotation. If the schema field has a `KeyPropertyMapping` annotation, `indexable_option` and `searchable_option` of this field cannot be modified.", -"readOnly": true, -"type": "string" +"type": "object" }, -"recsFilterableOption": { -"description": "If recs_filterable_option is FILTERABLE_ENABLED, field values are filterable by filter expression in RecommendationService.Recommend. If FILTERABLE_ENABLED but the field type is numerical, field values are not filterable by text queries in RecommendationService.Recommend. Only textual fields are supported. If recs_filterable_option is unset, the default setting is FILTERABLE_DISABLED for fields that support setting filterable options. When a field set to [FILTERABLE_DISABLED] is filtered, a warning is generated and an empty result is returned.", -"enum": [ -"FILTERABLE_OPTION_UNSPECIFIED", -"FILTERABLE_ENABLED", -"FILTERABLE_DISABLED" -], -"enumDescriptions": [ -"Value used when unset.", -"Filterable option enabled for a schema field.", -"Filterable option disabled for a schema field." -], -"type": "string" +"GoogleCloudDiscoveryengineV1alphaQualityMetrics": { +"description": "Describes the metrics produced by the evaluation.", +"id": "GoogleCloudDiscoveryengineV1alphaQualityMetrics", +"properties": { +"docNdcg": { +"$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", +"description": "Normalized discounted cumulative gain (NDCG) per document, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved documents (D1, D2, D3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [D3 (0), D1 (1), D2 (1)] Ideal: [D1 (1), D2 (1), D3 (0)] Calculate NDCG@3 for each SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693" }, -"retrievableOption": { -"description": "If retrievable_option is RETRIEVABLE_ENABLED, field values are included in the search results. If retrievable_option is unset, the server behavior defaults to RETRIEVABLE_DISABLED for fields that support setting retrievable options. For those fields that do not support setting retrievable options, such as `object` and `boolean`, the server will skip retrievable option setting, and setting retrievable_option for those fields will throw `INVALID_ARGUMENT` error.", -"enum": [ -"RETRIEVABLE_OPTION_UNSPECIFIED", -"RETRIEVABLE_ENABLED", -"RETRIEVABLE_DISABLED" -], -"enumDescriptions": [ -"Value used when unset.", -"Retrievable option enabled for a schema field.", -"Retrievable option disabled for a schema field." -], -"type": "string" +"docPrecision": { +"$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", +"description": "Precision per document, at various top-k cutoff levels. Precision is the fraction of retrieved documents that are relevant. Example (top-5): * For a single SampleQuery, If 4 out of 5 retrieved documents in the top-5 are relevant, precision@5 = 4/5 = 0.8" }, -"schemaOrgPaths": { -"description": "Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished", -"items": { -"type": "string" +"docRecall": { +"$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", +"description": "Recall per document, at various top-k cutoff levels. Recall is the fraction of relevant documents retrieved out of all relevant documents. Example (top-5): * For a single SampleQuery, If 3 out of 5 relevant documents are retrieved in the top-5, recall@5 = 3/5 = 0.6" }, -"type": "array" +"pageNdcg": { +"$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", +"description": "Normalized discounted cumulative gain (NDCG) per page, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved pages (P1, P2, P3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [P3 (0), P1 (1), P2 (1)] Ideal: [P1 (1), P2 (1), P3 (0)] Calculate NDCG@3 for SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693" }, -"searchableOption": { -"description": "If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error.", -"enum": [ -"SEARCHABLE_OPTION_UNSPECIFIED", -"SEARCHABLE_ENABLED", -"SEARCHABLE_DISABLED" -], -"enumDescriptions": [ -"Value used when unset.", -"Searchable option enabled for a schema field.", -"Searchable option disabled for a schema field." -], -"type": "string" +"pageRecall": { +"$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", +"description": "Recall per page, at various top-k cutoff levels. Recall is the fraction of relevant pages retrieved out of all relevant pages. Example (top-5): * For a single SampleQuery, if 3 out of 5 relevant pages are retrieved in the top-5, recall@5 = 3/5 = 0.6" } }, -"type": "object" +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics": { +"description": "Stores the metric values at specific top-k levels.", +"id": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", +"properties": { +"top1": { +"description": "The top-1 value.", +"format": "double", +"type": "number" +}, +"top10": { +"description": "The top-10 value.", +"format": "double", +"type": "number" }, -"GoogleCloudDiscoveryengineV1alphaIdpConfig": { -"description": "Identity Provider Config.", -"id": "GoogleCloudDiscoveryengineV1alphaIdpConfig", -"properties": { -"externalIdpConfig": { -"$ref": "GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig", -"description": "External Identity provider config." +"top3": { +"description": "The top-3 value.", +"format": "double", +"type": "number" }, -"idpType": { -"description": "Identity provider type configured.", -"enum": [ -"IDP_TYPE_UNSPECIFIED", -"GSUITE", -"THIRD_PARTY" -], -"enumDescriptions": [ -"Default value. ACL search not enabled.", -"Google 1P provider.", -"Third party provider." -], -"type": "string" +"top5": { +"description": "The top-5 value.", +"format": "double", +"type": "number" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig": { -"description": "Third party IDP Config.", -"id": "GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig", +"GoogleCloudDiscoveryengineV1alphaQuery": { +"description": "Defines a user inputed query.", +"id": "GoogleCloudDiscoveryengineV1alphaQuery", "properties": { -"workforcePoolName": { -"description": "Workforce pool name. Example: \"locations/global/workforcePools/pool_id\"", +"queryId": { +"description": "Unique Id for the query.", +"type": "string" +}, +"text": { +"description": "Plain text.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsMetadata": { -"description": "Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsMetadata", +"GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata": { +"description": "Metadata related to the progress of the SiteSearchEngineService.RecrawlUris operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata", "properties": { "createTime": { "description": "Operation create time.", "format": "google-datetime", "type": "string" }, -"failureCount": { -"description": "Count of CompletionSuggestions that failed to be imported.", -"format": "int64", +"invalidUris": { +"description": "Unique URIs in the request that don't match any TargetSite in the DataStore, only match TargetSites that haven't been fully indexed, or match a TargetSite with type EXCLUDE.", +"items": { "type": "string" }, +"type": "array" +}, +"pendingCount": { +"description": "Total number of URIs that have yet to be crawled.", +"format": "int32", +"type": "integer" +}, +"quotaExceededCount": { +"description": "Total number of URIs that were rejected due to insufficient indexing resources.", +"format": "int32", +"type": "integer" +}, "successCount": { -"description": "Count of CompletionSuggestions successfully imported.", -"format": "int64", -"type": "string" +"description": "Total number of URIs that have been crawled so far.", +"format": "int32", +"type": "integer" }, "updateTime": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime", "type": "string" +}, +"validUrisCount": { +"description": "Total number of unique URIs in the request that are not in invalid_uris.", +"format": "int32", +"type": "integer" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsResponse": { -"description": "Response of the CompletionService.ImportCompletionSuggestions method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.", -"id": "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsResponse", +"GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse": { +"description": "Response message for SiteSearchEngineService.RecrawlUris method.", +"id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse", "properties": { -"errorConfig": { -"$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", -"description": "The desired location of errors incurred during the Import." +"failedUris": { +"description": "URIs that were not crawled before the LRO terminated.", +"items": { +"type": "string" }, -"errorSamples": { -"description": "A sample of errors encountered while processing the request.", +"type": "array" +}, +"failureSamples": { +"description": "Details for a sample of up to 10 `failed_uris`.", "items": { -"$ref": "GoogleRpcStatus" +"$ref": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo" }, "type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata": { -"description": "Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata", +"GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo": { +"description": "Details about why a particular URI failed to be crawled. Each FailureInfo contains one FailureReason per CorpusType.", +"id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", -"type": "string" +"failureReasons": { +"description": "List of failure reasons by corpus type (e.g. desktop, mobile).", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason" }, -"failureCount": { -"description": "Count of entries that encountered errors while processing.", -"format": "int64", -"type": "string" +"type": "array" }, -"successCount": { -"description": "Count of entries that were processed successfully.", -"format": "int64", +"uri": { +"description": "URI that failed to be crawled.", "type": "string" +} }, -"totalCount": { -"description": "Total count of entries that were processed.", -"format": "int64", +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason": { +"description": "Details about why crawling failed for a particular CorpusType, e.g., DESKTOP and MOBILE crawling may fail for different reasons.", +"id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason", +"properties": { +"corpusType": { +"description": "DESKTOP, MOBILE, or CORPUS_TYPE_UNSPECIFIED.", +"enum": [ +"CORPUS_TYPE_UNSPECIFIED", +"DESKTOP", +"MOBILE" +], +"enumDescriptions": [ +"Default value.", +"Denotes a crawling attempt for the desktop version of a page.", +"Denotes a crawling attempt for the mobile version of a page." +], "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"errorMessage": { +"description": "Reason why the URI was not crawled.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaImportDocumentsResponse": { -"description": "Response of the ImportDocumentsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", -"id": "GoogleCloudDiscoveryengineV1alphaImportDocumentsResponse", +"GoogleCloudDiscoveryengineV1alphaSchema": { +"description": "Defines the structure and layout of a type of document data.", +"id": "GoogleCloudDiscoveryengineV1alphaSchema", "properties": { -"errorConfig": { -"$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", -"description": "Echoes the destination for the complete errors in the request if set." -}, -"errorSamples": { -"description": "A sample of errors encountered while processing the request.", +"fieldConfigs": { +"description": "Output only. Configurations for fields of the schema.", "items": { -"$ref": "GoogleRpcStatus" +"$ref": "GoogleCloudDiscoveryengineV1alphaFieldConfig" }, +"readOnly": true, "type": "array" -} }, -"type": "object" +"jsonSchema": { +"description": "The JSON representation of the schema.", +"type": "string" }, -"GoogleCloudDiscoveryengineV1alphaImportErrorConfig": { -"description": "Configuration of destination for Import related errors.", -"id": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", -"properties": { -"gcsPrefix": { -"description": "Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.", +"name": { +"description": "Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" +}, +"structSchema": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "The structured representation of the schema.", +"type": "object" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata": { -"description": "Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata", +"GoogleCloudDiscoveryengineV1alphaSearchRequest": { +"description": "Request message for SearchService.Search method.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequest", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"boostSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec", +"description": "Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)" +}, +"branch": { +"description": "The branch resource name, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Use `default_branch` as the branch ID or leave this field empty, to search documents under the default branch.", "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"canonicalFilter": { +"description": "The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about filter syntax, see SearchRequest.filter.", "type": "string" -} }, -"type": "object" +"contentSearchSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec", +"description": "A specification for configuring the behavior of content search." }, -"GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesResponse": { -"description": "Response message for CompletionService.ImportSuggestionDenyListEntries method.", -"id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesResponse", -"properties": { -"errorSamples": { -"description": "A sample of errors encountered while processing the request.", +"customFineTuningSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec", +"description": "Custom fine tuning configs. If set, it has higher priority than the configs set in ServingConfig.custom_fine_tuning_spec." +}, +"dataStoreSpecs": { +"description": "Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.", "items": { -"$ref": "GoogleRpcStatus" +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec" }, "type": "array" }, -"failedEntriesCount": { -"description": "Count of deny list entries that failed to be imported.", -"format": "int64", +"embeddingSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec", +"description": "Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path." +}, +"facetSpecs": { +"description": "Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec" +}, +"type": "array" +}, +"filter": { +"description": "The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY(\"king kong\")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)", +"type": "string" +}, +"imageQuery": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery", +"description": "Raw image query." +}, +"languageCode": { +"description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.", +"type": "string" +}, +"naturalLanguageQueryUnderstandingSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec", +"description": "If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done." +}, +"offset": { +"description": "A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.", +"format": "int32", +"type": "integer" +}, +"orderBy": { +"description": "The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering for retail search, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.", "type": "string" }, -"importedEntriesCount": { -"description": "Count of deny list entries successfully imported.", -"format": "int64", +"pageSize": { +"description": "Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.", +"format": "int32", +"type": "integer" +}, +"pageToken": { +"description": "A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", "type": "string" -} }, +"params": { +"additionalProperties": { +"type": "any" +}, +"description": "Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. For example, `user_country_code: \"au\"` For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example, `search_type: 1`", "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaImportUserEventsMetadata": { -"description": "Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1alphaImportUserEventsMetadata", -"properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"query": { +"description": "Raw search query.", "type": "string" }, -"failureCount": { -"description": "Count of entries that encountered errors while processing.", -"format": "int64", -"type": "string" +"queryExpansionSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec", +"description": "The query expansion specification that specifies the conditions under which query expansion occurs." }, -"successCount": { -"description": "Count of entries that were processed successfully.", -"format": "int64", +"rankingExpression": { +"description": "The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The ranking expression is a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.", "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"regionCode": { +"description": "The Unicode country/region code (CLDR) of a location, such as \"US\" and \"419\". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.", "type": "string" -} -}, -"type": "object" }, -"GoogleCloudDiscoveryengineV1alphaImportUserEventsResponse": { -"description": "Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", -"id": "GoogleCloudDiscoveryengineV1alphaImportUserEventsResponse", -"properties": { -"errorConfig": { -"$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", -"description": "Echoes the destination for the complete errors if this field was set in the request." +"relevanceThreshold": { +"description": "The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information.", +"enum": [ +"RELEVANCE_THRESHOLD_UNSPECIFIED", +"LOWEST", +"LOW", +"MEDIUM", +"HIGH" +], +"enumDescriptions": [ +"Default value. In this case, server behavior defaults to Google defined threshold.", +"Lowest relevance threshold.", +"Low relevance threshold.", +"Medium relevance threshold.", +"High relevance threshold." +], +"type": "string" }, -"errorSamples": { -"description": "A sample of errors encountered while processing the request.", -"items": { -"$ref": "GoogleRpcStatus" +"safeSearch": { +"description": "Whether to turn on safe search. This is only supported for website search.", +"type": "boolean" }, -"type": "array" +"searchAsYouTypeSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec", +"description": "Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical." }, -"joinedEventsCount": { -"description": "Count of user events imported with complete existing Documents.", -"format": "int64", +"servingConfig": { +"description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.", "type": "string" }, -"unjoinedEventsCount": { -"description": "Count of user events imported, but with Document information not found in the existing Branch.", -"format": "int64", +"session": { +"description": "The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is \"How did Alphabet do in 2022?\" and the current query is \"How about 2023?\", the current query will be interpreted as \"How did Alphabet do in 2023?\". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.", "type": "string" -} }, -"type": "object" +"sessionSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec", +"description": "Session specification. Can be used only when `session` is set." }, -"GoogleCloudDiscoveryengineV1alphaLanguageInfo": { -"description": "Language info for DataStore.", -"id": "GoogleCloudDiscoveryengineV1alphaLanguageInfo", -"properties": { -"language": { -"description": "Output only. Language part of normalized_language_code. E.g.: `en-US` -> `en`, `zh-Hans-HK` -> `zh`, `en` -> `en`.", -"readOnly": true, -"type": "string" +"spellCorrectionSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec", +"description": "The spell correction specification that specifies the mode under which spell correction takes effect." }, -"languageCode": { -"description": "The language code for the DataStore.", -"type": "string" +"userInfo": { +"$ref": "GoogleCloudDiscoveryengineV1alphaUserInfo", +"description": "Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics." }, -"normalizedLanguageCode": { -"description": "Output only. This is the normalized form of language_code. E.g.: language_code of `en-GB`, `en_GB`, `en-UK` or `en-gb` will have normalized_language_code of `en-GB`.", -"readOnly": true, +"userLabels": { +"additionalProperties": { "type": "string" }, -"region": { -"description": "Output only. Region part of normalized_language_code, if present. E.g.: `en-US` -> `US`, `zh-Hans-HK` -> `HK`, `en` -> ``.", -"readOnly": true, +"description": "The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * 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. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.", +"type": "object" +}, +"userPseudoId": { +"description": "A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaListCustomModelsResponse": { -"description": "Response message for SearchTuningService.ListCustomModels method.", -"id": "GoogleCloudDiscoveryengineV1alphaListCustomModelsResponse", +"GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec": { +"description": "Boost specification to boost certain documents.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec", "properties": { -"models": { -"description": "List of custom tuning models.", +"conditionBoostSpecs": { +"description": "Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.", "items": { -"$ref": "GoogleCloudDiscoveryengineV1alphaCustomTuningModel" +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec" }, "type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaOutputResult": { -"description": "Output result that stores the information about where the exported data is stored.", -"id": "GoogleCloudDiscoveryengineV1alphaOutputResult", +"GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec": { +"description": "Boost applies to documents which match a condition.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec", "properties": { -"bigqueryResult": { -"$ref": "GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult", -"description": "The BigQuery location where the result is stored." -} -}, -"type": "object" +"boost": { +"description": "Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied.", +"format": "float", +"type": "number" }, -"GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult": { -"description": "A BigQuery output result.", -"id": "GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult", -"properties": { -"datasetId": { -"description": "The ID of a BigQuery Dataset.", -"type": "string" +"boostControlSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec", +"description": "Complex specification for custom ranking based on customer defined attribute value." }, -"tableId": { -"description": "The ID of a BigQuery Table.", +"condition": { +"description": "An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID \"doc_1\" or \"doc_2\", and color \"Red\" or \"Blue\": `(document_id: ANY(\"doc_1\", \"doc_2\")) AND (color: ANY(\"Red\", \"Blue\"))`", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaProject": { -"description": "Metadata and configurations for a Google Cloud project in the service.", -"id": "GoogleCloudDiscoveryengineV1alphaProject", +"GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec": { +"description": "Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec", "properties": { -"createTime": { -"description": "Output only. The timestamp when this project is created.", -"format": "google-datetime", -"readOnly": true, +"attributeType": { +"description": "The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).", +"enum": [ +"ATTRIBUTE_TYPE_UNSPECIFIED", +"NUMERICAL", +"FRESHNESS" +], +"enumDescriptions": [ +"Unspecified AttributeType.", +"The value of the numerical field will be used to dynamically update the boost amount. In this case, the attribute_value (the x value) of the control point will be the actual value of the numerical field for which the boost_amount is specified.", +"For the freshness use case the attribute value will be the duration between the current time and the date in the datetime field specified. The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. For example, `5D`, `3DT12H30M`, `T24H`." +], "type": "string" }, -"name": { -"description": "Output only. Full resource name of the project, for example `projects/{project_number}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.", -"readOnly": true, -"type": "string" +"controlPoints": { +"description": "The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint" }, -"provisionCompletionTime": { -"description": "Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use.", -"format": "google-datetime", -"readOnly": true, -"type": "string" +"type": "array" }, -"serviceTermsMap": { -"additionalProperties": { -"$ref": "GoogleCloudDiscoveryengineV1alphaProjectServiceTerms" +"fieldName": { +"description": "The name of the field whose value will be used to determine the boost amount.", +"type": "string" }, -"description": "Output only. A map of terms of services. The key is the `id` of ServiceTerms.", -"readOnly": true, -"type": "object" +"interpolationType": { +"description": "The interpolation type to be applied to connect the control points listed below.", +"enum": [ +"INTERPOLATION_TYPE_UNSPECIFIED", +"LINEAR" +], +"enumDescriptions": [ +"Interpolation type is unspecified. In this case, it defaults to Linear.", +"Piecewise linear interpolation will be applied." +], +"type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaProjectServiceTerms": { -"description": "Metadata about the terms of service.", -"id": "GoogleCloudDiscoveryengineV1alphaProjectServiceTerms", +"GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint": { +"description": "The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint", "properties": { -"acceptTime": { -"description": "The last time when the project agreed to the terms of service.", -"format": "google-datetime", +"attributeValue": { +"description": "Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.", "type": "string" }, -"declineTime": { -"description": "The last time when the project declined or revoked the agreement to terms of service.", -"format": "google-datetime", -"type": "string" +"boostAmount": { +"description": "The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.", +"format": "float", +"type": "number" +} }, -"id": { -"description": "The unique identifier of this terms of service. Available terms: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this as `id`, the acceptable version to provide is `2022-11-23`.", -"type": "string" +"type": "object" }, -"state": { -"description": "Whether the project has accepted/rejected the service terms or it is still pending.", +"GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec": { +"description": "A specification for configuring the behavior of content search.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec", +"properties": { +"chunkSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec", +"description": "Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS" +}, +"extractiveContentSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec", +"description": "If there is no extractive_content_spec provided, there will be no extractive answer in the search response." +}, +"searchResultMode": { +"description": "Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.", "enum": [ -"STATE_UNSPECIFIED", -"TERMS_ACCEPTED", -"TERMS_PENDING", -"TERMS_DECLINED" +"SEARCH_RESULT_MODE_UNSPECIFIED", +"DOCUMENTS", +"CHUNKS" ], "enumDescriptions": [ -"The default value of the enum. This value is not actually used.", -"The project has given consent to the terms of service.", -"The project is pending to review and accept the terms of service.", -"The project has declined or revoked the agreement to terms of service." +"Default value.", +"Returns documents in the search result.", +"Returns chunks in the search result. Only available if the DataStore.DocumentProcessingConfig.chunking_config is specified." ], "type": "string" }, -"version": { -"description": "The version string of the terms of service. For acceptable values, see the comments for id above.", -"type": "string" +"snippetSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec", +"description": "If `snippetSpec` is not specified, snippets are not included in the search response." +}, +"summarySpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec", +"description": "If `summarySpec` is not specified, summaries are not included in the search response." } }, -"type": "object" +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec": { +"description": "Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec", +"properties": { +"numNextChunks": { +"description": "The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned.", +"format": "int32", +"type": "integer" +}, +"numPreviousChunks": { +"description": "The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned.", +"format": "int32", +"type": "integer" +} }, -"GoogleCloudDiscoveryengineV1alphaProvisionProjectMetadata": { -"description": "Metadata associated with a project provision operation.", -"id": "GoogleCloudDiscoveryengineV1alphaProvisionProjectMetadata", -"properties": {}, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsMetadata": { -"description": "Metadata related to the progress of the PurgeCompletionSuggestions operation. This is returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsMetadata", +"GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec": { +"description": "A specification for configuring the extractive content in a search response.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", -"type": "string" +"maxExtractiveAnswerCount": { +"description": "The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult.", +"format": "int32", +"type": "integer" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", -"type": "string" +"maxExtractiveSegmentCount": { +"description": "The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`.", +"format": "int32", +"type": "integer" +}, +"numNextSegments": { +"description": "Return at most `num_next_segments` segments after each selected segments.", +"format": "int32", +"type": "integer" +}, +"numPreviousSegments": { +"description": "Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.", +"format": "int32", +"type": "integer" +}, +"returnExtractiveSegmentScore": { +"description": "Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`.", +"type": "boolean" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsResponse": { -"description": "Response message for CompletionService.PurgeCompletionSuggestions method.", -"id": "GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsResponse", +"GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec": { +"description": "A specification for configuring snippets in a search response.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec", "properties": { -"errorSamples": { -"description": "A sample of errors encountered while processing the request.", -"items": { -"$ref": "GoogleRpcStatus" +"maxSnippetCount": { +"deprecated": true, +"description": "[DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0.", +"format": "int32", +"type": "integer" }, -"type": "array" +"referenceOnly": { +"deprecated": true, +"description": "[DEPRECATED] This field is deprecated and will have no affect on the snippet.", +"type": "boolean" }, -"purgeSucceeded": { -"description": "Whether the completion suggestions were successfully purged.", +"returnSnippet": { +"description": "If `true`, then return snippet. If no snippet can be generated, we return \"No snippet is available for this page.\" A `snippet_status` with `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned.", "type": "boolean" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata": { -"description": "Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata", +"GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec": { +"description": "A specification for configuring a summary returned in a search response.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", -"type": "string" +"ignoreAdversarialQuery": { +"description": "Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead.", +"type": "boolean" }, -"failureCount": { -"description": "Count of entries that encountered errors while processing.", -"format": "int64", -"type": "string" +"ignoreNonSummarySeekingQuery": { +"description": "Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead.", +"type": "boolean" }, -"ignoredCount": { -"description": "Count of entries that were ignored as entries were not found.", -"format": "int64", -"type": "string" +"includeCitations": { +"description": "Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results.", +"type": "boolean" }, -"successCount": { -"description": "Count of entries that were deleted successfully.", -"format": "int64", +"languageCode": { +"description": "Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.", "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", -"type": "string" +"modelPromptSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec", +"description": "If specified, the spec will be used to modify the prompt provided to the LLM." +}, +"modelSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec", +"description": "If specified, the spec will be used to modify the model specification provided to the LLM." +}, +"summaryResultCount": { +"description": "The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.", +"format": "int32", +"type": "integer" +}, +"useSemanticChunks": { +"description": "If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list.", +"type": "boolean" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaPurgeDocumentsResponse": { -"description": "Response message for DocumentService.PurgeDocuments method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.", -"id": "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsResponse", +"GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec": { +"description": "Specification of the prompt to use with the model.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec", "properties": { -"purgeCount": { -"description": "The total count of documents purged as a result of the operation.", -"format": "int64", -"type": "string" -}, -"purgeSample": { -"description": "A sample of document names that will be deleted. Only populated if `force` is set to false. A max of 100 names will be returned and the names are chosen at random.", -"items": { +"preamble": { +"description": "Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide.", "type": "string" -}, -"type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesMetadata": { -"description": "Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesMetadata", +"GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec": { +"description": "Specification of the model.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"version": { +"description": "The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). * `preview`: string. (Public preview) Uses a preview model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).", "type": "string" +} }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec": { +"description": "A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec", +"properties": { +"dataStore": { +"description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesResponse": { -"description": "Response message for CompletionService.PurgeSuggestionDenyListEntries method.", -"id": "GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesResponse", +"GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec": { +"description": "The specification that uses customized query embedding vector to do semantic document retrieval.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec", "properties": { -"errorSamples": { -"description": "A sample of errors encountered while processing the request.", +"embeddingVectors": { +"description": "The embedding vector used for retrieval. Limit to 1.", "items": { -"$ref": "GoogleRpcStatus" +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector" }, "type": "array" -}, -"purgeCount": { -"description": "Number of suggestion deny list entries purged.", -"format": "int64", -"type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaPurgeUserEventsMetadata": { -"description": "Metadata related to the progress of the PurgeUserEvents operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1alphaPurgeUserEventsMetadata", +"GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector": { +"description": "Embedding vector.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", -"type": "string" -}, -"failureCount": { -"description": "Count of entries that encountered errors while processing.", -"format": "int64", +"fieldPath": { +"description": "Embedding field path in schema.", "type": "string" }, -"successCount": { -"description": "Count of entries that were deleted successfully.", -"format": "int64", -"type": "string" +"vector": { +"description": "Query embedding vector.", +"items": { +"format": "float", +"type": "number" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", -"type": "string" +"type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaPurgeUserEventsResponse": { -"description": "Response of the PurgeUserEventsRequest. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.", -"id": "GoogleCloudDiscoveryengineV1alphaPurgeUserEventsResponse", +"GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec": { +"description": "A facet specification to perform faceted search.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec", "properties": { -"purgeCount": { -"description": "The total count of events purged as a result of the operation.", -"format": "int64", +"enableDynamicPosition": { +"description": "Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * \"rating\", enable_dynamic_position = true * \"price\", enable_dynamic_position = false * \"brands\", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be (\"price\", \"brands\", \"rating\", \"gender\") or (\"price\", \"brands\", \"gender\", \"rating\") depends on how API orders \"gender\" and \"rating\" facets. However, notice that \"price\" and \"brands\" are always ranked at first and second position because their enable_dynamic_position is false.", +"type": "boolean" +}, +"excludedFilterKeys": { +"description": "List of keys to exclude when faceting. By default, FacetKey.key is not excluded from the filter unless it is listed in this field. Listing a facet key in this field allows its values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned. For example, suppose there are 100 documents with the color facet \"Red\" and 200 documents with the color facet \"Blue\". A query containing the filter \"color:ANY(\"Red\")\" and having \"color\" as FacetKey.key would by default return only \"Red\" documents in the search results, and also return \"Red\" with count 100 as the only color facet. Although there are also blue documents available, \"Blue\" would not be shown as an available facet value. If \"color\" is listed in \"excludedFilterKeys\", then the query returns the facet values \"Red\" with count 100 and \"Blue\" with count 200, because the \"color\" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly filtered to return only \"Red\" documents. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"items": { "type": "string" -} }, -"type": "object" +"type": "array" }, -"GoogleCloudDiscoveryengineV1alphaQuery": { -"description": "Defines a user inputed query.", -"id": "GoogleCloudDiscoveryengineV1alphaQuery", -"properties": { -"queryId": { -"description": "Unique Id for the query.", -"type": "string" +"facetKey": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey", +"description": "Required. The facet key specification." }, -"text": { -"description": "Plain text.", -"type": "string" +"limit": { +"description": "Maximum facet values that are returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. For aggregation in healthcare search, when the [FacetKey.key] is \"healthcare_aggregation_key\", the limit will be overridden to 10,000 internally, regardless of the value set here. If this field is negative, an `INVALID_ARGUMENT` is returned.", +"format": "int32", +"type": "integer" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata": { -"description": "Metadata related to the progress of the SiteSearchEngineService.RecrawlUris operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata", +"GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey": { +"description": "Specifies how a facet is computed.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", -"type": "string" +"caseInsensitive": { +"description": "True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.", +"type": "boolean" }, -"invalidUris": { -"description": "Unique URIs in the request that don't match any TargetSite in the DataStore, only match TargetSites that haven't been fully indexed, or match a TargetSite with type EXCLUDE.", +"contains": { +"description": "Only get facet values that contain the given strings. For example, suppose \"category\" has three values \"Action > 2022\", \"Action > 2021\" and \"Sci-Fi > 2022\". If set \"contains\" to \"2022\", the \"category\" facet only contains \"Action > 2022\" and \"Sci-Fi > 2022\". Only supported on textual fields. Maximum is 10.", "items": { "type": "string" }, "type": "array" }, -"pendingCount": { -"description": "Total number of URIs that have yet to be crawled.", -"format": "int32", -"type": "integer" -}, -"quotaExceededCount": { -"description": "Total number of URIs that were rejected due to insufficient indexing resources.", -"format": "int32", -"type": "integer" -}, -"successCount": { -"description": "Total number of URIs that have been crawled so far.", -"format": "int32", -"type": "integer" +"intervals": { +"description": "Set only if values should be bucketed into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaInterval" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", -"type": "string" +"type": "array" }, -"validUrisCount": { -"description": "Total number of unique URIs in the request that are not in invalid_uris.", -"format": "int32", -"type": "integer" -} +"key": { +"description": "Required. Supported textual and numerical facet keys in Document object, over which the facet values are computed. Facet key is case-sensitive.", +"type": "string" }, -"type": "object" +"orderBy": { +"description": "The order in which documents are returned. Allowed values are: * \"count desc\", which means order by SearchResponse.Facet.values.count descending. * \"value desc\", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets. If not set, textual values are sorted in [natural order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals.", +"type": "string" }, -"GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse": { -"description": "Response message for SiteSearchEngineService.RecrawlUris method.", -"id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse", -"properties": { -"failedUris": { -"description": "URIs that were not crawled before the LRO terminated.", +"prefixes": { +"description": "Only get facet values that start with the given string prefix. For example, suppose \"category\" has three values \"Action > 2022\", \"Action > 2021\" and \"Sci-Fi > 2022\". If set \"prefixes\" to \"Action\", the \"category\" facet only contains \"Action > 2022\" and \"Action > 2021\". Only supported on textual fields. Maximum is 10.", "items": { "type": "string" }, "type": "array" }, -"failureSamples": { -"description": "Details for a sample of up to 10 `failed_uris`.", +"restrictedValues": { +"description": "Only get facet for the given restricted values. Only supported on textual fields. For example, suppose \"category\" has three values \"Action > 2022\", \"Action > 2021\" and \"Sci-Fi > 2022\". If set \"restricted_values\" to \"Action > 2022\", the \"category\" facet only contains \"Action > 2022\". Only supported on textual fields. Maximum is 10.", "items": { -"$ref": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo" +"type": "string" }, "type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo": { -"description": "Details about why a particular URI failed to be crawled. Each FailureInfo contains one FailureReason per CorpusType.", -"id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo", +"GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery": { +"description": "Specifies the image query input.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery", "properties": { -"failureReasons": { -"description": "List of failure reasons by corpus type (e.g. desktop, mobile).", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason" -}, -"type": "array" -}, -"uri": { -"description": "URI that failed to be crawled.", +"imageBytes": { +"description": "Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason": { -"description": "Details about why crawling failed for a particular CorpusType, e.g., DESKTOP and MOBILE crawling may fail for different reasons.", -"id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason", +"GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec": { +"description": "Specification to enable natural language understanding capabilities for search requests.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec", "properties": { -"corpusType": { -"description": "DESKTOP, MOBILE, or CORPUS_TYPE_UNSPECIFIED.", +"filterExtractionCondition": { +"description": "The condition under which filter extraction should occur. Default to Condition.DISABLED.", "enum": [ -"CORPUS_TYPE_UNSPECIFIED", -"DESKTOP", -"MOBILE" +"CONDITION_UNSPECIFIED", +"DISABLED", +"ENABLED" ], "enumDescriptions": [ -"Default value.", -"Denotes a crawling attempt for the desktop version of a page.", -"Denotes a crawling attempt for the mobile version of a page." +"Server behavior defaults to Condition.DISABLED.", +"Disables NL filter extraction.", +"Enables NL filter extraction." ], "type": "string" }, -"errorMessage": { -"description": "Reason why the URI was not crawled.", +"geoSearchQueryDetectionFieldNames": { +"description": "Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.", +"items": { "type": "string" +}, +"type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaSchema": { -"description": "Defines the structure and layout of a type of document data.", -"id": "GoogleCloudDiscoveryengineV1alphaSchema", +"GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec": { +"description": "Specification to determine under which conditions query expansion should occur.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec", "properties": { -"fieldConfigs": { -"description": "Output only. Configurations for fields of the schema.", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1alphaFieldConfig" +"condition": { +"description": "The condition under which query expansion should occur. Default to Condition.DISABLED.", +"enum": [ +"CONDITION_UNSPECIFIED", +"DISABLED", +"AUTO" +], +"enumDescriptions": [ +"Unspecified query expansion condition. In this case, server behavior defaults to Condition.DISABLED.", +"Disabled query expansion. Only the exact search query is used, even if SearchResponse.total_size is zero.", +"Automatic query expansion built by the Search API." +], +"type": "string" }, -"readOnly": true, -"type": "array" +"pinUnexpandedResults": { +"description": "Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results.", +"type": "boolean" +} }, -"jsonSchema": { -"description": "The JSON representation of the schema.", +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec": { +"description": "Specification for search as you type in search requests.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec", +"properties": { +"condition": { +"description": "The condition under which search as you type should occur. Default to Condition.DISABLED.", +"enum": [ +"CONDITION_UNSPECIFIED", +"DISABLED", +"ENABLED" +], +"enumDescriptions": [ +"Server behavior defaults to Condition.DISABLED.", +"Disables Search As You Type.", +"Enables Search As You Type." +], "type": "string" +} }, -"name": { -"description": "Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec": { +"description": "Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec", +"properties": { +"queryId": { +"description": "If set, the search result gets stored to the \"turn\" specified by this query ID. Example: Let's say the session looks like this: session { name: \".../sessions/xxx\" turns { query { text: \"What is foo?\" query_id: \".../questions/yyy\" } answer: \"Foo is ...\" } turns { query { text: \"How about bar then?\" query_id: \".../questions/zzz\" } } } The user can call /search API with a request like this: session: \".../sessions/xxx\" session_spec { query_id: \".../questions/zzz\" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID.", "type": "string" }, -"structSchema": { -"additionalProperties": { -"description": "Properties of the object.", -"type": "any" +"searchResultPersistenceCount": { +"description": "The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is simliar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode.", +"format": "int32", +"type": "integer" +} }, -"description": "The structured representation of the schema.", "type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec": { +"description": "The specification for query spell correction.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec", +"properties": { +"mode": { +"description": "The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO.", +"enum": [ +"MODE_UNSPECIFIED", +"SUGGESTION_ONLY", +"AUTO" +], +"enumDescriptions": [ +"Unspecified spell correction mode. In this case, server behavior defaults to Mode.AUTO.", +"Search API tries to find a spelling suggestion. If a suggestion is found, it is put in the SearchResponse.corrected_query. The spelling suggestion won't be used as the search query.", +"Automatic spell correction built by the Search API. Search will be based on the corrected query if found." +], +"type": "string" } }, "type": "object" @@ -10092,6 +11477,29 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataMetadata": { +"description": "Metadata related to the progress of the SiteSearchEngineService.SetUriPatternDocumentData operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataResponse": { +"description": "Response message for SiteSearchEngineService.SetUriPatternDocumentData method.", +"id": "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataResponse", +"properties": {}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo": { "description": "Verification information for target sites in advanced site search.", "id": "GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo", @@ -10324,6 +11732,21 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaUserInfo": { +"description": "Information of an end user.", +"id": "GoogleCloudDiscoveryengineV1alphaUserInfo", +"properties": { +"userAgent": { +"description": "User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set.", +"type": "string" +}, +"userId": { +"description": "Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaAlloyDbSource": { "description": "AlloyDB source import data from.", "id": "GoogleCloudDiscoveryengineV1betaAlloyDbSource", @@ -10716,7 +12139,7 @@ "type": "string" }, "searchResultMode": { -"description": "Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents)", +"description": "Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents)", "enum": [ "SEARCH_RESULT_MODE_UNSPECIFIED", "DOCUMENTS", @@ -10867,7 +12290,7 @@ "properties": { "answer": { "$ref": "GoogleCloudDiscoveryengineV1betaAnswer", -"description": "Answer resource object. If AnswerQueryRequest.StepSpec.max_step_count is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API." +"description": "Answer resource object. If AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.max_rephrase_steps is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API." }, "answerQueryToken": { "description": "A global unique ID used for logging.", @@ -11131,7 +12554,7 @@ "description": "Properties of the object.", "type": "any" }, -"description": "Data representation. The structured JSON data for the document. It's populated from the struct data from the Document (code pointer: http://shortn/_objzAfIiHq), or the Chunk in search result (code pointer: http://shortn/_Ipo6KFFGBL).", +"description": "Data representation. The structured JSON data for the document. It's populated from the struct data from the Document , or the Chunk in search result .", "type": "object" }, "title": { @@ -12142,6 +13565,12 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaCreateEvaluationMetadata": { +"description": "Metadata for EvaluationService.CreateEvaluation method.", +"id": "GoogleCloudDiscoveryengineV1betaCreateEvaluationMetadata", +"properties": {}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata": { "description": "Metadata for Create Schema LRO.", "id": "GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata", @@ -12857,50 +14286,140 @@ "type": "string" } }, -"type": "object" +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaEngineCommonConfig": { +"description": "Common configurations for an Engine.", +"id": "GoogleCloudDiscoveryengineV1betaEngineCommonConfig", +"properties": { +"companyName": { +"description": "The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig": { +"description": "Configurations for a Search Engine.", +"id": "GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig", +"properties": { +"searchAddOns": { +"description": "The add-on that this search engine enables.", +"items": { +"enum": [ +"SEARCH_ADD_ON_UNSPECIFIED", +"SEARCH_ADD_ON_LLM" +], +"enumDescriptions": [ +"Default value when the enum is unspecified. This is invalid to use.", +"Large language model add-on." +], +"type": "string" +}, +"type": "array" +}, +"searchTier": { +"description": "The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified.", +"enum": [ +"SEARCH_TIER_UNSPECIFIED", +"SEARCH_TIER_STANDARD", +"SEARCH_TIER_ENTERPRISE" +], +"enumDescriptions": [ +"Default value when the enum is unspecified. This is invalid to use.", +"Standard tier.", +"Enterprise tier." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaEvaluation": { +"description": "An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data.", +"id": "GoogleCloudDiscoveryengineV1betaEvaluation", +"properties": { +"createTime": { +"description": "Output only. Timestamp the Evaluation was created at.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"endTime": { +"description": "Output only. Timestamp the Evaluation was completed at.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"error": { +"$ref": "GoogleRpcStatus", +"description": "Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED.", +"readOnly": true +}, +"errorSamples": { +"description": "Output only. A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"readOnly": true, +"type": "array" +}, +"evaluationSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec", +"description": "Required. The specification of the evaluation." }, -"GoogleCloudDiscoveryengineV1betaEngineCommonConfig": { -"description": "Common configurations for an Engine.", -"id": "GoogleCloudDiscoveryengineV1betaEngineCommonConfig", -"properties": { -"companyName": { -"description": "The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.", +"name": { +"description": "Immutable. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" -} }, -"type": "object" +"qualityMetrics": { +"$ref": "GoogleCloudDiscoveryengineV1betaQualityMetrics", +"description": "Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet. Only populated when the evaluation's state is SUCCEEDED.", +"readOnly": true }, -"GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig": { -"description": "Configurations for a Search Engine.", -"id": "GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig", -"properties": { -"searchAddOns": { -"description": "The add-on that this search engine enables.", -"items": { +"state": { +"description": "Output only. The state of the evaluation.", "enum": [ -"SEARCH_ADD_ON_UNSPECIFIED", -"SEARCH_ADD_ON_LLM" +"STATE_UNSPECIFIED", +"PENDING", +"RUNNING", +"SUCCEEDED", +"FAILED" ], "enumDescriptions": [ -"Default value when the enum is unspecified. This is invalid to use.", -"Large language model add-on." +"The evaluation is unspecified.", +"The service is preparing to run the evaluation.", +"The evaluation is in progress.", +"The evaluation completed successfully.", +"The evaluation failed." ], +"readOnly": true, "type": "string" +} }, -"type": "array" +"type": "object" }, -"searchTier": { -"description": "The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified.", -"enum": [ -"SEARCH_TIER_UNSPECIFIED", -"SEARCH_TIER_STANDARD", -"SEARCH_TIER_ENTERPRISE" -], -"enumDescriptions": [ -"Default value when the enum is unspecified. This is invalid to use.", -"Standard tier.", -"Enterprise tier." -], +"GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec": { +"description": "Describes the specification of the evaluation.", +"id": "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec", +"properties": { +"querySetSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec", +"description": "Required. The specification of the query set." +}, +"searchRequest": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequest", +"description": "Required. The search request that is used to perform the evaluation. Only the following fields within SearchRequest are supported; if any other fields are provided, an UNSUPPORTED error will be returned: * SearchRequest.serving_config * SearchRequest.branch * SearchRequest.canonical_filter * SearchRequest.query_expansion_spec * SearchRequest.spell_correction_spec * SearchRequest.content_search_spec * SearchRequest.user_pseudo_id" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec": { +"description": "Describes the specification of the query set.", +"id": "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec", +"properties": { +"sampleQuerySet": { +"description": "Required. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.", "type": "string" } }, @@ -13261,6 +14780,93 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaImportSampleQueriesMetadata": { +"description": "Metadata related to the progress of the ImportSampleQueries operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1betaImportSampleQueriesMetadata", +"properties": { +"createTime": { +"description": "ImportSampleQueries operation create time.", +"format": "google-datetime", +"type": "string" +}, +"failureCount": { +"description": "Count of SampleQuerys that failed to be imported.", +"format": "int64", +"type": "string" +}, +"successCount": { +"description": "Count of SampleQuerys successfully imported.", +"format": "int64", +"type": "string" +}, +"totalCount": { +"description": "Total count of SampleQuerys that were processed.", +"format": "int64", +"type": "string" +}, +"updateTime": { +"description": "ImportSampleQueries operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaImportSampleQueriesRequest": { +"description": "Request message for SampleQueryService.ImportSampleQueries method.", +"id": "GoogleCloudDiscoveryengineV1betaImportSampleQueriesRequest", +"properties": { +"bigquerySource": { +"$ref": "GoogleCloudDiscoveryengineV1betaBigQuerySource", +"description": "BigQuery input source." +}, +"errorConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", +"description": "The desired location of errors incurred during the Import." +}, +"gcsSource": { +"$ref": "GoogleCloudDiscoveryengineV1betaGcsSource", +"description": "Cloud Storage location for the input content." +}, +"inlineSource": { +"$ref": "GoogleCloudDiscoveryengineV1betaImportSampleQueriesRequestInlineSource", +"description": "The Inline source for sample query entries." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaImportSampleQueriesRequestInlineSource": { +"description": "The inline source for SampleQuerys.", +"id": "GoogleCloudDiscoveryengineV1betaImportSampleQueriesRequestInlineSource", +"properties": { +"sampleQueries": { +"description": "Required. A list of SampleQuerys to import. Max of 1000 items.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaSampleQuery" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaImportSampleQueriesResponse": { +"description": "Response of the SampleQueryService.ImportSampleQueries method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.", +"id": "GoogleCloudDiscoveryengineV1betaImportSampleQueriesResponse", +"properties": { +"errorConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", +"description": "The desired location of errors incurred during the Import." +}, +"errorSamples": { +"description": "A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesMetadata": { "description": "Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesMetadata", @@ -13580,6 +15186,95 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaListEvaluationResultsResponse": { +"description": "Response message for EvaluationService.ListEvaluationResults method.", +"id": "GoogleCloudDiscoveryengineV1betaListEvaluationResultsResponse", +"properties": { +"evaluationResults": { +"description": "The EvaluationResults.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaListEvaluationResultsResponseEvaluationResult" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token that can be sent as ListEvaluationResultsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaListEvaluationResultsResponseEvaluationResult": { +"description": "Represents the results of an evaluation for a single SampleQuery.", +"id": "GoogleCloudDiscoveryengineV1betaListEvaluationResultsResponseEvaluationResult", +"properties": { +"qualityMetrics": { +"$ref": "GoogleCloudDiscoveryengineV1betaQualityMetrics", +"description": "Output only. The metrics produced by the evaluation, for a given SampleQuery.", +"readOnly": true +}, +"sampleQuery": { +"$ref": "GoogleCloudDiscoveryengineV1betaSampleQuery", +"description": "Output only. The SampleQuery that was evaluated.", +"readOnly": true +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaListEvaluationsResponse": { +"description": "Response message for EvaluationService.ListEvaluations method.", +"id": "GoogleCloudDiscoveryengineV1betaListEvaluationsResponse", +"properties": { +"evaluations": { +"description": "The Evaluations.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaEvaluation" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token that can be sent as ListEvaluationsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaListSampleQueriesResponse": { +"description": "Response message for SampleQueryService.ListSampleQueries method.", +"id": "GoogleCloudDiscoveryengineV1betaListSampleQueriesResponse", +"properties": { +"nextPageToken": { +"description": "A token that can be sent as ListSampleQueriesRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", +"type": "string" +}, +"sampleQueries": { +"description": "The SampleQuerys.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaSampleQuery" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaListSampleQuerySetsResponse": { +"description": "Response message for SampleQuerySetService.ListSampleQuerySets method.", +"id": "GoogleCloudDiscoveryengineV1betaListSampleQuerySetsResponse", +"properties": { +"nextPageToken": { +"description": "A token that can be sent as ListSampleQuerySetsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", +"type": "string" +}, +"sampleQuerySets": { +"description": "The SampleQuerySets.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaSampleQuerySet" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaListSchemasResponse": { "description": "Response message for SchemaService.ListSchemas method.", "id": "GoogleCloudDiscoveryengineV1betaListSchemasResponse", @@ -13936,6 +15631,60 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaQualityMetrics": { +"description": "Describes the metrics produced by the evaluation.", +"id": "GoogleCloudDiscoveryengineV1betaQualityMetrics", +"properties": { +"docNdcg": { +"$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", +"description": "Normalized discounted cumulative gain (NDCG) per document, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved documents (D1, D2, D3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [D3 (0), D1 (1), D2 (1)] Ideal: [D1 (1), D2 (1), D3 (0)] Calculate NDCG@3 for each SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693" +}, +"docPrecision": { +"$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", +"description": "Precision per document, at various top-k cutoff levels. Precision is the fraction of retrieved documents that are relevant. Example (top-5): * For a single SampleQuery, If 4 out of 5 retrieved documents in the top-5 are relevant, precision@5 = 4/5 = 0.8" +}, +"docRecall": { +"$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", +"description": "Recall per document, at various top-k cutoff levels. Recall is the fraction of relevant documents retrieved out of all relevant documents. Example (top-5): * For a single SampleQuery, If 3 out of 5 relevant documents are retrieved in the top-5, recall@5 = 3/5 = 0.6" +}, +"pageNdcg": { +"$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", +"description": "Normalized discounted cumulative gain (NDCG) per page, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved pages (P1, P2, P3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [P3 (0), P1 (1), P2 (1)] Ideal: [P1 (1), P2 (1), P3 (0)] Calculate NDCG@3 for SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693" +}, +"pageRecall": { +"$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", +"description": "Recall per page, at various top-k cutoff levels. Recall is the fraction of relevant pages retrieved out of all relevant pages. Example (top-5): * For a single SampleQuery, if 3 out of 5 relevant pages are retrieved in the top-5, recall@5 = 3/5 = 0.6" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics": { +"description": "Stores the metric values at specific top-k levels.", +"id": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", +"properties": { +"top1": { +"description": "The top-1 value.", +"format": "double", +"type": "number" +}, +"top10": { +"description": "The top-10 value.", +"format": "double", +"type": "number" +}, +"top3": { +"description": "The top-3 value.", +"format": "double", +"type": "number" +}, +"top5": { +"description": "The top-5 value.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaQuery": { "description": "Defines a user inputed query.", "id": "GoogleCloudDiscoveryengineV1betaQuery", @@ -14186,6 +15935,94 @@ "properties": {}, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaSampleQuery": { +"description": "Sample Query captures metadata to be used for evaluation.", +"id": "GoogleCloudDiscoveryengineV1betaSampleQuery", +"properties": { +"createTime": { +"description": "Output only. Timestamp the SampleQuery was created at.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"type": "string" +}, +"queryEntry": { +"$ref": "GoogleCloudDiscoveryengineV1betaSampleQueryQueryEntry", +"description": "The query entry." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSampleQueryQueryEntry": { +"description": "Query Entry captures metadata to be used for search evaluation.", +"id": "GoogleCloudDiscoveryengineV1betaSampleQueryQueryEntry", +"properties": { +"query": { +"description": "Required. The query.", +"type": "string" +}, +"targets": { +"description": "List of targets for the query.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaSampleQueryQueryEntryTarget" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSampleQueryQueryEntryTarget": { +"description": "Defines the parameters of the query's expected outcome.", +"id": "GoogleCloudDiscoveryengineV1betaSampleQueryQueryEntryTarget", +"properties": { +"pageNumbers": { +"description": "Expected page numbers of the target. Each page number must be non negative.", +"items": { +"format": "int32", +"type": "integer" +}, +"type": "array" +}, +"score": { +"description": "Relevance score of the target.", +"format": "double", +"type": "number" +}, +"uri": { +"description": "Expected uri of the target. This field must be a UTF-8 encoded string with a length limit of 2048 characters. Example of valid uris: `https://example.com/abc`, `gcs://example/example.pdf`.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSampleQuerySet": { +"description": "A SampleQuerySet is the parent resource of SampleQuery, and contains the configurations shared by all SampleQuery under it.", +"id": "GoogleCloudDiscoveryengineV1betaSampleQuerySet", +"properties": { +"createTime": { +"description": "Output only. Timestamp the SampleQuerySet was created at.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"description": { +"description": "The description of the SampleQuerySet.", +"type": "string" +}, +"displayName": { +"description": "Required. The sample query set display name. This field must be a UTF-8 encoded string with a length limit of 128 characters.", +"type": "string" +}, +"name": { +"description": "Immutable. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaSchema": { "description": "Defines the structure and layout of a type of document data.", "id": "GoogleCloudDiscoveryengineV1betaSchema", @@ -14332,6 +16169,10 @@ "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec", "description": "Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical." }, +"servingConfig": { +"description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.", +"type": "string" +}, "session": { "description": "The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is \"How did Alphabet do in 2022?\" and the current query is \"How about 2023?\", the current query will be interpreted as \"How did Alphabet do in 2023?\". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.", "type": "string" @@ -14469,7 +16310,7 @@ "description": "If there is no extractive_content_spec provided, there will be no extractive answer in the search response." }, "searchResultMode": { -"description": "Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`.", +"description": "Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.", "enum": [ "SEARCH_RESULT_MODE_UNSPECIFIED", "DOCUMENTS", @@ -14773,7 +16614,7 @@ "type": "string" }, "geoSearchQueryDetectionFieldNames": { -"description": "Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in Servingconfig.geo_search_query_detection_field_names.", +"description": "Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.", "items": { "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/displayvideo.v3.json b/googleapiclient/discovery_cache/documents/displayvideo.v3.json index d549a6a0d83..2b1d5b15a31 100644 --- a/googleapiclient/discovery_cache/documents/displayvideo.v3.json +++ b/googleapiclient/discovery_cache/documents/displayvideo.v3.json @@ -9222,7 +9222,7 @@ } } }, -"revision": "20240701", +"revision": "20240717", "rootUrl": "https://displayvideo.googleapis.com/", "schemas": { "ActiveViewVideoViewabilityMetricConfig": { @@ -16719,7 +16719,7 @@ false "type": "array" }, "adGroupQaIds": { -"description": "Optional. YouTube Ad Groups QA to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest.", +"description": "Optional. YouTube Ad Groups, by ID, to download in QA format. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest.", "items": { "format": "int64", "type": "string" @@ -16751,7 +16751,7 @@ false "type": "array" }, "lineItemQaIds": { -"description": "Optional. Line Items QA to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest.", +"description": "Optional. Line Items, by ID, to download in QA format. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest.", "items": { "format": "int64", "type": "string" @@ -19624,8 +19624,8 @@ false "Line Item.", "YouTube Ad Group.", "YouTube Ad.", -"Line Item QA.", -"YouTube Ad Group QA." +"Line Item - QA format.", +"YouTube Ad Group - QA format." ], "type": "string" }, @@ -19656,8 +19656,8 @@ false "Advertiser ID. If selected, all filter IDs must be Advertiser IDs that belong to the Partner specified in CreateSdfDownloadTaskRequest.", "Campaign ID. If selected, all filter IDs must be Campaign IDs that belong to the Advertiser or Partner specified in CreateSdfDownloadTaskRequest.", "Media Product ID. If selected, all filter IDs must be Media Product IDs that belong to the Advertiser or Partner specified in CreateSdfDownloadTaskRequest. Can only be used for downloading `FILE_TYPE_MEDIA_PRODUCT`.", -"Insertion Order ID. If selected, all filter IDs must be Insertion Order IDs that belong to the Advertiser or Partner specified in CreateSdfDownloadTaskRequest. Can only be used for downloading `FILE_TYPE_INSERTION_ORDER`, `FILE_TYPE_LINE_ITEM`, `FILE_TYPE_AD_GROUP`, and `FILE_TYPE_AD`.", -"Line Item ID. If selected, all filter IDs must be Line Item IDs that belong to the Advertiser or Partner specified in CreateSdfDownloadTaskRequest. Can only be used for downloading `FILE_TYPE_LINE_ITEM`, `FILE_TYPE_AD_GROUP`, and `FILE_TYPE_AD`." +"Insertion Order ID. If selected, all filter IDs must be Insertion Order IDs that belong to the Advertiser or Partner specified in CreateSdfDownloadTaskRequest. Can only be used for downloading `FILE_TYPE_INSERTION_ORDER`, `FILE_TYPE_LINE_ITEM`, `FILE_TYPE_LINE_ITEM_QA`, `FILE_TYPE_AD_GROUP`, `FILE_TYPE_AD_GROUP_QA`, and `FILE_TYPE_AD`.", +"Line Item ID. If selected, all filter IDs must be Line Item IDs that belong to the Advertiser or Partner specified in CreateSdfDownloadTaskRequest. Can only be used for downloading `FILE_TYPE_LINE_ITEM`, `FILE_TYPE_LINE_ITEM_QA`,`FILE_TYPE_AD_GROUP`, `FILE_TYPE_AD_GROUP_QA`, and `FILE_TYPE_AD`." ], "type": "string" } @@ -20529,7 +20529,8 @@ false "type": "array" }, "publisherReviewStatuses": { -"description": "Publisher review statuses for the creative. **Warning:** This field will be deprecated on June 26th, 2024. After this date, this field will be empty. Read our [feature deprecation announcement](/display-video/api/deprecations#features.creative_publisher_review_statuses) for more information.", +"deprecated": true, +"description": "Publisher review statuses for the creative.", "items": { "$ref": "PublisherReviewStatus" }, diff --git a/googleapiclient/discovery_cache/documents/docs.v1.json b/googleapiclient/discovery_cache/documents/docs.v1.json index a39d7a4abbd..54ee4b5dc4b 100644 --- a/googleapiclient/discovery_cache/documents/docs.v1.json +++ b/googleapiclient/discovery_cache/documents/docs.v1.json @@ -183,6 +183,11 @@ "required": true, "type": "string" }, +"includeTabsContent": { +"description": "Whether to populate the Document.tabs field instead of the text content fields like body and documentStyle on Document. - When `True`: Document content populates in the Document.tabs field instead of the text content fields in Document. - When `False`: The content of the document's first tab populates the content fields in Document excluding Document.tabs. If a document has only one tab, then that tab is used to populate the document content. Document.tabs will be empty.", +"location": "query", +"type": "boolean" +}, "suggestionsViewMode": { "description": "The suggestions view mode to apply to the document. This allows viewing the document with all suggestions inline, accepted or rejected. If one is not specified, DEFAULT_FOR_CURRENT_ACCESS is used.", "enum": [ @@ -216,7 +221,7 @@ } } }, -"revision": "20240626", +"revision": "20240722", "rootUrl": "https://docs.googleapis.com/", "schemas": { "AutoText": { @@ -341,6 +346,21 @@ }, "type": "object" }, +"BookmarkLink": { +"description": "A reference to a bookmark in this document.", +"id": "BookmarkLink", +"properties": { +"id": { +"description": "The ID of a bookmark in this document.", +"type": "string" +}, +"tabId": { +"description": "The ID of the tab containing this bookmark.", +"type": "string" +} +}, +"type": "object" +}, "Bullet": { "description": "Describes the bullet of a paragraph.", "id": "Bullet", @@ -671,6 +691,10 @@ "footerId": { "description": "The id of the footer to delete. If this footer is defined on DocumentStyle, the reference to this footer is removed, resulting in no footer of that type for the first section of the document. If this footer is defined on a SectionStyle, the reference to this footer is removed and the footer of that type is now continued from the previous section.", "type": "string" +}, +"tabId": { +"description": "The tab that contains the footer to delete. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document.", +"type": "string" } }, "type": "object" @@ -682,6 +706,10 @@ "headerId": { "description": "The id of the header to delete. If this header is defined on DocumentStyle, the reference to this header is removed, resulting in no header of that type for the first section of the document. If this header is defined on a SectionStyle, the reference to this header is removed and the header of that type is now continued from the previous section.", "type": "string" +}, +"tabId": { +"description": "The tab containing the header to delete. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document.", +"type": "string" } }, "type": "object" @@ -697,6 +725,10 @@ "namedRangeId": { "description": "The ID of the named range to delete.", "type": "string" +}, +"tabsCriteria": { +"$ref": "TabsCriteria", +"description": "Optional. The criteria used to specify which tab(s) the range deletion should occur in. When omitted, the range deletion is applied to all tabs. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the range deletion applies to the singular tab. In a document containing multiple tabs: - If provided, the range deletion applies to the specified tabs. - If not provided, the range deletion applies to all tabs." } }, "type": "object" @@ -719,6 +751,10 @@ "objectId": { "description": "The ID of the positioned object to delete.", "type": "string" +}, +"tabId": { +"description": "The tab that the positioned object to delete is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document.", +"type": "string" } }, "type": "object" @@ -872,6 +908,13 @@ ], "type": "string" }, +"tabs": { +"description": "Tabs that are part of a document. Tabs can contain child tabs, a tab nested within another tab. Child tabs are represented by the Tab.child_tabs field.", +"items": { +"$ref": "Tab" +}, +"type": "array" +}, "title": { "description": "The title of the document.", "type": "string" @@ -1046,6 +1089,88 @@ }, "type": "object" }, +"DocumentTab": { +"description": "A tab with document contents.", +"id": "DocumentTab", +"properties": { +"body": { +"$ref": "Body", +"description": "The main body of the document tab." +}, +"documentStyle": { +"$ref": "DocumentStyle", +"description": "The style of the document tab." +}, +"footers": { +"additionalProperties": { +"$ref": "Footer" +}, +"description": "The footers in the document tab, keyed by footer ID.", +"type": "object" +}, +"footnotes": { +"additionalProperties": { +"$ref": "Footnote" +}, +"description": "The footnotes in the document tab, keyed by footnote ID.", +"type": "object" +}, +"headers": { +"additionalProperties": { +"$ref": "Header" +}, +"description": "The headers in the document tab, keyed by header ID.", +"type": "object" +}, +"inlineObjects": { +"additionalProperties": { +"$ref": "InlineObject" +}, +"description": "The inline objects in the document tab, keyed by object ID.", +"type": "object" +}, +"lists": { +"additionalProperties": { +"$ref": "List" +}, +"description": "The lists in the document tab, keyed by list ID.", +"type": "object" +}, +"namedRanges": { +"additionalProperties": { +"$ref": "NamedRanges" +}, +"description": "The named ranges in the document tab, keyed by name.", +"type": "object" +}, +"namedStyles": { +"$ref": "NamedStyles", +"description": "The named styles of the document tab." +}, +"positionedObjects": { +"additionalProperties": { +"$ref": "PositionedObject" +}, +"description": "The positioned objects in the document tab, keyed by object ID.", +"type": "object" +}, +"suggestedDocumentStyleChanges": { +"additionalProperties": { +"$ref": "SuggestedDocumentStyle" +}, +"description": "The suggested changes to the style of the document tab, keyed by suggestion ID.", +"type": "object" +}, +"suggestedNamedStylesChanges": { +"additionalProperties": { +"$ref": "SuggestedNamedStyles" +}, +"description": "The suggested changes to the named styles of the document tab, keyed by suggestion ID.", +"type": "object" +} +}, +"type": "object" +}, "EmbeddedDrawingProperties": { "description": "The properties of an embedded drawing and used to differentiate the object type. An embedded drawing is one that's created and edited within a document. Note that extensive details are not supported.", "id": "EmbeddedDrawingProperties", @@ -1233,6 +1358,10 @@ "segmentId": { "description": "The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body.", "type": "string" +}, +"tabId": { +"description": "The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document.", +"type": "string" } }, "type": "object" @@ -1352,6 +1481,21 @@ }, "type": "object" }, +"HeadingLink": { +"description": "A reference to a heading in this document.", +"id": "HeadingLink", +"properties": { +"id": { +"description": "The ID of a heading in this document.", +"type": "string" +}, +"tabId": { +"description": "The ID of the tab containing this heading.", +"type": "string" +} +}, +"type": "object" +}, "HorizontalRule": { "description": "A ParagraphElement representing a horizontal line.", "id": "HorizontalRule", @@ -1716,14 +1860,26 @@ "description": "A reference to another portion of a document or an external URL resource.", "id": "Link", "properties": { +"bookmark": { +"$ref": "BookmarkLink", +"description": "A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned." +}, "bookmarkId": { "description": "The ID of a bookmark in this document.", "type": "string" }, +"heading": { +"$ref": "HeadingLink", +"description": "A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned." +}, "headingId": { "description": "The ID of a heading in this document.", "type": "string" }, +"tabId": { +"description": "The ID of a tab in this document.", +"type": "string" +}, "url": { "description": "An external URL.", "type": "string" @@ -1822,6 +1978,10 @@ "segmentId": { "description": "The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body.", "type": "string" +}, +"tabId": { +"description": "The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document.", +"type": "string" } }, "type": "object" @@ -2760,6 +2920,10 @@ "description": "The zero-based start index of this range, in UTF-16 code units. In all current uses, a start index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges.", "format": "int32", "type": "integer" +}, +"tabId": { +"description": "The tab that contains this range. When omitted, the request applies to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document.", +"type": "string" } }, "type": "object" @@ -2775,6 +2939,10 @@ "replaceText": { "description": "The text that will replace the matched text.", "type": "string" +}, +"tabsCriteria": { +"$ref": "TabsCriteria", +"description": "Optional. The criteria used to specify in which tabs the replacement occurs. When omitted, the replacement applies to all tabs. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the replacement applies to the singular tab. In a document containing multiple tabs: - If provided, the replacement applies to the specified tabs. - If omitted, the replacement applies to all tabs." } }, "type": "object" @@ -2811,6 +2979,10 @@ ], "type": "string" }, +"tabId": { +"description": "The tab that the image to be replaced is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document.", +"type": "string" +}, "uri": { "description": "The URI of the new image. The image is fetched once at insertion time and a copy is stored for display inside the document. Images must be less than 50MB, cannot exceed 25 megapixels, and must be in PNG, JPEG, or GIF format. The provided URI can't surpass 2 KB in length. The URI is saved with the image, and exposed through the ImageProperties.source_uri field.", "type": "string" @@ -2830,6 +3002,10 @@ "description": "The name of the NamedRanges whose content will be replaced. If there are multiple named ranges with the given name, then the content of each one will be replaced. If there are no named ranges with the given name, then the request will be a no-op.", "type": "string" }, +"tabsCriteria": { +"$ref": "TabsCriteria", +"description": "Optional. The criteria used to specify in which tabs the replacement occurs. When omitted, the replacement applies to all tabs. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the replacement applies to the singular tab. In a document containing multiple tabs: - If provided, the replacement applies to the specified tabs. - If omitted, the replacement applies to all tabs." +}, "text": { "description": "Replaces the content of the specified named range(s) with the given text.", "type": "string" @@ -3535,6 +3711,57 @@ }, "type": "object" }, +"Tab": { +"description": "A tab in a document.", +"id": "Tab", +"properties": { +"childTabs": { +"description": "The child tabs nested within this tab.", +"items": { +"$ref": "Tab" +}, +"type": "array" +}, +"documentTab": { +"$ref": "DocumentTab", +"description": "A tab with document contents, like text and images." +}, +"tabProperties": { +"$ref": "TabProperties", +"description": "The properties of the tab, like ID and title." +} +}, +"type": "object" +}, +"TabProperties": { +"description": "Properties of a tab.", +"id": "TabProperties", +"properties": { +"index": { +"description": "The index of the tab within the parent.", +"format": "int32", +"type": "integer" +}, +"nestingLevel": { +"description": "Output only. The depth of the tab within the document. Root-level tabs start at 0.", +"format": "int32", +"type": "integer" +}, +"parentTabId": { +"description": "Optional. The ID of the parent tab. Empty when the current tab is a root-level tab, which means it doesn't have any parents.", +"type": "string" +}, +"tabId": { +"description": "Output only. The ID of the tab. This field can't be changed.", +"type": "string" +}, +"title": { +"description": "The user-visible name of the tab.", +"type": "string" +} +}, +"type": "object" +}, "TabStop": { "description": "A tab stop within a paragraph.", "id": "TabStop", @@ -3998,6 +4225,20 @@ }, "type": "object" }, +"TabsCriteria": { +"description": "A criteria that specifies in which tabs a request executes.", +"id": "TabsCriteria", +"properties": { +"tabIds": { +"description": "The list of tab IDs in which the request executes.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "TextRun": { "description": "A ParagraphElement that represents a run of text that all has the same styling.", "id": "TextRun", @@ -4171,6 +4412,10 @@ "description": "The fields that should be updated. At least one field must be specified. The root `document_style` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field. For example to update the background, set `fields` to `\"background\"`.", "format": "google-fieldmask", "type": "string" +}, +"tabId": { +"description": "The tab that contains the style to update. When omitted, the request applies to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If not provided, the request applies to the first tab in the document.", +"type": "string" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/documentai.v1.json b/googleapiclient/discovery_cache/documents/documentai.v1.json index d5db73c2377..7707a17ba6d 100644 --- a/googleapiclient/discovery_cache/documents/documentai.v1.json +++ b/googleapiclient/discovery_cache/documents/documentai.v1.json @@ -1042,7 +1042,7 @@ } } }, -"revision": "20240703", +"revision": "20240716", "rootUrl": "https://documentai.googleapis.com/", "schemas": { "GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadata": { @@ -4686,6 +4686,11 @@ true "$ref": "GoogleCloudDocumentaiV1DocumentSchema", "description": "The schema of the processor version. Describes the output." }, +"genAiModelInfo": { +"$ref": "GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfo", +"description": "Output only. Information about Generative AI model-based processor versions.", +"readOnly": true +}, "googleManaged": { "description": "Output only. Denotes that this `ProcessorVersion` is managed by Google.", "readOnly": true, @@ -4793,6 +4798,62 @@ true }, "type": "object" }, +"GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfo": { +"description": "Information about Generative AI model-based processor versions.", +"id": "GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfo", +"properties": { +"customGenAiModelInfo": { +"$ref": "GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoCustomGenAiModelInfo", +"description": "Information for a custom Generative AI model created by the user." +}, +"foundationGenAiModelInfo": { +"$ref": "GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo", +"description": "Information for a pretrained Google-managed foundation model." +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoCustomGenAiModelInfo": { +"description": "Information for a custom Generative AI model created by the user. These are created with `Create New Version` in either the `Call foundation model` or `Fine tuning` tabs.", +"id": "GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoCustomGenAiModelInfo", +"properties": { +"baseProcessorVersionId": { +"description": "The base processor version ID for the custom model.", +"type": "string" +}, +"customModelType": { +"description": "The type of custom model created by the user.", +"enum": [ +"CUSTOM_MODEL_TYPE_UNSPECIFIED", +"VERSIONED_FOUNDATION", +"FINE_TUNED" +], +"enumDescriptions": [ +"The model type is unspecified.", +"The model is a versioned foundation model.", +"The model is a finetuned foundation model." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo": { +"description": "Information for a pretrained Google-managed foundation model.", +"id": "GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo", +"properties": { +"finetuningAllowed": { +"description": "Whether finetuning is allowed for this base processor version.", +"type": "boolean" +}, +"minTrainLabeledDocuments": { +"description": "The minimum number of labeled documents in the training dataset required for finetuning.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, "GoogleCloudDocumentaiV1RawDocument": { "description": "Payload message of raw document content (bytes).", "id": "GoogleCloudDocumentaiV1RawDocument", diff --git a/googleapiclient/discovery_cache/documents/documentai.v1beta3.json b/googleapiclient/discovery_cache/documents/documentai.v1beta3.json index 9a61f6c8847..ea38690adb3 100644 --- a/googleapiclient/discovery_cache/documents/documentai.v1beta3.json +++ b/googleapiclient/discovery_cache/documents/documentai.v1beta3.json @@ -1284,7 +1284,7 @@ } } }, -"revision": "20240703", +"revision": "20240716", "rootUrl": "https://documentai.googleapis.com/", "schemas": { "GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadata": { @@ -9293,6 +9293,11 @@ true "$ref": "GoogleCloudDocumentaiV1beta3DocumentSchema", "description": "The schema of the processor version. Describes the output." }, +"genAiModelInfo": { +"$ref": "GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfo", +"description": "Output only. Information about Generative AI model-based processor versions.", +"readOnly": true +}, "googleManaged": { "description": "Output only. Denotes that this `ProcessorVersion` is managed by Google.", "readOnly": true, @@ -9400,6 +9405,62 @@ true }, "type": "object" }, +"GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfo": { +"description": "Information about Generative AI model-based processor versions.", +"id": "GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfo", +"properties": { +"customGenAiModelInfo": { +"$ref": "GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo", +"description": "Information for a custom Generative AI model created by the user." +}, +"foundationGenAiModelInfo": { +"$ref": "GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo", +"description": "Information for a pretrained Google-managed foundation model." +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo": { +"description": "Information for a custom Generative AI model created by the user. These are created with `Create New Version` in either the `Call foundation model` or `Fine tuning` tabs.", +"id": "GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo", +"properties": { +"baseProcessorVersionId": { +"description": "The base processor version ID for the custom model.", +"type": "string" +}, +"customModelType": { +"description": "The type of custom model created by the user.", +"enum": [ +"CUSTOM_MODEL_TYPE_UNSPECIFIED", +"VERSIONED_FOUNDATION", +"FINE_TUNED" +], +"enumDescriptions": [ +"The model type is unspecified.", +"The model is a versioned foundation model.", +"The model is a finetuned foundation model." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo": { +"description": "Information for a pretrained Google-managed foundation model.", +"id": "GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo", +"properties": { +"finetuningAllowed": { +"description": "Whether finetuning is allowed for this base processor version.", +"type": "boolean" +}, +"minTrainLabeledDocuments": { +"description": "The minimum number of labeled documents in the training dataset required for finetuning.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, "GoogleCloudDocumentaiV1beta3PropertyMetadata": { "description": "Metadata about a property.", "id": "GoogleCloudDocumentaiV1beta3PropertyMetadata", diff --git a/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json b/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json index 8d5a96ad9c0..66106394321 100644 --- a/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json @@ -585,7 +585,7 @@ } } }, -"revision": "20240710", +"revision": "20240717", "rootUrl": "https://firebaseappdistribution.googleapis.com/", "schemas": { "GoogleFirebaseAppdistroV1Release": { @@ -875,14 +875,16 @@ "CRASHED", "NOT_INSTALLED", "UNABLE_TO_CRAWL", -"DEVICE_OUT_OF_MEMORY" +"DEVICE_OUT_OF_MEMORY", +"FAILED_AI_STEP" ], "enumDescriptions": [ "Reason unspecified.", "The app crashed during the test.", "If an app is not installed and thus no test can be run with the app. This might be caused by trying to run a test on an unsupported platform.", "If the app could not be crawled (possibly because the app did not start).", -"If the device ran out of memory during the test." +"If the device ran out of memory during the test.", +"At least one AI step failed." ], "readOnly": true, "type": "string" diff --git a/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json b/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json index ac3e4905bd6..d5ed50c9f1d 100644 --- a/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json +++ b/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json @@ -206,7 +206,7 @@ } } }, -"revision": "20240705", +"revision": "20240722", "rootUrl": "https://firebaseml.googleapis.com/", "schemas": { "Date": { @@ -282,14 +282,14 @@ ], "enumDescriptions": [ "The finish reason is unspecified.", -"Natural stop point of the model or provided stop sequence.", -"The maximum number of tokens as specified in the request was reached.", -"The token generation was stopped as the response was flagged for safety reasons. NOTE: When streaming the Candidate.content will be empty if content filters blocked the output.", -"The token generation was stopped as the response was flagged for unauthorized citations.", -"All other reasons that stopped the token generation", -"The token generation was stopped as the response was flagged for the terms which are included from the terminology blocklist.", -"The token generation was stopped as the response was flagged for the prohibited contents.", -"The token generation was stopped as the response was flagged for Sensitive Personally Identifiable Information (SPII) contents.", +"Token generation reached a natural stopping point or a configured stop sequence.", +"Token generation reached the configured maximum output tokens.", +"Token generation stopped because the content potentially contains safety violations. NOTE: When streaming, Candidate.content is empty if content filters blocks the output.", +"Token generation stopped because the content potentially contains copyright violations.", +"All other reasons that stopped the token generation.", +"Token generation stopped because the content contains forbidden terms.", +"Token generation stopped for potentially containing prohibited content.", +"Token generation stopped because the content potentially contains Sensitive Personally Identifiable Information (SPII).", "The function call generated by the model is invalid." ], "readOnly": true, @@ -313,12 +313,6 @@ }, "readOnly": true, "type": "array" -}, -"score": { -"description": "Output only. Confidence score of the candidate.", -"format": "double", -"readOnly": true, -"type": "number" } }, "type": "object" @@ -892,7 +886,8 @@ "id": "GoogleCloudAiplatformV1beta1Retrieval", "properties": { "disableAttribution": { -"description": "Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation.", +"deprecated": true, +"description": "Optional. Deprecated. This option is no longer supported.", "type": "boolean" }, "vertexAiSearch": { diff --git a/googleapiclient/discovery_cache/documents/firestore.v1.json b/googleapiclient/discovery_cache/documents/firestore.v1.json index 26f47eed32b..5c309e82d56 100644 --- a/googleapiclient/discovery_cache/documents/firestore.v1.json +++ b/googleapiclient/discovery_cache/documents/firestore.v1.json @@ -1706,7 +1706,7 @@ } } }, -"revision": "20240630", +"revision": "20240713", "rootUrl": "https://firestore.googleapis.com/", "schemas": { "Aggregation": { @@ -2388,7 +2388,7 @@ "type": "object" }, "FindNearest": { -"description": "Nearest Neighbors search config.", +"description": "Nearest Neighbors search config. The ordering provided by FindNearest supersedes the order_by stage. If multiple documents have the same vector distance, the returned document order is not guaranteed to be stable between queries.", "id": "FindNearest", "properties": { "distanceMeasure": { @@ -2499,7 +2499,7 @@ "type": "string" }, "retention": { -"description": "At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. The maximum supported retention is 14 weeks.", +"description": "At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. The maximum supported retention period is 14 weeks.", "format": "google-duration", "type": "string" }, @@ -2633,12 +2633,7 @@ "GoogleFirestoreAdminV1DailyRecurrence": { "description": "Represents a recurring schedule that runs every day. The time zone is UTC.", "id": "GoogleFirestoreAdminV1DailyRecurrence", -"properties": { -"time": { -"$ref": "TimeOfDay", -"description": "Time of the day. The first run scheduled will be either on the same day if schedule creation time precedes time_of_day or the next day otherwise." -} -}, +"properties": {}, "type": "object" }, "GoogleFirestoreAdminV1Database": { @@ -3602,10 +3597,6 @@ "Sunday" ], "type": "string" -}, -"time": { -"$ref": "TimeOfDay", -"description": "Time of the day. If day is today, the first run will happen today if schedule creation time precedes time_of_day, and the next week otherwise." } }, "type": "object" @@ -4341,33 +4332,6 @@ }, "type": "object" }, -"TimeOfDay": { -"description": "Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.", -"id": "TimeOfDay", -"properties": { -"hours": { -"description": "Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.", -"format": "int32", -"type": "integer" -}, -"minutes": { -"description": "Minutes of hour of day. Must be from 0 to 59.", -"format": "int32", -"type": "integer" -}, -"nanos": { -"description": "Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.", -"format": "int32", -"type": "integer" -}, -"seconds": { -"description": "Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.", -"format": "int32", -"type": "integer" -} -}, -"type": "object" -}, "TransactionOptions": { "description": "Options for creating a new transaction.", "id": "TransactionOptions", diff --git a/googleapiclient/discovery_cache/documents/firestore.v1beta1.json b/googleapiclient/discovery_cache/documents/firestore.v1beta1.json index 2d521e4c573..9f90e1198eb 100644 --- a/googleapiclient/discovery_cache/documents/firestore.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/firestore.v1beta1.json @@ -950,7 +950,7 @@ } } }, -"revision": "20240626", +"revision": "20240713", "rootUrl": "https://firestore.googleapis.com/", "schemas": { "Aggregation": { @@ -1632,7 +1632,7 @@ "type": "object" }, "FindNearest": { -"description": "Nearest Neighbors search config.", +"description": "Nearest Neighbors search config. The ordering provided by FindNearest supersedes the order_by stage. If multiple documents have the same vector distance, the returned document order is not guaranteed to be stable between queries.", "id": "FindNearest", "properties": { "distanceMeasure": { diff --git a/googleapiclient/discovery_cache/documents/healthcare.v1.json b/googleapiclient/discovery_cache/documents/healthcare.v1.json index a1c5ff380b8..0053a520c56 100644 --- a/googleapiclient/discovery_cache/documents/healthcare.v1.json +++ b/googleapiclient/discovery_cache/documents/healthcare.v1.json @@ -4554,7 +4554,7 @@ } } }, -"revision": "20240619", +"revision": "20240718", "rootUrl": "https://healthcare.googleapis.com/", "schemas": { "ActivateConsentRequest": { @@ -5151,7 +5151,7 @@ "description": "Configures de-identification of text wherever it is found in the source_dataset." }, "useRegionalDataProcessing": { -"description": "Ensures in-flight data remains in the region of origin during de-identification. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required.", +"description": "Ensures in-flight data remains in the region of origin during de-identification. The default value is false. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required.", "type": "boolean" } }, @@ -5678,11 +5678,11 @@ "type": "string" }, "sendFullResource": { -"description": "Whether to send full FHIR resource to this Pub/Sub topic.", +"description": "Whether to send full FHIR resource to this Pub/Sub topic. The default value is false.", "type": "boolean" }, "sendPreviousResourceOnDelete": { -"description": "Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the \"payloadType\" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation.", +"description": "Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. The default value is false. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the \"payloadType\" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation.", "type": "boolean" } }, @@ -5707,7 +5707,7 @@ "type": "string" }, "defaultSearchHandlingStrict": { -"description": "If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`.", +"description": "If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. Defaults to false.", "type": "boolean" }, "disableReferentialIntegrity": { @@ -5715,11 +5715,11 @@ "type": "boolean" }, "disableResourceVersioning": { -"description": "Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, which is the default behavior, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions.", +"description": "Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. Defaults to false.", "type": "boolean" }, "enableUpdateCreate": { -"description": "Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources.", +"description": "Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. Defaults to false.", "type": "boolean" }, "labels": { @@ -6045,7 +6045,7 @@ "type": "string" }, "force": { -"description": "If this flag is `TRUE`, all tables are deleted from the dataset before the new exported tables are written. If the flag is not set and the destination dataset contains tables, the export call returns an error. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE.", +"description": "The default value is false. If this flag is `TRUE`, all tables are deleted from the dataset before the new exported tables are written. If the flag is not set and the destination dataset contains tables, the export call returns an error. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE.", "type": "boolean" }, "schemaConfig": { @@ -6743,7 +6743,8 @@ "type": "object" }, "messageType": { -"description": "The message type for this message. MSH-9.1.", +"description": "Output only. The message type for this message. MSH-9.1.", +"readOnly": true, "type": "string" }, "name": { @@ -6757,23 +6758,27 @@ "readOnly": true }, "patientIds": { -"description": "All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message.", +"description": "Output only. All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message.", "items": { "$ref": "PatientId" }, +"readOnly": true, "type": "array" }, "schematizedData": { "$ref": "SchematizedData", -"description": "The parsed version of the raw message data schematized according to this store's schemas and type definitions." +"description": "Output only. The parsed version of the raw message data schematized according to this store's schemas and type definitions.", +"readOnly": true }, "sendFacility": { -"description": "The hospital that this message came from. MSH-4.", +"description": "Output only. The hospital that this message came from. MSH-4.", +"readOnly": true, "type": "string" }, "sendTime": { -"description": "The datetime the sending application sent this message. MSH-7.", +"description": "Output only. The datetime the sending application sent this message. MSH-7.", "format": "google-datetime", +"readOnly": true, "type": "string" } }, @@ -7709,19 +7714,19 @@ "id": "ValidationConfig", "properties": { "disableFhirpathValidation": { -"description": "Whether to disable FHIRPath validation for incoming resources. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced.", +"description": "Whether to disable FHIRPath validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced.", "type": "boolean" }, "disableProfileValidation": { -"description": "Whether to disable profile validation for this FHIR store. Set this to true to disable checking incoming resources for conformance against structure definitions in this FHIR store.", +"description": "Whether to disable profile validation for this FHIR store. The default value is false. Set this to true to disable checking incoming resources for conformance against structure definitions in this FHIR store.", "type": "boolean" }, "disableReferenceTypeValidation": { -"description": "Whether to disable reference type validation for incoming resources. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced.", +"description": "Whether to disable reference type validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced.", "type": "boolean" }, "disableRequiredFieldValidation": { -"description": "Whether to disable required fields validation for incoming resources. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced.", +"description": "Whether to disable required fields validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced.", "type": "boolean" }, "enabledImplementationGuides": { diff --git a/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json b/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json index 4b0c58614df..51267cfff03 100644 --- a/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json @@ -5672,7 +5672,7 @@ } } }, -"revision": "20240619", +"revision": "20240718", "rootUrl": "https://healthcare.googleapis.com/", "schemas": { "AccessDeterminationLogConfig": { @@ -5929,6 +5929,25 @@ }, "type": "object" }, +"ApplyAdminConsentsErrorDetail": { +"description": "Contains the error details of the unsupported admin Consent resources for when the ApplyAdminConsents method fails to apply one or more Consent resources.", +"id": "ApplyAdminConsentsErrorDetail", +"properties": { +"consentErrors": { +"description": "The list of Consent resources that are unsupported or cannot be applied and the error associated with each of them.", +"items": { +"$ref": "ConsentErrors" +}, +"type": "array" +}, +"existingOperationId": { +"description": "The currently in progress non-validate-only ApplyAdminConsents operation ID if exist.", +"format": "uint64", +"type": "string" +} +}, +"type": "object" +}, "ApplyAdminConsentsRequest": { "description": "Request to apply the admin Consent resources for the specified FHIR store.", "id": "ApplyAdminConsentsRequest", @@ -6522,7 +6541,7 @@ "description": "Optional. Specifies how the server logs the consent-aware requests. If not specified, the `AccessDeterminationLogConfig.LogLevel.MINIMUM` option is used." }, "accessEnforced": { -"description": "Optional. If set to true, when accessing FHIR resources, the consent headers will be verified against consents given by patients. See the ConsentEnforcementVersion for the supported consent headers.", +"description": "Optional. The default value is false. If set to true, when accessing FHIR resources, the consent headers will be verified against consents given by patients. See the ConsentEnforcementVersion for the supported consent headers.", "type": "boolean" }, "consentHeaderHandling": { @@ -6551,6 +6570,21 @@ }, "type": "object" }, +"ConsentErrors": { +"description": "The Consent resource name and error.", +"id": "ConsentErrors", +"properties": { +"error": { +"$ref": "Status", +"description": "The error code and message." +}, +"name": { +"description": "The versioned name of the admin Consent resource, in the format `projects/{project_id}/locations/{location}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Consent/{resource_id}/_history/{version_id}`. For FHIR stores with `disable_resource_versioning=true`, the format is `projects/{project_id}/locations/{location}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Consent/{resource_id}`.", +"type": "string" +} +}, +"type": "object" +}, "ConsentEvaluation": { "description": "The detailed evaluation of a particular Consent.", "id": "ConsentEvaluation", @@ -6773,7 +6807,7 @@ "description": "Configures de-identification of text wherever it is found in the source_dataset." }, "useRegionalDataProcessing": { -"description": "Ensures in-flight data remains in the region of origin during de-identification. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. If the deprecated DicomConfig or FhirConfig are used, then `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required.", +"description": "Ensures in-flight data remains in the region of origin during de-identification. The default value is false. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. If the deprecated DicomConfig or FhirConfig are used, then `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required.", "type": "boolean" } }, @@ -7610,11 +7644,11 @@ "type": "string" }, "sendFullResource": { -"description": "Whether to send full FHIR resource to this Pub/Sub topic for Create and Update operation. Note that setting this to true does not guarantee that all resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the \"payloadType\" label from a Pub/Sub message to determine whether it needs to fetch the full resource as a separate operation.", +"description": "Whether to send full FHIR resource to this Pub/Sub topic for Create and Update operation. The default value is false. Note that setting this to true does not guarantee that all resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the \"payloadType\" label from a Pub/Sub message to determine whether it needs to fetch the full resource as a separate operation.", "type": "boolean" }, "sendPreviousResourceOnDelete": { -"description": "Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the \"payloadType\" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation.", +"description": "Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. The default value is false. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the \"payloadType\" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation.", "type": "boolean" } }, @@ -7654,7 +7688,7 @@ "description": "Optional. Specifies whether this store has consent enforcement. Not available for DSTU2 FHIR version due to absence of Consent resources." }, "defaultSearchHandlingStrict": { -"description": "If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`.", +"description": "If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. Defaults to false.", "type": "boolean" }, "disableReferentialIntegrity": { @@ -7662,15 +7696,15 @@ "type": "boolean" }, "disableResourceVersioning": { -"description": "Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, which is the default behavior, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions.", +"description": "Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. Defaults to false.", "type": "boolean" }, "enableHistoryModifications": { -"description": "Optional. Whether to allow ExecuteBundle to accept history bundles, and directly insert and overwrite historical resource versions into the FHIR store. If set to false, using history bundles fails with an error.", +"description": "Optional. Whether to allow ExecuteBundle to accept history bundles, and directly insert and overwrite historical resource versions into the FHIR store. If set to false, using history bundles fails with an error. Defaults to false.", "type": "boolean" }, "enableUpdateCreate": { -"description": "Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources.", +"description": "Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. Defaults to false.", "type": "boolean" }, "labels": { @@ -10227,19 +10261,19 @@ "id": "ValidationConfig", "properties": { "disableFhirpathValidation": { -"description": "Whether to disable FHIRPath validation for incoming resources. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced.", +"description": "Whether to disable FHIRPath validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced.", "type": "boolean" }, "disableProfileValidation": { -"description": "Whether to disable profile validation for this FHIR store. Set this to true to disable checking incoming resources for conformance against StructureDefinitions in this FHIR store.", +"description": "Whether to disable profile validation for this FHIR store. The default value is false. Set this to true to disable checking incoming resources for conformance against StructureDefinitions in this FHIR store.", "type": "boolean" }, "disableReferenceTypeValidation": { -"description": "Whether to disable reference type validation for incoming resources. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced.", +"description": "Whether to disable reference type validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced.", "type": "boolean" }, "disableRequiredFieldValidation": { -"description": "Whether to disable required fields validation for incoming resources. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced.", +"description": "Whether to disable required fields validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced.", "type": "boolean" }, "enabledImplementationGuides": { diff --git a/googleapiclient/discovery_cache/documents/iam.v1.json b/googleapiclient/discovery_cache/documents/iam.v1.json index f2224a0a9c9..dc598fd5905 100644 --- a/googleapiclient/discovery_cache/documents/iam.v1.json +++ b/googleapiclient/discovery_cache/documents/iam.v1.json @@ -988,7 +988,7 @@ ] }, "delete": { -"description": "Deletes a custom Role. When you delete a custom role, the following changes occur immediately: * You cannot bind a principal to the custom role in an IAM Policy. * Existing bindings to the custom role are not changed, but they have no effect. * By default, the response from ListRoles does not include the custom role. You have 7 days to undelete the custom role. After 7 days, the following changes occur: * The custom role is permanently deleted and cannot be recovered. * If an IAM policy contains a binding to the custom role, the binding is permanently removed.", +"description": "Deletes a custom Role. When you delete a custom role, the following changes occur immediately: * You cannot bind a principal to the custom role in an IAM Policy. * Existing bindings to the custom role are not changed, but they have no effect. * By default, the response from ListRoles does not include the custom role. A deleted custom role still counts toward the [custom role limit](/iam/quotas#limits) until it is permanently deleted. You have 7 days to undelete the custom role. After 7 days, the following changes occur: * The custom role is permanently deleted and cannot be recovered. * If an IAM policy contains a binding to the custom role, the binding is permanently removed. * The custom role no longer counts toward your custom role limit.", "flatPath": "v1/organizations/{organizationsId}/roles/{rolesId}", "httpMethod": "DELETE", "id": "iam.organizations.roles.delete", @@ -2288,7 +2288,7 @@ ] }, "delete": { -"description": "Deletes a custom Role. When you delete a custom role, the following changes occur immediately: * You cannot bind a principal to the custom role in an IAM Policy. * Existing bindings to the custom role are not changed, but they have no effect. * By default, the response from ListRoles does not include the custom role. You have 7 days to undelete the custom role. After 7 days, the following changes occur: * The custom role is permanently deleted and cannot be recovered. * If an IAM policy contains a binding to the custom role, the binding is permanently removed.", +"description": "Deletes a custom Role. When you delete a custom role, the following changes occur immediately: * You cannot bind a principal to the custom role in an IAM Policy. * Existing bindings to the custom role are not changed, but they have no effect. * By default, the response from ListRoles does not include the custom role. A deleted custom role still counts toward the [custom role limit](/iam/quotas#limits) until it is permanently deleted. You have 7 days to undelete the custom role. After 7 days, the following changes occur: * The custom role is permanently deleted and cannot be recovered. * If an IAM policy contains a binding to the custom role, the binding is permanently removed. * The custom role no longer counts toward your custom role limit.", "flatPath": "v1/projects/{projectsId}/roles/{rolesId}", "httpMethod": "DELETE", "id": "iam.projects.roles.delete", @@ -3056,34 +3056,6 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, -"patch": { -"description": "Patches a ServiceAccountKey.", -"flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}/keys/{keysId}:patch", -"httpMethod": "POST", -"id": "iam.projects.serviceAccounts.keys.patch", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "The resource name of the service account key in the following format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}`.", -"location": "path", -"pattern": "^projects/[^/]+/serviceAccounts/[^/]+/keys/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+name}:patch", -"request": { -"$ref": "PatchServiceAccountKeyRequest" -}, -"response": { -"$ref": "ServiceAccountKey" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, "upload": { "description": "Uploads the public key portion of a key pair that you manage, and associates the public key with a ServiceAccount. After you upload the public key, you can use the private key from the key pair as a service account key.", "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}/keys:upload", @@ -3216,7 +3188,7 @@ } } }, -"revision": "20240703", +"revision": "20240722", "rootUrl": "https://iam.googleapis.com/", "schemas": { "AccessRestrictions": { @@ -4271,22 +4243,6 @@ }, "type": "object" }, -"PatchServiceAccountKeyRequest": { -"description": "The service account key patch request.", -"id": "PatchServiceAccountKeyRequest", -"properties": { -"serviceAccountKey": { -"$ref": "ServiceAccountKey", -"description": "Required. The service account key to update." -}, -"updateMask": { -"description": "Required. The update mask to apply to the service account key. Only the following fields are eligible for patching: - contact - description", -"format": "google-fieldmask", -"type": "string" -} -}, -"type": "object" -}, "PatchServiceAccountRequest": { "description": "The service account patch request. You can patch only the `display_name` and `description` fields. You must use the `update_mask` field to specify which of these fields you want to patch. Only the fields specified in the request are guaranteed to be returned in the response. Other fields may be empty in the response.", "id": "PatchServiceAccountRequest", @@ -4691,19 +4647,6 @@ false "description": "Represents a service account key. A service account has two sets of key-pairs: user-managed, and system-managed. User-managed key-pairs can be created and deleted by users. Users are responsible for rotating these keys periodically to ensure security of their service accounts. Users retain the private key of these key-pairs, and Google retains ONLY the public key. System-managed keys are automatically rotated by Google, and are used for signing for a maximum of two weeks. The rotation process is probabilistic, and usage of the new key will gradually ramp up and down over the key's lifetime. If you cache the public key set for a service account, we recommend that you update the cache every 15 minutes. User-managed keys can be added and removed at any time, so it is important to update the cache frequently. For Google-managed keys, Google will publish a key at least 6 hours before it is first used for signing and will keep publishing it for at least 6 hours after it was last used for signing. Public keys for all service accounts are also published at the OAuth2 Service Account API.", "id": "ServiceAccountKey", "properties": { -"contact": { -"description": "Optional. A user provided email address as the point of contact for this service account key. Must be an email address. Limit 64 characters.", -"type": "string" -}, -"creator": { -"description": "Output only. The cloud identity that created this service account key. Populated automatically when the key is created and not editable by the user.", -"readOnly": true, -"type": "string" -}, -"description": { -"description": "Optional. A user provided description of this service account key.", -"type": "string" -}, "disableReason": { "description": "Output only. optional. If the key is disabled, it may have a DisableReason describing why it was disabled.", "enum": [ diff --git a/googleapiclient/discovery_cache/documents/language.v2.json b/googleapiclient/discovery_cache/documents/language.v2.json index 953f6354d5c..a4cec0fd65b 100644 --- a/googleapiclient/discovery_cache/documents/language.v2.json +++ b/googleapiclient/discovery_cache/documents/language.v2.json @@ -208,7 +208,7 @@ } } }, -"revision": "20240623", +"revision": "20240713", "rootUrl": "https://language.googleapis.com/", "schemas": { "AnalyzeEntitiesRequest": { @@ -577,6 +577,7 @@ "A2_ULTRAGPU_4G", "A2_ULTRAGPU_8G", "A3_HIGHGPU_8G", +"A3_MEGAGPU_8G", "E2_STANDARD_2", "E2_STANDARD_4", "E2_STANDARD_8", @@ -862,6 +863,7 @@ "", "", "", +"", "" ], "type": "string" @@ -1108,6 +1110,7 @@ "A2_ULTRAGPU_4G", "A2_ULTRAGPU_8G", "A3_HIGHGPU_8G", +"A3_MEGAGPU_8G", "E2_STANDARD_2", "E2_STANDARD_4", "E2_STANDARD_8", @@ -1393,6 +1396,7 @@ "", "", "", +"", "" ], "type": "string" @@ -1525,6 +1529,7 @@ "A2_ULTRAGPU_4G", "A2_ULTRAGPU_8G", "A3_HIGHGPU_8G", +"A3_MEGAGPU_8G", "E2_STANDARD_2", "E2_STANDARD_4", "E2_STANDARD_8", @@ -1810,6 +1815,7 @@ "", "", "", +"", "" ], "type": "string" @@ -2968,6 +2974,7 @@ false "NVIDIA_A100_80GB", "NVIDIA_L4", "NVIDIA_H100_80GB", +"NVIDIA_H100_MEGA_80GB", "TPU_V2", "TPU_V3", "TPU_V4_POD", @@ -2984,6 +2991,7 @@ false "Nvidia A100 80GB GPU.", "Nvidia L4 GPU.", "Nvidia H100 80Gb GPU.", +"Nvidia H100 80Gb GPU.", "TPU v2 (JellyFish).", "TPU v3 (DragonFish).", "TPU_v4 (PufferFish).", diff --git a/googleapiclient/discovery_cache/documents/manufacturers.v1.json b/googleapiclient/discovery_cache/documents/manufacturers.v1.json index dd5330df4a4..62689be83cf 100644 --- a/googleapiclient/discovery_cache/documents/manufacturers.v1.json +++ b/googleapiclient/discovery_cache/documents/manufacturers.v1.json @@ -416,7 +416,7 @@ } } }, -"revision": "20240524", +"revision": "20240716", "rootUrl": "https://manufacturers.googleapis.com/", "schemas": { "Attributes": { @@ -892,6 +892,14 @@ "description": "Product issue.", "id": "Issue", "properties": { +"applicableCountries": { +"description": "Output only. List of country codes (ISO 3166-1 alpha-2) where issue applies to the manufacturer product.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, "attribute": { "description": "If present, the attribute that triggered the issue. For more information about attributes, see https://support.google.com/manufacturers/answer/6124116.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/meet.v2.json b/googleapiclient/discovery_cache/documents/meet.v2.json index 26c8d3453b4..aec2c6df6dd 100644 --- a/googleapiclient/discovery_cache/documents/meet.v2.json +++ b/googleapiclient/discovery_cache/documents/meet.v2.json @@ -543,7 +543,7 @@ ] }, "endActiveConference": { -"description": "Ends an active conference (if there's one).", +"description": "Ends an active conference (if there's one). For an example, see [End active conference](https://developers.google.com/meet/api/guides/meeting-spaces#end-active-conference).", "flatPath": "v2/spaces/{spacesId}:endActiveConference", "httpMethod": "POST", "id": "meet.spaces.endActiveConference", @@ -552,7 +552,7 @@ ], "parameters": { "name": { -"description": "Required. Resource name of the space.", +"description": "Required. Resource name of the space. Format: `spaces/{space}`. `{space}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. For more information, see [How Meet identifies a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space).", "location": "path", "pattern": "^spaces/[^/]+$", "required": true, @@ -571,7 +571,7 @@ ] }, "get": { -"description": "Gets a space by `space_id` or `meeting_code`.", +"description": "Gets details about a meeting space. For an example, see [Get a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#get-meeting-space).", "flatPath": "v2/spaces/{spacesId}", "httpMethod": "GET", "id": "meet.spaces.get", @@ -580,7 +580,7 @@ ], "parameters": { "name": { -"description": "Required. Resource name of the space.", +"description": "Required. Resource name of the space. Format: `spaces/{space}` or `spaces/{meetingCode}`. `{space}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. `{meetingCode}` is an alias for the space. It's a typeable, unique character string and is non-case sensitive. For example, `abc-mnop-xyz`. The maximum length is 128 characters. A `meetingCode` shouldn't be stored long term as it can become dissociated from a meeting space and can be reused for different meeting spaces in the future. Generally, a `meetingCode` expires 365 days after last use. For more information, see [Learn about meeting codes in Google Meet](https://support.google.com/meet/answer/10710509). For more information, see [How Meet identifies a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space).", "location": "path", "pattern": "^spaces/[^/]+$", "required": true, @@ -597,7 +597,7 @@ ] }, "patch": { -"description": "Updates a space.", +"description": "Updates details about a meeting space. For an example, see [Update a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#update-meeting-space).", "flatPath": "v2/spaces/{spacesId}", "httpMethod": "PATCH", "id": "meet.spaces.patch", @@ -606,7 +606,7 @@ ], "parameters": { "name": { -"description": "Immutable. Resource name of the space. Format: `spaces/{space}`", +"description": "Immutable. Resource name of the space. Format: `spaces/{space}`. `{space}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. For more information, see [How Meet identifies a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space).", "location": "path", "pattern": "^spaces/[^/]+$", "required": true, @@ -633,7 +633,7 @@ } } }, -"revision": "20240707", +"revision": "20240716", "rootUrl": "https://meet.googleapis.com/", "schemas": { "ActiveConference": { @@ -1000,17 +1000,17 @@ "description": "Configuration pertaining to the meeting space." }, "meetingCode": { -"description": "Output only. Type friendly code to join the meeting. Format: `[a-z]+-[a-z]+-[a-z]+` such as `abc-mnop-xyz`. The maximum length is 128 characters. Can only be used as an alias of the space ID to get the space.", +"description": "Output only. Type friendly unique string used to join the meeting. Format: `[a-z]+-[a-z]+-[a-z]+`. For example, `abc-mnop-xyz`. The maximum length is 128 characters. Can only be used as an alias of the space name to get the space.", "readOnly": true, "type": "string" }, "meetingUri": { -"description": "Output only. URI used to join meetings, such as `https://meet.google.com/abc-mnop-xyz`.", +"description": "Output only. URI used to join meetings consisting of `https://meet.google.com/` followed by the `meeting_code`. For example, `https://meet.google.com/abc-mnop-xyz`.", "readOnly": true, "type": "string" }, "name": { -"description": "Immutable. Resource name of the space. Format: `spaces/{space}`", +"description": "Immutable. Resource name of the space. Format: `spaces/{space}`. `{space}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. For more information, see [How Meet identifies a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space).", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json index 6b2052102d3..2b442215d42 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json @@ -1153,7 +1153,7 @@ ], "parameters": { "name": { -"description": "Required. The resource name of the terms of service version. Format: `accounts/{account}/termsOfServiceAgreementState/{identifier}`", +"description": "Required. The resource name of the terms of service version. Format: `accounts/{account}/termsOfServiceAgreementState/{identifier}` The identifier format is: `{TermsOfServiceKind}-{country}`", "location": "path", "pattern": "^accounts/[^/]+/termsOfServiceAgreementStates/[^/]+$", "required": true, @@ -1453,7 +1453,7 @@ } } }, -"revision": "20240709", +"revision": "20240719", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "AcceptTermsOfService": { @@ -3358,7 +3358,7 @@ false "description": "The accepted terms of service of this kind and for the associated region_code" }, "name": { -"description": "Identifier. The resource name of the terms of service version. Format: `accounts/{account}/termsOfServiceAgreementState/{identifier}`", +"description": "Identifier. The resource name of the terms of service version. Format: `accounts/{account}/termsOfServiceAgreementState/{identifier}` The identifier format is: `{TermsOfServiceKind}-{country}` For example, an identifier could be: `MERCHANT_CENTER-US`", "type": "string" }, "regionCode": { diff --git a/googleapiclient/discovery_cache/documents/merchantapi.datasources_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.datasources_v1beta.json index 27cad1e815b..47f1350d3ff 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.datasources_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.datasources_v1beta.json @@ -290,7 +290,7 @@ } } }, -"revision": "20240614", +"revision": "20240719", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "DataSource": { @@ -526,7 +526,7 @@ "Not specified.", "Online product.", "Local product.", -"Unified data source for both local and online products." +"Unified data source for both local and online products. Note: Products management through the API is not possible for this channel." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/merchantapi.products_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.products_v1beta.json index d0044bb752d..5ee7d0267c9 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.products_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.products_v1beta.json @@ -242,7 +242,7 @@ } } }, -"revision": "20240614", +"revision": "20240719", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "Attributes": { @@ -1085,6 +1085,10 @@ false "format": "int64", "type": "string" }, +"memberPriceEffectiveDate": { +"$ref": "Interval", +"description": "A date range during which the item is eligible for member price. If not specified, the member price is always applicable. The date range is represented by a pair of ISO 8601 dates separated by a space, comma, or slash." +}, "price": { "$ref": "Price", "description": "The price for members of the given tier, that is, the instant discount price. Must be smaller or equal to the regular price." diff --git a/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json b/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json index b1f9a6e5b5e..8272febb31a 100644 --- a/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json @@ -2473,7 +2473,7 @@ } } }, -"revision": "20240704", +"revision": "20240711", "rootUrl": "https://migrationcenter.googleapis.com/", "schemas": { "AddAssetsToGroupRequest": { @@ -3452,7 +3452,7 @@ "description": "Preferences concerning the machine types to consider on Compute Engine." }, "multithreading": { -"description": "Optional. Preferences for multithreading support.", +"description": "Optional. Preferences for multithreading support on Windows Server.", "enum": [ "MULTITHREADING_UNSPECIFIED", "MULTITHREADING_DISABLED", @@ -3460,10 +3460,10 @@ "MULTITHREADING_DISABLED_WITH_COMPENSATION" ], "enumDescriptions": [ -"Same as MULTITHREADING_DISABLED_WITH_COMPENSATION.", -"Disable simultaneous multithreading if doing so is advantageous.", -"Always enable simultaneous multithreading.", -"Disable simultaneous multithreading and increase number of VCPUs to compensate, if doing so is advantageous." +"Same as MULTITHREADING_AUTO.", +"Disable simultaneous multithreading.", +"Enable simultaneous multithreading.", +"Disable simultaneous multithreading and increase number of VCPUs to compensate." ], "type": "string" }, @@ -4070,10 +4070,10 @@ "MULTITHREADING_DISABLED_WITH_COMPENSATION" ], "enumDescriptions": [ -"Same as MULTITHREADING_DISABLED_WITH_COMPENSATION.", -"Disable simultaneous multithreading if doing so is lower cost.", -"Always enable simultaneous multithreading.", -"Disable simultaneous multithreading and increase number of VCPUs to compensate, if doing so is lower cost." +"Same as MULTITHREADING_AUTO.", +"Disable simultaneous multithreading.", +"Enable simultaneous multithreading.", +"Disable simultaneous multithreading and increase number of VCPUs to compensate." ], "type": "string" }, @@ -6991,7 +6991,8 @@ false }, "monthlyCostCompute": { "$ref": "Money", -"description": "Compute monthly cost for this preference set." +"description": "Output only. Compute monthly cost for this preference set.", +"readOnly": true }, "monthlyCostDatabaseBackup": { "$ref": "Money", @@ -7005,23 +7006,28 @@ false }, "monthlyCostNetworkEgress": { "$ref": "Money", -"description": "Network Egress monthly cost for this preference set. Only present for virtual machines." +"description": "Output only. Network Egress monthly cost for this preference set. Only present for virtual machines.", +"readOnly": true }, "monthlyCostOsLicense": { "$ref": "Money", -"description": "Operating system licensing monthly cost for this preference set. Only present for virtual machines." +"description": "Output only. Operating system licensing monthly cost for this preference set. Only present for virtual machines.", +"readOnly": true }, "monthlyCostOther": { "$ref": "Money", -"description": "Miscellaneous monthly cost for this preference set." +"description": "Output only. Miscellaneous monthly cost for this preference set.", +"readOnly": true }, "monthlyCostStorage": { "$ref": "Money", -"description": "Storage monthly cost for this preference set." +"description": "Output only. Storage monthly cost for this preference set.", +"readOnly": true }, "monthlyCostTotal": { "$ref": "Money", -"description": "Total monthly cost for this preference set." +"description": "Output only. Total monthly cost for this preference set.", +"readOnly": true }, "preferenceSet": { "$ref": "PreferenceSet", diff --git a/googleapiclient/discovery_cache/documents/ondemandscanning.v1.json b/googleapiclient/discovery_cache/documents/ondemandscanning.v1.json index b2c0393fb28..529a97940c9 100644 --- a/googleapiclient/discovery_cache/documents/ondemandscanning.v1.json +++ b/googleapiclient/discovery_cache/documents/ondemandscanning.v1.json @@ -339,7 +339,7 @@ } } }, -"revision": "20240709", +"revision": "20240715", "rootUrl": "https://ondemandscanning.googleapis.com/", "schemas": { "AliasContext": { @@ -1939,7 +1939,8 @@ "NUGET", "RUBYGEMS", "RUST", -"COMPOSER" +"COMPOSER", +"SWIFT" ], "enumDescriptions": [ "", @@ -1952,7 +1953,8 @@ "Nuget (C#/.NET) packages.", "Ruby packges (from RubyGems package manager).", "Rust packages from Cargo (Github ecosystem is `RUST`).", -"PHP packages from Composer package manager." +"PHP packages from Composer package manager.", +"Swift packages from Swift Package Manager (SwiftPM)." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/ondemandscanning.v1beta1.json b/googleapiclient/discovery_cache/documents/ondemandscanning.v1beta1.json index 2df09cd2fdb..8dd69ba675c 100644 --- a/googleapiclient/discovery_cache/documents/ondemandscanning.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/ondemandscanning.v1beta1.json @@ -339,7 +339,7 @@ } } }, -"revision": "20240709", +"revision": "20240715", "rootUrl": "https://ondemandscanning.googleapis.com/", "schemas": { "AliasContext": { @@ -1934,7 +1934,8 @@ "NUGET", "RUBYGEMS", "RUST", -"COMPOSER" +"COMPOSER", +"SWIFT" ], "enumDescriptions": [ "", @@ -1947,7 +1948,8 @@ "Nuget (C#/.NET) packages.", "Ruby packges (from RubyGems package manager).", "Rust packages from Cargo (Github ecosystem is `RUST`).", -"PHP packages from Composer package manager." +"PHP packages from Composer package manager.", +"Swift packages from Swift Package Manager (SwiftPM)." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/pollen.v1.json b/googleapiclient/discovery_cache/documents/pollen.v1.json index 6c61b097e0e..db43cff4afc 100644 --- a/googleapiclient/discovery_cache/documents/pollen.v1.json +++ b/googleapiclient/discovery_cache/documents/pollen.v1.json @@ -121,7 +121,7 @@ "type": "integer" }, "languageCode": { -"description": "Optional. Allows the client to choose the language for the response. If data cannot be provided for that language the API uses the closest match. Allowed values rely on the IETF BCP-47 standard. Default value is \"en\".", +"description": "Optional. Allows the client to choose the language for the response. If data cannot be provided for that language, the API uses the closest match. Allowed values rely on the IETF BCP-47 standard. The default value is \"en\".", "location": "query", "type": "string" }, @@ -138,18 +138,18 @@ "type": "number" }, "pageSize": { -"description": "Optional. The maximum number of daily info records to return per page. The default and max value is 5 (5 days of data).", +"description": "Optional. The maximum number of daily info records to return per page. The default and max value is 5, indicating 5 days of data.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "Optional. A page token received from a previous daily call. It is used to retrieve the subsequent page. Note that when providing a value for the page token all other request parameters provided must match the previous call that provided the page token.", +"description": "Optional. A page token received from a previous daily call. It is used to retrieve the subsequent page. Note that when providing a value for the page token, all other request parameters provided must match the previous call that provided the page token.", "location": "query", "type": "string" }, "plantsDescription": { -"description": "Optional. Contains general information about plants, including details on their seasonality, special shapes and colors, information about allergic cross-reactions, and plant photos.", +"description": "Optional. Contains general information about plants, including details on their seasonality, special shapes and colors, information about allergic cross-reactions, and plant photos. The default value is \"true\".", "location": "query", "type": "boolean" } @@ -192,7 +192,7 @@ "Unspecified map type.", "The heatmap type will represent a tree index graphical map.", "The heatmap type will represent a grass index graphical map.", -"The heatmap type will represent a weed index graphically map." +"The heatmap type will represent a weed index graphical map." ], "location": "path", "required": true, @@ -233,7 +233,7 @@ } } }, -"revision": "20240707", +"revision": "20240720", "rootUrl": "https://pollen.googleapis.com/", "schemas": { "Color": { @@ -294,14 +294,14 @@ "description": "The date in UTC at which the pollen forecast data is represented." }, "plantInfo": { -"description": "This list will include (up to) 15 pollen species affecting the location specified in the request.", +"description": "This list will include up to 15 pollen species affecting the location specified in the request.", "items": { "$ref": "PlantInfo" }, "type": "array" }, "pollenTypeInfo": { -"description": "This list will include (up to) three pollen types (grass, weed, tree) affecting the location specified in the request.", +"description": "This list will include up to three pollen types (GRASS, WEED, TREE) affecting the location specified in the request.", "items": { "$ref": "PollenTypeInfo" }, diff --git a/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json b/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json index 5a41fbb0731..c285e7ae463 100644 --- a/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json +++ b/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json @@ -694,7 +694,7 @@ } } }, -"revision": "20240630", +"revision": "20240713", "rootUrl": "https://recaptchaenterprise.googleapis.com/", "schemas": { "GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment": { @@ -1032,7 +1032,7 @@ true "type": "string" }, "express": { -"description": "Optional. Flag for a reCAPTCHA express request for an assessment without a token. If enabled, `site_key` must reference a SCORE key with WAF feature set to EXPRESS.", +"description": "Optional. Flag for a reCAPTCHA express request for an assessment without a token. If enabled, `site_key` must reference an Express site key.", "type": "boolean" }, "firewallPolicyEvaluation": { @@ -1105,6 +1105,12 @@ true }, "type": "object" }, +"GoogleCloudRecaptchaenterpriseV1ExpressKeySettings": { +"description": "Settings specific to keys that can be used for reCAPTCHA Express.", +"id": "GoogleCloudRecaptchaenterpriseV1ExpressKeySettings", +"properties": {}, +"type": "object" +}, "GoogleCloudRecaptchaenterpriseV1FirewallAction": { "description": "An individual action. Each action represents what to do if a policy matches.", "id": "GoogleCloudRecaptchaenterpriseV1FirewallAction", @@ -1403,6 +1409,10 @@ true "description": "Required. Human-readable display name of this key. Modifiable by user.", "type": "string" }, +"expressSettings": { +"$ref": "GoogleCloudRecaptchaenterpriseV1ExpressKeySettings", +"description": "Settings for keys that can be used by reCAPTCHA Express." +}, "iosSettings": { "$ref": "GoogleCloudRecaptchaenterpriseV1IOSKeySettings", "description": "Settings for keys that can be used by iOS apps." @@ -1411,7 +1421,7 @@ true "additionalProperties": { "type": "string" }, -"description": "Optional. See [Creating and managing labels] (https://cloud.google.com/recaptcha-enterprise/docs/labels).", +"description": "Optional. See [Creating and managing labels] (https://cloud.google.com/recaptcha/docs/labels).", "type": "object" }, "name": { @@ -1541,7 +1551,7 @@ true "id": "GoogleCloudRecaptchaenterpriseV1MigrateKeyRequest", "properties": { "skipBillingCheck": { -"description": "Optional. If true, skips the billing check. A reCAPTCHA Enterprise key or migrated key behaves differently than a reCAPTCHA (non-Enterprise version) key when you reach a quota limit (see https://cloud.google.com/recaptcha-enterprise/quotas#quota_limit). To avoid any disruption of your usage, we check that a billing account is present. If your usage of reCAPTCHA is under the free quota, you can safely skip the billing check and proceed with the migration. See https://cloud.google.com/recaptcha-enterprise/docs/billing-information.", +"description": "Optional. If true, skips the billing check. A reCAPTCHA Enterprise key or migrated key behaves differently than a reCAPTCHA (non-Enterprise version) key when you reach a quota limit (see https://cloud.google.com/recaptcha/quotas#quota_limit). To avoid any disruption of your usage, we check that a billing account is present. If your usage of reCAPTCHA is under the free quota, you can safely skip the billing check and proceed with the migration. See https://cloud.google.com/recaptcha/docs/billing-information.", "type": "boolean" } }, diff --git a/googleapiclient/discovery_cache/documents/redis.v1.json b/googleapiclient/discovery_cache/documents/redis.v1.json index 47cbe760491..bd9743f2767 100644 --- a/googleapiclient/discovery_cache/documents/redis.v1.json +++ b/googleapiclient/discovery_cache/documents/redis.v1.json @@ -821,7 +821,7 @@ } } }, -"revision": "20240627", +"revision": "20240711", "rootUrl": "https://redis.googleapis.com/", "schemas": { "AOFConfig": { @@ -1231,8 +1231,7 @@ "type": "string" }, "observabilityMetricData": { -"$ref": "ObservabilityMetricData", -"description": "More feed data would be added in subsequent CLs" +"$ref": "ObservabilityMetricData" }, "recommendationSignalData": { "$ref": "DatabaseResourceRecommendationSignalData" diff --git a/googleapiclient/discovery_cache/documents/redis.v1beta1.json b/googleapiclient/discovery_cache/documents/redis.v1beta1.json index e8cfdc05c00..ec5d28e2022 100644 --- a/googleapiclient/discovery_cache/documents/redis.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/redis.v1beta1.json @@ -821,7 +821,7 @@ } } }, -"revision": "20240627", +"revision": "20240711", "rootUrl": "https://redis.googleapis.com/", "schemas": { "AOFConfig": { @@ -1231,8 +1231,7 @@ "type": "string" }, "observabilityMetricData": { -"$ref": "ObservabilityMetricData", -"description": "More feed data would be added in subsequent CLs" +"$ref": "ObservabilityMetricData" }, "recommendationSignalData": { "$ref": "DatabaseResourceRecommendationSignalData" diff --git a/googleapiclient/discovery_cache/documents/retail.v2alpha.json b/googleapiclient/discovery_cache/documents/retail.v2alpha.json index 6dfefb6f379..3325597cd47 100644 --- a/googleapiclient/discovery_cache/documents/retail.v2alpha.json +++ b/googleapiclient/discovery_cache/documents/retail.v2alpha.json @@ -2259,6 +2259,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"export": { +"description": "Exports user events. `Operation.response` is of type `ExportResponse`. `Operation.metadata` is of type `ExportMetadata`.", +"flatPath": "v2alpha/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/userEvents:export", +"httpMethod": "POST", +"id": "retail.projects.locations.catalogs.userEvents.export", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. Resource name of a Catalog. For example `projects/1234/locations/global/catalogs/default_catalog`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2alpha/{+parent}/userEvents:export", +"request": { +"$ref": "GoogleCloudRetailV2alphaExportUserEventsRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "import": { "description": "Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. `Operation.response` is of type `ImportResponse`. Note that it is possible for a subset of the items to be successfully inserted. `Operation.metadata` is of type `ImportMetadata`.", "flatPath": "v2alpha/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/userEvents:import", @@ -2557,7 +2585,7 @@ } } }, -"revision": "20240702", +"revision": "20240711", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -4483,6 +4511,21 @@ }, "type": "object" }, +"GoogleCloudRetailV2alphaExportUserEventsRequest": { +"description": "Request message for the `ExportUserEvents` method.", +"id": "GoogleCloudRetailV2alphaExportUserEventsRequest", +"properties": { +"filter": { +"description": "A filtering expression to specify restrictions on returned events. The expression is a sequence of terms. Each term applies a restriction to the returned user events. Use this expression to restrict results to a specific time range or to filter events by eventType. For example, `eventTime > \"2012-04-23T18:25:43.511Z\" eventsMissingCatalogItems eventTime<\"2012-04-23T18:25:43.511Z\" eventType=search` We expect only three types of fields: * `eventTime`: This can be specified twice, once with a less than operator and once with a greater than operator. The `eventTime` restriction should result in one, contiguous, valid, `eventTime` range. * `eventType`: Boolean operators `OR` and `NOT` are supported if the expression is enclosed in parentheses and the operators are separated from the tag values by a space. * `eventsMissingCatalogItems`: This restricts results to events for which catalog items were not found in the catalog. The default behavior is to return only those events for which catalog items were found. Some examples of valid filters expressions: * Example 1: `eventTime > \"2012-04-23T18:25:43.511Z\" eventTime < \"2012-04-23T18:30:43.511Z\"` * Example 2: `eventTime > \"2012-04-23T18:25:43.511Z\" eventType = detail-page-view` * Example 3: `eventsMissingCatalogItems eventType = (NOT search) eventTime < \"2018-04-23T18:30:43.511Z\"` * Example 4: `eventTime > \"2012-04-23T18:25:43.511Z\"` * Example 5: `eventType = (detail-page-view OR search)` * Example 6: `eventsMissingCatalogItems`", +"type": "string" +}, +"outputConfig": { +"$ref": "GoogleCloudRetailV2alphaOutputConfig", +"description": "Required. The output location of the data." +} +}, +"type": "object" +}, "GoogleCloudRetailV2alphaExportUserEventsResponse": { "description": "Response of the ExportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", "id": "GoogleCloudRetailV2alphaExportUserEventsResponse", diff --git a/googleapiclient/discovery_cache/documents/retail.v2beta.json b/googleapiclient/discovery_cache/documents/retail.v2beta.json index 9658a0902e2..834fda6071e 100644 --- a/googleapiclient/discovery_cache/documents/retail.v2beta.json +++ b/googleapiclient/discovery_cache/documents/retail.v2beta.json @@ -1854,6 +1854,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"export": { +"description": "Exports user events. `Operation.response` is of type `ExportResponse`. `Operation.metadata` is of type `ExportMetadata`.", +"flatPath": "v2beta/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/userEvents:export", +"httpMethod": "POST", +"id": "retail.projects.locations.catalogs.userEvents.export", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. Resource name of a Catalog. For example `projects/1234/locations/global/catalogs/default_catalog`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2beta/{+parent}/userEvents:export", +"request": { +"$ref": "GoogleCloudRetailV2betaExportUserEventsRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "import": { "description": "Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. `Operation.response` is of type `ImportResponse`. Note that it is possible for a subset of the items to be successfully inserted. `Operation.metadata` is of type `ImportMetadata`.", "flatPath": "v2beta/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/userEvents:import", @@ -2120,7 +2148,7 @@ } } }, -"revision": "20240702", +"revision": "20240711", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -4606,6 +4634,21 @@ }, "type": "object" }, +"GoogleCloudRetailV2betaExportUserEventsRequest": { +"description": "Request message for the `ExportUserEvents` method.", +"id": "GoogleCloudRetailV2betaExportUserEventsRequest", +"properties": { +"filter": { +"description": "A filtering expression to specify restrictions on returned events. The expression is a sequence of terms. Each term applies a restriction to the returned user events. Use this expression to restrict results to a specific time range or to filter events by eventType. For example, `eventTime > \"2012-04-23T18:25:43.511Z\" eventsMissingCatalogItems eventTime<\"2012-04-23T18:25:43.511Z\" eventType=search` We expect only three types of fields: * `eventTime`: This can be specified twice, once with a less than operator and once with a greater than operator. The `eventTime` restriction should result in one, contiguous, valid, `eventTime` range. * `eventType`: Boolean operators `OR` and `NOT` are supported if the expression is enclosed in parentheses and the operators are separated from the tag values by a space. * `eventsMissingCatalogItems`: This restricts results to events for which catalog items were not found in the catalog. The default behavior is to return only those events for which catalog items were found. Some examples of valid filters expressions: * Example 1: `eventTime > \"2012-04-23T18:25:43.511Z\" eventTime < \"2012-04-23T18:30:43.511Z\"` * Example 2: `eventTime > \"2012-04-23T18:25:43.511Z\" eventType = detail-page-view` * Example 3: `eventsMissingCatalogItems eventType = (NOT search) eventTime < \"2018-04-23T18:30:43.511Z\"` * Example 4: `eventTime > \"2012-04-23T18:25:43.511Z\"` * Example 5: `eventType = (detail-page-view OR search)` * Example 6: `eventsMissingCatalogItems`", +"type": "string" +}, +"outputConfig": { +"$ref": "GoogleCloudRetailV2betaOutputConfig", +"description": "Required. The output location of the data." +} +}, +"type": "object" +}, "GoogleCloudRetailV2betaExportUserEventsResponse": { "description": "Response of the ExportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", "id": "GoogleCloudRetailV2betaExportUserEventsResponse", diff --git a/googleapiclient/discovery_cache/documents/run.v1.json b/googleapiclient/discovery_cache/documents/run.v1.json index dc86a4f86ad..b3e1b649cb7 100644 --- a/googleapiclient/discovery_cache/documents/run.v1.json +++ b/googleapiclient/discovery_cache/documents/run.v1.json @@ -2614,7 +2614,7 @@ } } }, -"revision": "20240705", +"revision": "20240712", "rootUrl": "https://run.googleapis.com/", "schemas": { "Addressable": { @@ -5674,7 +5674,7 @@ false "id": "RevisionSpec", "properties": { "containerConcurrency": { -"description": "ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified, defaults to 80.", +"description": "ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1.", "format": "int32", "type": "integer" }, diff --git a/googleapiclient/discovery_cache/documents/run.v2.json b/googleapiclient/discovery_cache/documents/run.v2.json index 7133b466bd1..c1fe43f5267 100644 --- a/googleapiclient/discovery_cache/documents/run.v2.json +++ b/googleapiclient/discovery_cache/documents/run.v2.json @@ -1494,7 +1494,7 @@ } } }, -"revision": "20240705", +"revision": "20240712", "rootUrl": "https://run.googleapis.com/", "schemas": { "GoogleCloudRunV2BinaryAuthorization": { @@ -2979,7 +2979,7 @@ "type": "object" }, "maxInstanceRequestConcurrency": { -"description": "Optional. Sets the maximum number of requests that each serving instance can receive.", +"description": "Optional. Sets the maximum number of requests that each serving instance can receive. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1.", "format": "int32", "type": "integer" }, diff --git a/googleapiclient/discovery_cache/documents/securitycenter.v1.json b/googleapiclient/discovery_cache/documents/securitycenter.v1.json index 1864af9c9c6..d8d1fe17541 100644 --- a/googleapiclient/discovery_cache/documents/securitycenter.v1.json +++ b/googleapiclient/discovery_cache/documents/securitycenter.v1.json @@ -414,7 +414,7 @@ ], "parameters": { "parent": { -"description": "Required. Resource name of the parent to validate the Custom Module under. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings\". * \"folders/{folder}/eventThreatDetectionSettings\". * \"projects/{project}/eventThreatDetectionSettings\".", +"description": "Required. Resource name of the parent to validate the Custom Module under. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.", "location": "path", "pattern": "^folders/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -446,7 +446,7 @@ ], "parameters": { "parent": { -"description": "Required. The new custom module's parent. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings\". * \"folders/{folder}/eventThreatDetectionSettings\". * \"projects/{project}/eventThreatDetectionSettings\".", +"description": "Required. The new custom module's parent. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.", "location": "path", "pattern": "^folders/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -474,7 +474,7 @@ ], "parameters": { "name": { -"description": "Required. Name of the custom module to delete. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings/customModules/{module}\". * \"folders/{folder}/eventThreatDetectionSettings/customModules/{module}\". * \"projects/{project}/eventThreatDetectionSettings/customModules/{module}\".", +"description": "Required. Name of the custom module to delete. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`.", "location": "path", "pattern": "^folders/[^/]+/eventThreatDetectionSettings/customModules/[^/]+$", "required": true, @@ -499,7 +499,7 @@ ], "parameters": { "name": { -"description": "Required. Name of the custom module to get. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings/customModules/{module}\". * \"folders/{folder}/eventThreatDetectionSettings/customModules/{module}\". * \"projects/{project}/eventThreatDetectionSettings/customModules/{module}\".", +"description": "Required. Name of the custom module to get. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`.", "location": "path", "pattern": "^folders/[^/]+/eventThreatDetectionSettings/customModules/[^/]+$", "required": true, @@ -535,7 +535,7 @@ "type": "string" }, "parent": { -"description": "Required. Name of the parent to list custom modules under. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings\". * \"folders/{folder}/eventThreatDetectionSettings\". * \"projects/{project}/eventThreatDetectionSettings\".", +"description": "Required. Name of the parent to list custom modules under. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.", "location": "path", "pattern": "^folders/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -571,7 +571,7 @@ "type": "string" }, "parent": { -"description": "Required. Name of the parent to list custom modules under. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings\". * \"folders/{folder}/eventThreatDetectionSettings\". * \"projects/{project}/eventThreatDetectionSettings\".", +"description": "Required. Name of the parent to list custom modules under. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.", "location": "path", "pattern": "^folders/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -634,7 +634,7 @@ ], "parameters": { "name": { -"description": "Required. The resource name of the effective Event Threat Detection custom module. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}\". * \"folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}\". * \"projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}\".", +"description": "Required. The resource name of the effective Event Threat Detection custom module. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}`.", "location": "path", "pattern": "^folders/[^/]+/eventThreatDetectionSettings/effectiveCustomModules/[^/]+$", "required": true, @@ -670,7 +670,7 @@ "type": "string" }, "parent": { -"description": "Required. Name of the parent to list custom modules for. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings\". * \"folders/{folder}/eventThreatDetectionSettings\". * \"projects/{project}/eventThreatDetectionSettings\".", +"description": "Required. Name of the parent to list custom modules for. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.", "location": "path", "pattern": "^folders/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -2190,7 +2190,7 @@ ], "parameters": { "parent": { -"description": "Required. Resource name of the parent to validate the Custom Module under. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings\". * \"folders/{folder}/eventThreatDetectionSettings\". * \"projects/{project}/eventThreatDetectionSettings\".", +"description": "Required. Resource name of the parent to validate the Custom Module under. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.", "location": "path", "pattern": "^organizations/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -2222,7 +2222,7 @@ ], "parameters": { "parent": { -"description": "Required. The new custom module's parent. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings\". * \"folders/{folder}/eventThreatDetectionSettings\". * \"projects/{project}/eventThreatDetectionSettings\".", +"description": "Required. The new custom module's parent. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.", "location": "path", "pattern": "^organizations/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -2250,7 +2250,7 @@ ], "parameters": { "name": { -"description": "Required. Name of the custom module to delete. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings/customModules/{module}\". * \"folders/{folder}/eventThreatDetectionSettings/customModules/{module}\". * \"projects/{project}/eventThreatDetectionSettings/customModules/{module}\".", +"description": "Required. Name of the custom module to delete. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`.", "location": "path", "pattern": "^organizations/[^/]+/eventThreatDetectionSettings/customModules/[^/]+$", "required": true, @@ -2275,7 +2275,7 @@ ], "parameters": { "name": { -"description": "Required. Name of the custom module to get. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings/customModules/{module}\". * \"folders/{folder}/eventThreatDetectionSettings/customModules/{module}\". * \"projects/{project}/eventThreatDetectionSettings/customModules/{module}\".", +"description": "Required. Name of the custom module to get. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`.", "location": "path", "pattern": "^organizations/[^/]+/eventThreatDetectionSettings/customModules/[^/]+$", "required": true, @@ -2311,7 +2311,7 @@ "type": "string" }, "parent": { -"description": "Required. Name of the parent to list custom modules under. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings\". * \"folders/{folder}/eventThreatDetectionSettings\". * \"projects/{project}/eventThreatDetectionSettings\".", +"description": "Required. Name of the parent to list custom modules under. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.", "location": "path", "pattern": "^organizations/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -2347,7 +2347,7 @@ "type": "string" }, "parent": { -"description": "Required. Name of the parent to list custom modules under. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings\". * \"folders/{folder}/eventThreatDetectionSettings\". * \"projects/{project}/eventThreatDetectionSettings\".", +"description": "Required. Name of the parent to list custom modules under. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.", "location": "path", "pattern": "^organizations/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -2410,7 +2410,7 @@ ], "parameters": { "name": { -"description": "Required. The resource name of the effective Event Threat Detection custom module. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}\". * \"folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}\". * \"projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}\".", +"description": "Required. The resource name of the effective Event Threat Detection custom module. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}`.", "location": "path", "pattern": "^organizations/[^/]+/eventThreatDetectionSettings/effectiveCustomModules/[^/]+$", "required": true, @@ -2446,7 +2446,7 @@ "type": "string" }, "parent": { -"description": "Required. Name of the parent to list custom modules for. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings\". * \"folders/{folder}/eventThreatDetectionSettings\". * \"projects/{project}/eventThreatDetectionSettings\".", +"description": "Required. Name of the parent to list custom modules for. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.", "location": "path", "pattern": "^organizations/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -4649,7 +4649,7 @@ ], "parameters": { "parent": { -"description": "Required. Resource name of the parent to validate the Custom Module under. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings\". * \"folders/{folder}/eventThreatDetectionSettings\". * \"projects/{project}/eventThreatDetectionSettings\".", +"description": "Required. Resource name of the parent to validate the Custom Module under. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.", "location": "path", "pattern": "^projects/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -4681,7 +4681,7 @@ ], "parameters": { "parent": { -"description": "Required. The new custom module's parent. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings\". * \"folders/{folder}/eventThreatDetectionSettings\". * \"projects/{project}/eventThreatDetectionSettings\".", +"description": "Required. The new custom module's parent. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.", "location": "path", "pattern": "^projects/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -4709,7 +4709,7 @@ ], "parameters": { "name": { -"description": "Required. Name of the custom module to delete. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings/customModules/{module}\". * \"folders/{folder}/eventThreatDetectionSettings/customModules/{module}\". * \"projects/{project}/eventThreatDetectionSettings/customModules/{module}\".", +"description": "Required. Name of the custom module to delete. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`.", "location": "path", "pattern": "^projects/[^/]+/eventThreatDetectionSettings/customModules/[^/]+$", "required": true, @@ -4734,7 +4734,7 @@ ], "parameters": { "name": { -"description": "Required. Name of the custom module to get. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings/customModules/{module}\". * \"folders/{folder}/eventThreatDetectionSettings/customModules/{module}\". * \"projects/{project}/eventThreatDetectionSettings/customModules/{module}\".", +"description": "Required. Name of the custom module to get. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`.", "location": "path", "pattern": "^projects/[^/]+/eventThreatDetectionSettings/customModules/[^/]+$", "required": true, @@ -4770,7 +4770,7 @@ "type": "string" }, "parent": { -"description": "Required. Name of the parent to list custom modules under. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings\". * \"folders/{folder}/eventThreatDetectionSettings\". * \"projects/{project}/eventThreatDetectionSettings\".", +"description": "Required. Name of the parent to list custom modules under. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.", "location": "path", "pattern": "^projects/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -4806,7 +4806,7 @@ "type": "string" }, "parent": { -"description": "Required. Name of the parent to list custom modules under. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings\". * \"folders/{folder}/eventThreatDetectionSettings\". * \"projects/{project}/eventThreatDetectionSettings\".", +"description": "Required. Name of the parent to list custom modules under. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.", "location": "path", "pattern": "^projects/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -4869,7 +4869,7 @@ ], "parameters": { "name": { -"description": "Required. The resource name of the effective Event Threat Detection custom module. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}\". * \"folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}\". * \"projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}\".", +"description": "Required. The resource name of the effective Event Threat Detection custom module. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}`.", "location": "path", "pattern": "^projects/[^/]+/eventThreatDetectionSettings/effectiveCustomModules/[^/]+$", "required": true, @@ -4905,7 +4905,7 @@ "type": "string" }, "parent": { -"description": "Required. Name of the parent to list custom modules for. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings\". * \"folders/{folder}/eventThreatDetectionSettings\". * \"projects/{project}/eventThreatDetectionSettings\".", +"description": "Required. Name of the parent to list custom modules for. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.", "location": "path", "pattern": "^projects/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -6027,7 +6027,7 @@ } } }, -"revision": "20240705", +"revision": "20240720", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": { @@ -9178,7 +9178,7 @@ "type": "string" }, "dataset": { -"description": "The dataset to write findings' updates to. Its format is \"projects/[project_id]/datasets/[bigquery_dataset_id]\". BigQuery Dataset unique ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_).", +"description": "The dataset to write findings' updates to. Its format is \"projects/[project_id]/datasets/[bigquery_dataset_id]\". BigQuery dataset unique ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_).", "type": "string" }, "description": { @@ -9195,7 +9195,7 @@ "type": "string" }, "name": { -"description": "The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. The following list shows some examples: + `organizations/{organization_id}/locations/{location_id}/bigQueryExports/{export_id}` + `folders/{folder_id}/locations/{location_id}/bigQueryExports/{export_id}` + `projects/{project_id}/locations/{location_id}/bigQueryExports/{export_id}` This field is provided in responses, and is ignored when provided in create requests.", +"description": "Identifier. The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. The following list shows some examples: + `organizations/{organization_id}/locations/{location_id}/bigQueryExports/{export_id}` + `folders/{folder_id}/locations/{location_id}/bigQueryExports/{export_id}` + `projects/{project_id}/locations/{location_id}/bigQueryExports/{export_id}` This field is provided in responses, and is ignored when provided in create requests.", "type": "string" }, "principal": { @@ -10871,7 +10871,7 @@ "type": "string" }, "name": { -"description": "This field will be ignored if provided on config creation. The following list shows some examples of the format: + `organizations/{organization}/muteConfigs/{mute_config}` + `organizations/{organization}locations/{location}//muteConfigs/{mute_config}` + `folders/{folder}/muteConfigs/{mute_config}` + `folders/{folder}/locations/{location}/muteConfigs/{mute_config}` + `projects/{project}/muteConfigs/{mute_config}` + `projects/{project}/locations/{location}/muteConfigs/{mute_config}`", +"description": "Identifier. This field will be ignored if provided on config creation. The following list shows some examples of the format: + `organizations/{organization}/muteConfigs/{mute_config}` + `organizations/{organization}locations/{location}//muteConfigs/{mute_config}` + `folders/{folder}/muteConfigs/{mute_config}` + `folders/{folder}/locations/{location}/muteConfigs/{mute_config}` + `projects/{project}/muteConfigs/{mute_config}` + `projects/{project}/locations/{location}/muteConfigs/{mute_config}`", "type": "string" }, "type": { @@ -11359,7 +11359,7 @@ "type": "string" }, "name": { -"description": "Name for the resource value configuration", +"description": "Identifier. Name for the resource value configuration", "type": "string" }, "resourceLabelsSelector": { @@ -11374,7 +11374,7 @@ "type": "string" }, "resourceValue": { -"description": "Resource value level this expression represents Only required when there is no SDP mapping in the request", +"description": "Resource value level this expression represents Only required when there is no Sensitive Data Protection mapping in the request", "enum": [ "RESOURCE_VALUE_UNSPECIFIED", "HIGH", @@ -11392,7 +11392,7 @@ "type": "string" }, "scope": { -"description": "Project or folder to scope this configuration to. For example, \"project/456\" would apply this configuration only to resources in \"project/456\" scope will be checked with `AND` of other resources.", +"description": "Project or folder to scope this configuration to. For example, \"project/456\" would apply this configuration only to resources in \"project/456\" scope and will be checked with `AND` of other resources.", "type": "string" }, "sensitiveDataProtectionMapping": { @@ -11400,7 +11400,7 @@ "description": "A mapping of the sensitivity on Sensitive Data Protection finding to resource values. This mapping can only be used in combination with a resource_type that is related to BigQuery, e.g. \"bigquery.googleapis.com/Dataset\"." }, "tagValues": { -"description": "Required. Tag values combined with `AND` to check against. Values in the form \"tagValues/123\" Example: `[ \"tagValues/123\", \"tagValues/456\", \"tagValues/789\" ]` https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing", +"description": "Tag values combined with `AND` to check against. Values in the form \"tagValues/123\" Example: `[ \"tagValues/123\", \"tagValues/456\", \"tagValues/789\" ]` https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing", "items": { "type": "string" }, @@ -13375,7 +13375,7 @@ "description": "Provides the path to the resource within the resource hierarchy." }, "resourcePathString": { -"description": "A string representation of the resource path. For Google Cloud, it has the format of org/{organization_id}/folder/{folder_id}/folder/{folder_id}/project/{project_id} where there can be any number of folders. For AWS, it has the format of org/{organization_id}/ou/{organizational_unit_id}/ou/{organizational_unit_id}/account/{account_id} where there can be any number of organizational units. For Azure, it has the format of mg/{management_group_id}/mg/{management_group_id}/subscription/{subscription_id}/rg/{resource_group_name} where there can be any number of management groups.", +"description": "A string representation of the resource path. For Google Cloud, it has the format of `org/{organization_id}/folder/{folder_id}/folder/{folder_id}/project/{project_id}` where there can be any number of folders. For AWS, it has the format of `org/{organization_id}/ou/{organizational_unit_id}/ou/{organizational_unit_id}/account/{account_id}` where there can be any number of organizational units. For Azure, it has the format of `mg/{management_group_id}/mg/{management_group_id}/subscription/{subscription_id}/rg/{resource_group_name}` where there can be any number of management groups.", "type": "string" }, "service": { diff --git a/googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json b/googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json index fe1b83af845..d458e5df8cd 100644 --- a/googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json @@ -896,7 +896,7 @@ } } }, -"revision": "20240705", +"revision": "20240720", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": { @@ -3789,7 +3789,7 @@ "type": "string" }, "dataset": { -"description": "The dataset to write findings' updates to. Its format is \"projects/[project_id]/datasets/[bigquery_dataset_id]\". BigQuery Dataset unique ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_).", +"description": "The dataset to write findings' updates to. Its format is \"projects/[project_id]/datasets/[bigquery_dataset_id]\". BigQuery dataset unique ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_).", "type": "string" }, "description": { @@ -3806,7 +3806,7 @@ "type": "string" }, "name": { -"description": "The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. The following list shows some examples: + `organizations/{organization_id}/locations/{location_id}/bigQueryExports/{export_id}` + `folders/{folder_id}/locations/{location_id}/bigQueryExports/{export_id}` + `projects/{project_id}/locations/{location_id}/bigQueryExports/{export_id}` This field is provided in responses, and is ignored when provided in create requests.", +"description": "Identifier. The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. The following list shows some examples: + `organizations/{organization_id}/locations/{location_id}/bigQueryExports/{export_id}` + `folders/{folder_id}/locations/{location_id}/bigQueryExports/{export_id}` + `projects/{project_id}/locations/{location_id}/bigQueryExports/{export_id}` This field is provided in responses, and is ignored when provided in create requests.", "type": "string" }, "principal": { @@ -5482,7 +5482,7 @@ "type": "string" }, "name": { -"description": "This field will be ignored if provided on config creation. The following list shows some examples of the format: + `organizations/{organization}/muteConfigs/{mute_config}` + `organizations/{organization}locations/{location}//muteConfigs/{mute_config}` + `folders/{folder}/muteConfigs/{mute_config}` + `folders/{folder}/locations/{location}/muteConfigs/{mute_config}` + `projects/{project}/muteConfigs/{mute_config}` + `projects/{project}/locations/{location}/muteConfigs/{mute_config}`", +"description": "Identifier. This field will be ignored if provided on config creation. The following list shows some examples of the format: + `organizations/{organization}/muteConfigs/{mute_config}` + `organizations/{organization}locations/{location}//muteConfigs/{mute_config}` + `folders/{folder}/muteConfigs/{mute_config}` + `folders/{folder}/locations/{location}/muteConfigs/{mute_config}` + `projects/{project}/muteConfigs/{mute_config}` + `projects/{project}/locations/{location}/muteConfigs/{mute_config}`", "type": "string" }, "type": { @@ -5970,7 +5970,7 @@ "type": "string" }, "name": { -"description": "Name for the resource value configuration", +"description": "Identifier. Name for the resource value configuration", "type": "string" }, "resourceLabelsSelector": { @@ -5985,7 +5985,7 @@ "type": "string" }, "resourceValue": { -"description": "Resource value level this expression represents Only required when there is no SDP mapping in the request", +"description": "Resource value level this expression represents Only required when there is no Sensitive Data Protection mapping in the request", "enum": [ "RESOURCE_VALUE_UNSPECIFIED", "HIGH", @@ -6003,7 +6003,7 @@ "type": "string" }, "scope": { -"description": "Project or folder to scope this configuration to. For example, \"project/456\" would apply this configuration only to resources in \"project/456\" scope will be checked with `AND` of other resources.", +"description": "Project or folder to scope this configuration to. For example, \"project/456\" would apply this configuration only to resources in \"project/456\" scope and will be checked with `AND` of other resources.", "type": "string" }, "sensitiveDataProtectionMapping": { @@ -6011,7 +6011,7 @@ "description": "A mapping of the sensitivity on Sensitive Data Protection finding to resource values. This mapping can only be used in combination with a resource_type that is related to BigQuery, e.g. \"bigquery.googleapis.com/Dataset\"." }, "tagValues": { -"description": "Required. Tag values combined with `AND` to check against. Values in the form \"tagValues/123\" Example: `[ \"tagValues/123\", \"tagValues/456\", \"tagValues/789\" ]` https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing", +"description": "Tag values combined with `AND` to check against. Values in the form \"tagValues/123\" Example: `[ \"tagValues/123\", \"tagValues/456\", \"tagValues/789\" ]` https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing", "items": { "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json b/googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json index dfcbde00075..eb1d09b4912 100644 --- a/googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json @@ -292,7 +292,7 @@ ], "parameters": { "name": { -"description": "The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings", +"description": "Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings", "location": "path", "pattern": "^folders/[^/]+/containerThreatDetectionSettings$", "required": true, @@ -326,7 +326,7 @@ ], "parameters": { "name": { -"description": "The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings", +"description": "Identifier. The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings", "location": "path", "pattern": "^folders/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -394,7 +394,7 @@ ], "parameters": { "name": { -"description": "The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings", +"description": "Identifier. The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings", "location": "path", "pattern": "^folders/[^/]+/securityHealthAnalyticsSettings$", "required": true, @@ -428,7 +428,7 @@ ], "parameters": { "name": { -"description": "The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings", +"description": "Identifier. The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings", "location": "path", "pattern": "^folders/[^/]+/virtualMachineThreatDetectionSettings$", "required": true, @@ -462,7 +462,7 @@ ], "parameters": { "name": { -"description": "The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings", +"description": "Identifier. The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings", "location": "path", "pattern": "^folders/[^/]+/webSecurityScannerSettings$", "required": true, @@ -876,7 +876,7 @@ ], "parameters": { "name": { -"description": "The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings", +"description": "Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings", "location": "path", "pattern": "^organizations/[^/]+/containerThreatDetectionSettings$", "required": true, @@ -910,7 +910,7 @@ ], "parameters": { "name": { -"description": "The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings", +"description": "Identifier. The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings", "location": "path", "pattern": "^organizations/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -978,7 +978,7 @@ ], "parameters": { "name": { -"description": "The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings", +"description": "Identifier. The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings", "location": "path", "pattern": "^organizations/[^/]+/securityHealthAnalyticsSettings$", "required": true, @@ -1012,7 +1012,7 @@ ], "parameters": { "name": { -"description": "The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings", +"description": "Identifier. The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings", "location": "path", "pattern": "^organizations/[^/]+/virtualMachineThreatDetectionSettings$", "required": true, @@ -1046,7 +1046,7 @@ ], "parameters": { "name": { -"description": "The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings", +"description": "Identifier. The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings", "location": "path", "pattern": "^organizations/[^/]+/webSecurityScannerSettings$", "required": true, @@ -1435,7 +1435,7 @@ ], "parameters": { "name": { -"description": "The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings", +"description": "Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings", "location": "path", "pattern": "^projects/[^/]+/containerThreatDetectionSettings$", "required": true, @@ -1469,7 +1469,7 @@ ], "parameters": { "name": { -"description": "The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings", +"description": "Identifier. The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings", "location": "path", "pattern": "^projects/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -1537,7 +1537,7 @@ ], "parameters": { "name": { -"description": "The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings", +"description": "Identifier. The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings", "location": "path", "pattern": "^projects/[^/]+/securityHealthAnalyticsSettings$", "required": true, @@ -1571,7 +1571,7 @@ ], "parameters": { "name": { -"description": "The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings", +"description": "Identifier. The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings", "location": "path", "pattern": "^projects/[^/]+/virtualMachineThreatDetectionSettings$", "required": true, @@ -1605,7 +1605,7 @@ ], "parameters": { "name": { -"description": "The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings", +"description": "Identifier. The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings", "location": "path", "pattern": "^projects/[^/]+/webSecurityScannerSettings$", "required": true, @@ -1728,7 +1728,7 @@ ], "parameters": { "name": { -"description": "The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings", +"description": "Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/containerThreatDetectionSettings$", "required": true, @@ -1906,7 +1906,7 @@ } } }, -"revision": "20240705", +"revision": "20240720", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": { @@ -2599,11 +2599,11 @@ "additionalProperties": { "$ref": "Config" }, -"description": "The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's.", +"description": "The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration.", "type": "object" }, "name": { -"description": "The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings", +"description": "Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings", "type": "string" }, "serviceAccount": { @@ -2969,11 +2969,11 @@ "additionalProperties": { "$ref": "Config" }, -"description": "The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's.", +"description": "The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration.", "type": "object" }, "name": { -"description": "The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings", +"description": "Identifier. The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings", "type": "string" }, "serviceEnablementState": { @@ -4702,7 +4702,7 @@ "type": "string" }, "dataset": { -"description": "The dataset to write findings' updates to. Its format is \"projects/[project_id]/datasets/[bigquery_dataset_id]\". BigQuery Dataset unique ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_).", +"description": "The dataset to write findings' updates to. Its format is \"projects/[project_id]/datasets/[bigquery_dataset_id]\". BigQuery dataset unique ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_).", "type": "string" }, "description": { @@ -4719,7 +4719,7 @@ "type": "string" }, "name": { -"description": "The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. The following list shows some examples: + `organizations/{organization_id}/locations/{location_id}/bigQueryExports/{export_id}` + `folders/{folder_id}/locations/{location_id}/bigQueryExports/{export_id}` + `projects/{project_id}/locations/{location_id}/bigQueryExports/{export_id}` This field is provided in responses, and is ignored when provided in create requests.", +"description": "Identifier. The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. The following list shows some examples: + `organizations/{organization_id}/locations/{location_id}/bigQueryExports/{export_id}` + `folders/{folder_id}/locations/{location_id}/bigQueryExports/{export_id}` + `projects/{project_id}/locations/{location_id}/bigQueryExports/{export_id}` This field is provided in responses, and is ignored when provided in create requests.", "type": "string" }, "principal": { @@ -6395,7 +6395,7 @@ "type": "string" }, "name": { -"description": "This field will be ignored if provided on config creation. The following list shows some examples of the format: + `organizations/{organization}/muteConfigs/{mute_config}` + `organizations/{organization}locations/{location}//muteConfigs/{mute_config}` + `folders/{folder}/muteConfigs/{mute_config}` + `folders/{folder}/locations/{location}/muteConfigs/{mute_config}` + `projects/{project}/muteConfigs/{mute_config}` + `projects/{project}/locations/{location}/muteConfigs/{mute_config}`", +"description": "Identifier. This field will be ignored if provided on config creation. The following list shows some examples of the format: + `organizations/{organization}/muteConfigs/{mute_config}` + `organizations/{organization}locations/{location}//muteConfigs/{mute_config}` + `folders/{folder}/muteConfigs/{mute_config}` + `folders/{folder}/locations/{location}/muteConfigs/{mute_config}` + `projects/{project}/muteConfigs/{mute_config}` + `projects/{project}/locations/{location}/muteConfigs/{mute_config}`", "type": "string" }, "type": { @@ -6883,7 +6883,7 @@ "type": "string" }, "name": { -"description": "Name for the resource value configuration", +"description": "Identifier. Name for the resource value configuration", "type": "string" }, "resourceLabelsSelector": { @@ -6898,7 +6898,7 @@ "type": "string" }, "resourceValue": { -"description": "Resource value level this expression represents Only required when there is no SDP mapping in the request", +"description": "Resource value level this expression represents Only required when there is no Sensitive Data Protection mapping in the request", "enum": [ "RESOURCE_VALUE_UNSPECIFIED", "HIGH", @@ -6916,7 +6916,7 @@ "type": "string" }, "scope": { -"description": "Project or folder to scope this configuration to. For example, \"project/456\" would apply this configuration only to resources in \"project/456\" scope will be checked with `AND` of other resources.", +"description": "Project or folder to scope this configuration to. For example, \"project/456\" would apply this configuration only to resources in \"project/456\" scope and will be checked with `AND` of other resources.", "type": "string" }, "sensitiveDataProtectionMapping": { @@ -6924,7 +6924,7 @@ "description": "A mapping of the sensitivity on Sensitive Data Protection finding to resource values. This mapping can only be used in combination with a resource_type that is related to BigQuery, e.g. \"bigquery.googleapis.com/Dataset\"." }, "tagValues": { -"description": "Required. Tag values combined with `AND` to check against. Values in the form \"tagValues/123\" Example: `[ \"tagValues/123\", \"tagValues/456\", \"tagValues/789\" ]` https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing", +"description": "Tag values combined with `AND` to check against. Values in the form \"tagValues/123\" Example: `[ \"tagValues/123\", \"tagValues/456\", \"tagValues/789\" ]` https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing", "items": { "type": "string" }, @@ -8332,11 +8332,11 @@ "additionalProperties": { "$ref": "Config" }, -"description": "The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's.", +"description": "The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration.", "type": "object" }, "name": { -"description": "The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings", +"description": "Identifier. The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings", "type": "string" }, "serviceAccount": { @@ -8590,11 +8590,11 @@ "additionalProperties": { "$ref": "Config" }, -"description": "The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's.", +"description": "The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration.", "type": "object" }, "name": { -"description": "The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings", +"description": "Identifier. The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings", "type": "string" }, "serviceAccount": { @@ -8709,11 +8709,11 @@ "additionalProperties": { "$ref": "Config" }, -"description": "The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's.", +"description": "The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration.", "type": "object" }, "name": { -"description": "The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings", +"description": "Identifier. The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings", "type": "string" }, "serviceEnablementState": { diff --git a/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json b/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json index 9ad11d4aea6..f12d5a48a5f 100644 --- a/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json @@ -542,7 +542,7 @@ } } }, -"revision": "20240707", +"revision": "20240712", "rootUrl": "https://serviceconsumermanagement.googleapis.com/", "schemas": { "AddTenantProjectRequest": { @@ -1003,14 +1003,14 @@ "type": "array" }, "provided": { -"description": "A list of full type names of provided contexts.", +"description": "A list of full type names of provided contexts. It is used to support propagating HTTP headers and ETags from the response extension.", "items": { "type": "string" }, "type": "array" }, "requested": { -"description": "A list of full type names of requested contexts.", +"description": "A list of full type names of requested contexts, only the requested context will be made available to the backend.", "items": { "type": "string" }, @@ -1126,7 +1126,7 @@ "type": "object" }, "Documentation": { -"description": "`Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... code_snippet_rules: - selector: google.calendar.Calendar.Delete code_snippets: - includes: - github_include: region_tag: calendar_delete code_language: JAVA account: GoogleCloudPlatform project: java-docs-samples file: calendar/delete.java Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation.", +"description": "`Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation.", "id": "Documentation", "properties": { "documentationRootUrl": { @@ -1495,7 +1495,7 @@ "type": "object" }, "HttpRule": { -"description": "gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/{name=messages/*}\" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: \"messages/123456\")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:\"/v1/messages/{message_id}\" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A¶m=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"message\" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" message { text: \"Hi!\" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"*\" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" text: \"Hi!\")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/messages/{message_id}\" additional_bindings { get: \"/v1/users/{user_id}/messages/{message_id}\" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: \"123456\")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: \"me\" message_id: \"123456\")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is \"*\", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = \"/\" Segments [ Verb ] ; Segments = Segment { \"/\" Segment } ; Segment = \"*\" | \"**\" | LITERAL | Variable ; Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ; FieldPath = IDENT { \".\" IDENT } ; Verb = \":\" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `\"{var}\"` or `\"{var=*}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `\"{var=foo/*}\"` or `\"{var=**}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except \"%2F\" and \"%2f\" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. Example below selects a gRPC method and applies HttpRule to it. http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading \"/\" character. The reason is that the most common use case \"{var}\" does not capture the leading \"/\" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature.", +"description": "gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/{name=messages/*}\" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: \"messages/123456\")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:\"/v1/messages/{message_id}\" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A¶m=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"message\" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" message { text: \"Hi!\" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"*\" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" text: \"Hi!\")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/messages/{message_id}\" additional_bindings { get: \"/v1/users/{user_id}/messages/{message_id}\" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: \"123456\")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: \"me\" message_id: \"123456\")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is \"*\", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = \"/\" Segments [ Verb ] ; Segments = Segment { \"/\" Segment } ; Segment = \"*\" | \"**\" | LITERAL | Variable ; Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ; FieldPath = IDENT { \".\" IDENT } ; Verb = \":\" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `\"{var}\"` or `\"{var=*}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `\"{var=foo/*}\"` or `\"{var=**}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except \"%2F\" and \"%2f\" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. The following example selects a gRPC method and applies an `HttpRule` to it: http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading \"/\" character. The reason is that the most common use case \"{var}\" does not capture the leading \"/\" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature.", "id": "HttpRule", "properties": { "additionalBindings": { diff --git a/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json b/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json index 8209ba2aa8e..f3d9e84a518 100644 --- a/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json @@ -715,7 +715,7 @@ } } }, -"revision": "20240707", +"revision": "20240712", "rootUrl": "https://serviceconsumermanagement.googleapis.com/", "schemas": { "Api": { @@ -1110,14 +1110,14 @@ "type": "array" }, "provided": { -"description": "A list of full type names of provided contexts.", +"description": "A list of full type names of provided contexts. It is used to support propagating HTTP headers and ETags from the response extension.", "items": { "type": "string" }, "type": "array" }, "requested": { -"description": "A list of full type names of requested contexts.", +"description": "A list of full type names of requested contexts, only the requested context will be made available to the backend.", "items": { "type": "string" }, @@ -1211,7 +1211,7 @@ "type": "object" }, "Documentation": { -"description": "`Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... code_snippet_rules: - selector: google.calendar.Calendar.Delete code_snippets: - includes: - github_include: region_tag: calendar_delete code_language: JAVA account: GoogleCloudPlatform project: java-docs-samples file: calendar/delete.java Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation.", +"description": "`Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation.", "id": "Documentation", "properties": { "documentationRootUrl": { @@ -1580,7 +1580,7 @@ "type": "object" }, "HttpRule": { -"description": "gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/{name=messages/*}\" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: \"messages/123456\")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:\"/v1/messages/{message_id}\" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A¶m=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"message\" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" message { text: \"Hi!\" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"*\" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" text: \"Hi!\")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/messages/{message_id}\" additional_bindings { get: \"/v1/users/{user_id}/messages/{message_id}\" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: \"123456\")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: \"me\" message_id: \"123456\")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is \"*\", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = \"/\" Segments [ Verb ] ; Segments = Segment { \"/\" Segment } ; Segment = \"*\" | \"**\" | LITERAL | Variable ; Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ; FieldPath = IDENT { \".\" IDENT } ; Verb = \":\" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `\"{var}\"` or `\"{var=*}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `\"{var=foo/*}\"` or `\"{var=**}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except \"%2F\" and \"%2f\" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. Example below selects a gRPC method and applies HttpRule to it. http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading \"/\" character. The reason is that the most common use case \"{var}\" does not capture the leading \"/\" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature.", +"description": "gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/{name=messages/*}\" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: \"messages/123456\")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:\"/v1/messages/{message_id}\" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A¶m=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"message\" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" message { text: \"Hi!\" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"*\" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" text: \"Hi!\")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/messages/{message_id}\" additional_bindings { get: \"/v1/users/{user_id}/messages/{message_id}\" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: \"123456\")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: \"me\" message_id: \"123456\")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is \"*\", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = \"/\" Segments [ Verb ] ; Segments = Segment { \"/\" Segment } ; Segment = \"*\" | \"**\" | LITERAL | Variable ; Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ; FieldPath = IDENT { \".\" IDENT } ; Verb = \":\" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `\"{var}\"` or `\"{var=*}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `\"{var=foo/*}\"` or `\"{var=**}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except \"%2F\" and \"%2f\" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. The following example selects a gRPC method and applies an `HttpRule` to it: http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading \"/\" character. The reason is that the most common use case \"{var}\" does not capture the leading \"/\" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature.", "id": "HttpRule", "properties": { "additionalBindings": { diff --git a/googleapiclient/discovery_cache/documents/servicemanagement.v1.json b/googleapiclient/discovery_cache/documents/servicemanagement.v1.json index 6998b83a235..9c798284d8e 100644 --- a/googleapiclient/discovery_cache/documents/servicemanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/servicemanagement.v1.json @@ -830,7 +830,7 @@ } } }, -"revision": "20240628", +"revision": "20240712", "rootUrl": "https://servicemanagement.googleapis.com/", "schemas": { "Advice": { @@ -1427,14 +1427,14 @@ "type": "array" }, "provided": { -"description": "A list of full type names of provided contexts.", +"description": "A list of full type names of provided contexts. It is used to support propagating HTTP headers and ETags from the response extension.", "items": { "type": "string" }, "type": "array" }, "requested": { -"description": "A list of full type names of requested contexts.", +"description": "A list of full type names of requested contexts, only the requested context will be made available to the backend.", "items": { "type": "string" }, @@ -1561,7 +1561,7 @@ "type": "object" }, "Documentation": { -"description": "`Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... code_snippet_rules: - selector: google.calendar.Calendar.Delete code_snippets: - includes: - github_include: region_tag: calendar_delete code_language: JAVA account: GoogleCloudPlatform project: java-docs-samples file: calendar/delete.java Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation.", +"description": "`Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation.", "id": "Documentation", "properties": { "documentationRootUrl": { @@ -2043,7 +2043,7 @@ "type": "object" }, "HttpRule": { -"description": "gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/{name=messages/*}\" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: \"messages/123456\")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:\"/v1/messages/{message_id}\" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A¶m=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"message\" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" message { text: \"Hi!\" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"*\" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" text: \"Hi!\")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/messages/{message_id}\" additional_bindings { get: \"/v1/users/{user_id}/messages/{message_id}\" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: \"123456\")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: \"me\" message_id: \"123456\")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is \"*\", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = \"/\" Segments [ Verb ] ; Segments = Segment { \"/\" Segment } ; Segment = \"*\" | \"**\" | LITERAL | Variable ; Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ; FieldPath = IDENT { \".\" IDENT } ; Verb = \":\" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `\"{var}\"` or `\"{var=*}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `\"{var=foo/*}\"` or `\"{var=**}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except \"%2F\" and \"%2f\" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. Example below selects a gRPC method and applies HttpRule to it. http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading \"/\" character. The reason is that the most common use case \"{var}\" does not capture the leading \"/\" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature.", +"description": "gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/{name=messages/*}\" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: \"messages/123456\")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:\"/v1/messages/{message_id}\" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A¶m=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"message\" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" message { text: \"Hi!\" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"*\" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" text: \"Hi!\")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/messages/{message_id}\" additional_bindings { get: \"/v1/users/{user_id}/messages/{message_id}\" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: \"123456\")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: \"me\" message_id: \"123456\")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is \"*\", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = \"/\" Segments [ Verb ] ; Segments = Segment { \"/\" Segment } ; Segment = \"*\" | \"**\" | LITERAL | Variable ; Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ; FieldPath = IDENT { \".\" IDENT } ; Verb = \":\" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `\"{var}\"` or `\"{var=*}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `\"{var=foo/*}\"` or `\"{var=**}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except \"%2F\" and \"%2f\" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. The following example selects a gRPC method and applies an `HttpRule` to it: http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading \"/\" character. The reason is that the most common use case \"{var}\" does not capture the leading \"/\" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature.", "id": "HttpRule", "properties": { "additionalBindings": { diff --git a/googleapiclient/discovery_cache/documents/servicenetworking.v1.json b/googleapiclient/discovery_cache/documents/servicenetworking.v1.json index 8239a03d6de..d18d247b207 100644 --- a/googleapiclient/discovery_cache/documents/servicenetworking.v1.json +++ b/googleapiclient/discovery_cache/documents/servicenetworking.v1.json @@ -1029,7 +1029,7 @@ } } }, -"revision": "20240707", +"revision": "20240716", "rootUrl": "https://servicenetworking.googleapis.com/", "schemas": { "AddDnsRecordSetMetadata": { @@ -1765,14 +1765,14 @@ "type": "array" }, "provided": { -"description": "A list of full type names of provided contexts.", +"description": "A list of full type names of provided contexts. It is used to support propagating HTTP headers and ETags from the response extension.", "items": { "type": "string" }, "type": "array" }, "requested": { -"description": "A list of full type names of requested contexts.", +"description": "A list of full type names of requested contexts, only the requested context will be made available to the backend.", "items": { "type": "string" }, @@ -1957,7 +1957,7 @@ "type": "object" }, "Documentation": { -"description": "`Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... code_snippet_rules: - selector: google.calendar.Calendar.Delete code_snippets: - includes: - github_include: region_tag: calendar_delete code_language: JAVA account: GoogleCloudPlatform project: java-docs-samples file: calendar/delete.java Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation.", +"description": "`Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation.", "id": "Documentation", "properties": { "documentationRootUrl": { @@ -2421,7 +2421,7 @@ "type": "object" }, "HttpRule": { -"description": "gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/{name=messages/*}\" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: \"messages/123456\")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:\"/v1/messages/{message_id}\" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A¶m=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"message\" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" message { text: \"Hi!\" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"*\" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" text: \"Hi!\")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/messages/{message_id}\" additional_bindings { get: \"/v1/users/{user_id}/messages/{message_id}\" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: \"123456\")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: \"me\" message_id: \"123456\")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is \"*\", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = \"/\" Segments [ Verb ] ; Segments = Segment { \"/\" Segment } ; Segment = \"*\" | \"**\" | LITERAL | Variable ; Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ; FieldPath = IDENT { \".\" IDENT } ; Verb = \":\" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `\"{var}\"` or `\"{var=*}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `\"{var=foo/*}\"` or `\"{var=**}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except \"%2F\" and \"%2f\" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. Example below selects a gRPC method and applies HttpRule to it. http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading \"/\" character. The reason is that the most common use case \"{var}\" does not capture the leading \"/\" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature.", +"description": "gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/{name=messages/*}\" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: \"messages/123456\")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:\"/v1/messages/{message_id}\" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A¶m=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"message\" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" message { text: \"Hi!\" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"*\" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" text: \"Hi!\")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/messages/{message_id}\" additional_bindings { get: \"/v1/users/{user_id}/messages/{message_id}\" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: \"123456\")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: \"me\" message_id: \"123456\")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is \"*\", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = \"/\" Segments [ Verb ] ; Segments = Segment { \"/\" Segment } ; Segment = \"*\" | \"**\" | LITERAL | Variable ; Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ; FieldPath = IDENT { \".\" IDENT } ; Verb = \":\" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `\"{var}\"` or `\"{var=*}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `\"{var=foo/*}\"` or `\"{var=**}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except \"%2F\" and \"%2f\" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. The following example selects a gRPC method and applies an `HttpRule` to it: http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading \"/\" character. The reason is that the most common use case \"{var}\" does not capture the leading \"/\" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature.", "id": "HttpRule", "properties": { "additionalBindings": { diff --git a/googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json b/googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json index b5451af2e9c..18bd3a50dc7 100644 --- a/googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json +++ b/googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json @@ -307,7 +307,7 @@ } } }, -"revision": "20240707", +"revision": "20240716", "rootUrl": "https://servicenetworking.googleapis.com/", "schemas": { "AddDnsRecordSetMetadata": { @@ -918,14 +918,14 @@ "type": "array" }, "provided": { -"description": "A list of full type names of provided contexts.", +"description": "A list of full type names of provided contexts. It is used to support propagating HTTP headers and ETags from the response extension.", "items": { "type": "string" }, "type": "array" }, "requested": { -"description": "A list of full type names of requested contexts.", +"description": "A list of full type names of requested contexts, only the requested context will be made available to the backend.", "items": { "type": "string" }, @@ -1073,7 +1073,7 @@ "type": "object" }, "Documentation": { -"description": "`Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... code_snippet_rules: - selector: google.calendar.Calendar.Delete code_snippets: - includes: - github_include: region_tag: calendar_delete code_language: JAVA account: GoogleCloudPlatform project: java-docs-samples file: calendar/delete.java Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation.", +"description": "`Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation.", "id": "Documentation", "properties": { "documentationRootUrl": { @@ -1505,7 +1505,7 @@ "type": "object" }, "HttpRule": { -"description": "gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/{name=messages/*}\" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: \"messages/123456\")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:\"/v1/messages/{message_id}\" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A¶m=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"message\" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" message { text: \"Hi!\" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"*\" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" text: \"Hi!\")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/messages/{message_id}\" additional_bindings { get: \"/v1/users/{user_id}/messages/{message_id}\" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: \"123456\")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: \"me\" message_id: \"123456\")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is \"*\", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = \"/\" Segments [ Verb ] ; Segments = Segment { \"/\" Segment } ; Segment = \"*\" | \"**\" | LITERAL | Variable ; Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ; FieldPath = IDENT { \".\" IDENT } ; Verb = \":\" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `\"{var}\"` or `\"{var=*}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `\"{var=foo/*}\"` or `\"{var=**}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except \"%2F\" and \"%2f\" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. Example below selects a gRPC method and applies HttpRule to it. http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading \"/\" character. The reason is that the most common use case \"{var}\" does not capture the leading \"/\" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature.", +"description": "gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/{name=messages/*}\" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: \"messages/123456\")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:\"/v1/messages/{message_id}\" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A¶m=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"message\" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" message { text: \"Hi!\" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"*\" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" text: \"Hi!\")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/messages/{message_id}\" additional_bindings { get: \"/v1/users/{user_id}/messages/{message_id}\" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: \"123456\")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: \"me\" message_id: \"123456\")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is \"*\", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = \"/\" Segments [ Verb ] ; Segments = Segment { \"/\" Segment } ; Segment = \"*\" | \"**\" | LITERAL | Variable ; Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ; FieldPath = IDENT { \".\" IDENT } ; Verb = \":\" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `\"{var}\"` or `\"{var=*}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `\"{var=foo/*}\"` or `\"{var=**}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except \"%2F\" and \"%2f\" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. The following example selects a gRPC method and applies an `HttpRule` to it: http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading \"/\" character. The reason is that the most common use case \"{var}\" does not capture the leading \"/\" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature.", "id": "HttpRule", "properties": { "additionalBindings": { diff --git a/googleapiclient/discovery_cache/documents/serviceusage.v1.json b/googleapiclient/discovery_cache/documents/serviceusage.v1.json index d945e35592a..8d1840f139a 100644 --- a/googleapiclient/discovery_cache/documents/serviceusage.v1.json +++ b/googleapiclient/discovery_cache/documents/serviceusage.v1.json @@ -426,7 +426,7 @@ } } }, -"revision": "20240707", +"revision": "20240712", "rootUrl": "https://serviceusage.googleapis.com/", "schemas": { "AddEnableRulesMetadata": { @@ -998,14 +998,14 @@ "type": "array" }, "provided": { -"description": "A list of full type names of provided contexts.", +"description": "A list of full type names of provided contexts. It is used to support propagating HTTP headers and ETags from the response extension.", "items": { "type": "string" }, "type": "array" }, "requested": { -"description": "A list of full type names of requested contexts.", +"description": "A list of full type names of requested contexts, only the requested context will be made available to the backend.", "items": { "type": "string" }, @@ -1147,7 +1147,7 @@ "type": "object" }, "Documentation": { -"description": "`Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... code_snippet_rules: - selector: google.calendar.Calendar.Delete code_snippets: - includes: - github_include: region_tag: calendar_delete code_language: JAVA account: GoogleCloudPlatform project: java-docs-samples file: calendar/delete.java Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation.", +"description": "`Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation.", "id": "Documentation", "properties": { "documentationRootUrl": { @@ -1971,7 +1971,7 @@ "type": "object" }, "HttpRule": { -"description": "gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/{name=messages/*}\" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: \"messages/123456\")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:\"/v1/messages/{message_id}\" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A¶m=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"message\" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" message { text: \"Hi!\" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"*\" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" text: \"Hi!\")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/messages/{message_id}\" additional_bindings { get: \"/v1/users/{user_id}/messages/{message_id}\" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: \"123456\")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: \"me\" message_id: \"123456\")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is \"*\", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = \"/\" Segments [ Verb ] ; Segments = Segment { \"/\" Segment } ; Segment = \"*\" | \"**\" | LITERAL | Variable ; Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ; FieldPath = IDENT { \".\" IDENT } ; Verb = \":\" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `\"{var}\"` or `\"{var=*}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `\"{var=foo/*}\"` or `\"{var=**}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except \"%2F\" and \"%2f\" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. Example below selects a gRPC method and applies HttpRule to it. http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading \"/\" character. The reason is that the most common use case \"{var}\" does not capture the leading \"/\" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature.", +"description": "gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/{name=messages/*}\" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: \"messages/123456\")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:\"/v1/messages/{message_id}\" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A¶m=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"message\" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" message { text: \"Hi!\" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"*\" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" text: \"Hi!\")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/messages/{message_id}\" additional_bindings { get: \"/v1/users/{user_id}/messages/{message_id}\" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: \"123456\")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: \"me\" message_id: \"123456\")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is \"*\", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = \"/\" Segments [ Verb ] ; Segments = Segment { \"/\" Segment } ; Segment = \"*\" | \"**\" | LITERAL | Variable ; Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ; FieldPath = IDENT { \".\" IDENT } ; Verb = \":\" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `\"{var}\"` or `\"{var=*}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `\"{var=foo/*}\"` or `\"{var=**}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except \"%2F\" and \"%2f\" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. The following example selects a gRPC method and applies an `HttpRule` to it: http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading \"/\" character. The reason is that the most common use case \"{var}\" does not capture the leading \"/\" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature.", "id": "HttpRule", "properties": { "additionalBindings": { diff --git a/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json b/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json index e7809f590ec..6037b5a29ed 100644 --- a/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json @@ -964,7 +964,7 @@ } } }, -"revision": "20240707", +"revision": "20240712", "rootUrl": "https://serviceusage.googleapis.com/", "schemas": { "AddEnableRulesMetadata": { @@ -1594,14 +1594,14 @@ "type": "array" }, "provided": { -"description": "A list of full type names of provided contexts.", +"description": "A list of full type names of provided contexts. It is used to support propagating HTTP headers and ETags from the response extension.", "items": { "type": "string" }, "type": "array" }, "requested": { -"description": "A list of full type names of requested contexts.", +"description": "A list of full type names of requested contexts, only the requested context will be made available to the backend.", "items": { "type": "string" }, @@ -1724,7 +1724,7 @@ "type": "object" }, "Documentation": { -"description": "`Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... code_snippet_rules: - selector: google.calendar.Calendar.Delete code_snippets: - includes: - github_include: region_tag: calendar_delete code_language: JAVA account: GoogleCloudPlatform project: java-docs-samples file: calendar/delete.java Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation.", +"description": "`Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation.", "id": "Documentation", "properties": { "documentationRootUrl": { @@ -2548,7 +2548,7 @@ "type": "object" }, "HttpRule": { -"description": "gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/{name=messages/*}\" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: \"messages/123456\")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:\"/v1/messages/{message_id}\" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A¶m=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"message\" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" message { text: \"Hi!\" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"*\" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" text: \"Hi!\")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/messages/{message_id}\" additional_bindings { get: \"/v1/users/{user_id}/messages/{message_id}\" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: \"123456\")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: \"me\" message_id: \"123456\")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is \"*\", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = \"/\" Segments [ Verb ] ; Segments = Segment { \"/\" Segment } ; Segment = \"*\" | \"**\" | LITERAL | Variable ; Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ; FieldPath = IDENT { \".\" IDENT } ; Verb = \":\" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `\"{var}\"` or `\"{var=*}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `\"{var=foo/*}\"` or `\"{var=**}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except \"%2F\" and \"%2f\" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. Example below selects a gRPC method and applies HttpRule to it. http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading \"/\" character. The reason is that the most common use case \"{var}\" does not capture the leading \"/\" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature.", +"description": "gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/{name=messages/*}\" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: \"messages/123456\")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:\"/v1/messages/{message_id}\" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A¶m=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"message\" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" message { text: \"Hi!\" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"*\" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" text: \"Hi!\")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/messages/{message_id}\" additional_bindings { get: \"/v1/users/{user_id}/messages/{message_id}\" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: \"123456\")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: \"me\" message_id: \"123456\")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is \"*\", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = \"/\" Segments [ Verb ] ; Segments = Segment { \"/\" Segment } ; Segment = \"*\" | \"**\" | LITERAL | Variable ; Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ; FieldPath = IDENT { \".\" IDENT } ; Verb = \":\" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `\"{var}\"` or `\"{var=*}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `\"{var=foo/*}\"` or `\"{var=**}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except \"%2F\" and \"%2f\" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. The following example selects a gRPC method and applies an `HttpRule` to it: http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading \"/\" character. The reason is that the most common use case \"{var}\" does not capture the leading \"/\" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature.", "id": "HttpRule", "properties": { "additionalBindings": { diff --git a/googleapiclient/discovery_cache/documents/sheets.v4.json b/googleapiclient/discovery_cache/documents/sheets.v4.json index 82c73538f44..af821143257 100644 --- a/googleapiclient/discovery_cache/documents/sheets.v4.json +++ b/googleapiclient/discovery_cache/documents/sheets.v4.json @@ -870,7 +870,7 @@ } } }, -"revision": "20240708", +"revision": "20240716", "rootUrl": "https://sheets.googleapis.com/", "schemas": { "AddBandingRequest": { @@ -3699,6 +3699,10 @@ "$ref": "BigQueryDataSourceSpec", "description": "A BigQueryDataSourceSpec." }, +"looker": { +"$ref": "LookerDataSourceSpec", +"description": "A LookerDatasourceSpec." +}, "parameters": { "description": "The parameters of the data source, used when querying the data source.", "items": { @@ -5123,6 +5127,25 @@ }, "type": "object" }, +"LookerDataSourceSpec": { +"description": "The specification of a Looker data source.", +"id": "LookerDataSourceSpec", +"properties": { +"explore": { +"description": "Name of a LookerML model explore.", +"type": "string" +}, +"instanceUri": { +"description": "A Looker instance URL.", +"type": "string" +}, +"model": { +"description": "Name of a LookerML model.", +"type": "string" +} +}, +"type": "object" +}, "ManualRule": { "description": "Allows you to manually organize the values in a source data column into buckets with names of your choosing. For example, a pivot table that aggregates population by state: +-------+-------------------+ | State | SUM of Population | +-------+-------------------+ | AK | 0.7 | | AL | 4.8 | | AR | 2.9 | ... +-------+-------------------+ could be turned into a pivot table that aggregates population by time zone by providing a list of groups (for example, groupName = 'Central', items = ['AL', 'AR', 'IA', ...]) to a manual group rule. Note that a similar effect could be achieved by adding a time zone column to the source data and adjusting the pivot table. +-----------+-------------------+ | Time Zone | SUM of Population | +-----------+-------------------+ | Central | 106.3 | | Eastern | 151.9 | | Mountain | 17.4 | ... +-----------+-------------------+", "id": "ManualRule", diff --git a/googleapiclient/discovery_cache/documents/spanner.v1.json b/googleapiclient/discovery_cache/documents/spanner.v1.json index 46226e4ea87..e6a551a8c8e 100644 --- a/googleapiclient/discovery_cache/documents/spanner.v1.json +++ b/googleapiclient/discovery_cache/documents/spanner.v1.json @@ -1806,6 +1806,92 @@ "resources": { "backupSchedules": { "methods": { +"create": { +"description": "Creates a new backup schedule.", +"flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/backupSchedules", +"httpMethod": "POST", +"id": "spanner.projects.instances.databases.backupSchedules.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"backupScheduleId": { +"description": "Required. The Id to use for the backup schedule. The `backup_schedule_id` appended to `parent` forms the full backup schedule name of the form `projects//instances//databases//backupSchedules/`.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The name of the database that this backup schedule applies to.", +"location": "path", +"pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/backupSchedules", +"request": { +"$ref": "BackupSchedule" +}, +"response": { +"$ref": "BackupSchedule" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/spanner.admin" +] +}, +"delete": { +"description": "Deletes a backup schedule.", +"flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/backupSchedules/{backupSchedulesId}", +"httpMethod": "DELETE", +"id": "spanner.projects.instances.databases.backupSchedules.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the schedule to delete. Values are of the form `projects//instances//databases//backupSchedules/`.", +"location": "path", +"pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/backupSchedules/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/spanner.admin" +] +}, +"get": { +"description": "Gets backup schedule for the input schedule name.", +"flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/backupSchedules/{backupSchedulesId}", +"httpMethod": "GET", +"id": "spanner.projects.instances.databases.backupSchedules.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the schedule to retrieve. Values are of the form `projects//instances//databases//backupSchedules/`.", +"location": "path", +"pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/backupSchedules/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "BackupSchedule" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/spanner.admin" +] +}, "getIamPolicy": { "description": "Gets the access control policy for a database or backup resource. Returns an empty policy if a database or backup exists but does not have a policy set. Authorization requires `spanner.databases.getIamPolicy` permission on resource. For backups, authorization requires `spanner.backups.getIamPolicy` permission on resource.", "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/backupSchedules/{backupSchedulesId}:getIamPolicy", @@ -1835,6 +1921,78 @@ "https://www.googleapis.com/auth/spanner.admin" ] }, +"list": { +"description": "Lists all the backup schedules for the database.", +"flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/backupSchedules", +"httpMethod": "GET", +"id": "spanner.projects.instances.databases.backupSchedules.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Optional. Number of backup schedules to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. If non-empty, `page_token` should contain a next_page_token from a previous ListBackupSchedulesResponse to the same `parent`.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Database is the parent resource whose backup schedules should be listed. Values are of the form projects//instances//databases/", +"location": "path", +"pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/backupSchedules", +"response": { +"$ref": "ListBackupSchedulesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/spanner.admin" +] +}, +"patch": { +"description": "Updates a backup schedule.", +"flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/backupSchedules/{backupSchedulesId}", +"httpMethod": "PATCH", +"id": "spanner.projects.instances.databases.backupSchedules.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. Output only for the CreateBackupSchedule operation. Required for the UpdateBackupSchedule operation. A globally unique identifier for the backup schedule which cannot be changed. Values are of the form `projects//instances//databases//backupSchedules/a-z*[a-z0-9]` The final segment of the name must be between 2 and 60 characters in length.", +"location": "path", +"pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/backupSchedules/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Required. A mask specifying which fields in the BackupSchedule resource should be updated. This mask is relative to the BackupSchedule resource, not to the request message. The field mask must always be specified; this prevents any future fields from being erased accidentally.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}", +"request": { +"$ref": "BackupSchedule" +}, +"response": { +"$ref": "BackupSchedule" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/spanner.admin" +] +}, "setIamPolicy": { "description": "Sets the access control policy on a database or backup resource. Replaces any existing policy. Authorization requires `spanner.databases.setIamPolicy` permission on resource. For backups, authorization requires `spanner.backups.setIamPolicy` permission on resource.", "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/backupSchedules/{backupSchedulesId}:setIamPolicy", @@ -3096,7 +3254,7 @@ } } }, -"revision": "20240711", +"revision": "20240719", "rootUrl": "https://spanner.googleapis.com/", "schemas": { "AutoscalingConfig": { @@ -3162,6 +3320,14 @@ "description": "A backup of a Cloud Spanner database.", "id": "Backup", "properties": { +"backupSchedules": { +"description": "Output only. List of backup schedule URIs that are associated with creating this backup. This is only applicable for scheduled backups, and is empty for on-demand backups. To optimize for storage, whenever possible, multiple schedules are collapsed together to create one backup. In such cases, this field captures the list of all backup schedule URIs that are associated with creating this backup. If collapsing is not done, then this field captures the single backup schedule URI associated with creating this backup.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, "createTime": { "description": "Output only. The time the CreateBackup request is received. If the request does not specify `version_time`, the `version_time` of the backup will be equivalent to the `create_time`.", "format": "google-datetime", @@ -3285,6 +3451,51 @@ }, "type": "object" }, +"BackupSchedule": { +"description": "BackupSchedule expresses the automated backup creation specification for a Spanner database. Next ID: 10", +"id": "BackupSchedule", +"properties": { +"encryptionConfig": { +"$ref": "CreateBackupEncryptionConfig", +"description": "Optional. The encryption configuration that will be used to encrypt the backup. If this field is not specified, the backup will use the same encryption configuration as the database." +}, +"fullBackupSpec": { +"$ref": "FullBackupSpec", +"description": "The schedule creates only full backups." +}, +"name": { +"description": "Identifier. Output only for the CreateBackupSchedule operation. Required for the UpdateBackupSchedule operation. A globally unique identifier for the backup schedule which cannot be changed. Values are of the form `projects//instances//databases//backupSchedules/a-z*[a-z0-9]` The final segment of the name must be between 2 and 60 characters in length.", +"type": "string" +}, +"retentionDuration": { +"description": "Optional. The retention duration of a backup that must be at least 6 hours and at most 366 days. The backup is eligible to be automatically deleted once the retention period has elapsed.", +"format": "google-duration", +"type": "string" +}, +"spec": { +"$ref": "BackupScheduleSpec", +"description": "Optional. The schedule specification based on which the backup creations are triggered." +}, +"updateTime": { +"description": "Output only. The timestamp at which the schedule was last updated. If the schedule has never been updated, this field contains the timestamp when the schedule was first created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"BackupScheduleSpec": { +"description": "Defines specifications of the backup schedule.", +"id": "BackupScheduleSpec", +"properties": { +"cronSpec": { +"$ref": "CrontabSpec", +"description": "Cron style schedule specification." +} +}, +"type": "object" +}, "BatchCreateSessionsRequest": { "description": "The request for BatchCreateSessions.", "id": "BatchCreateSessionsRequest", @@ -3642,6 +3853,40 @@ }, "type": "object" }, +"CreateBackupEncryptionConfig": { +"description": "Encryption configuration for the backup to create.", +"id": "CreateBackupEncryptionConfig", +"properties": { +"encryptionType": { +"description": "Required. The encryption type of the backup.", +"enum": [ +"ENCRYPTION_TYPE_UNSPECIFIED", +"USE_DATABASE_ENCRYPTION", +"GOOGLE_DEFAULT_ENCRYPTION", +"CUSTOMER_MANAGED_ENCRYPTION" +], +"enumDescriptions": [ +"Unspecified. Do not use.", +"Use the same encryption configuration as the database. This is the default option when encryption_config is empty. For example, if the database is using `Customer_Managed_Encryption`, the backup will be using the same Cloud KMS key as the database.", +"Use Google default encryption.", +"Use customer managed encryption. If specified, `kms_key_name` must contain a valid Cloud KMS key." +], +"type": "string" +}, +"kmsKeyName": { +"description": "Optional. The Cloud KMS key that will be used to protect the backup. This field should be set only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`.", +"type": "string" +}, +"kmsKeyNames": { +"description": "Optional. Specifies the KMS configuration for the one or more keys used to protect the backup. Values are of the form `projects//locations//keyRings//cryptoKeys/`. The keys referenced by kms_key_names must fully cover all regions of the backup's instance configuration. Some examples: * For single region instance configs, specify a single regional location KMS key. * For multi-regional instance configs of type GOOGLE_MANAGED, either specify a multi-regional location KMS key or multiple regional location KMS keys that cover all regions in the instance config. * For an instance config of type USER_MANAGED, please specify only regional location KMS keys to cover each region in the instance config. Multi-regional location KMS keys are not supported for USER_MANAGED instance configs.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "CreateBackupMetadata": { "description": "Metadata type for the operation returned by CreateBackup.", "id": "CreateBackupMetadata", @@ -3864,6 +4109,28 @@ }, "type": "object" }, +"CrontabSpec": { +"description": "CrontabSpec can be used to specify the version time and frequency at which the backup should be created.", +"id": "CrontabSpec", +"properties": { +"creationWindow": { +"description": "Output only. Schedule backups will contain an externally consistent copy of the database at the version time specified in `schedule_spec.cron_spec`. However, Spanner may not initiate the creation of the scheduled backups at that version time. Spanner will initiate the creation of scheduled backups within the time window bounded by the version_time specified in `schedule_spec.cron_spec` and version_time + `creation_window`.", +"format": "google-duration", +"readOnly": true, +"type": "string" +}, +"text": { +"description": "Required. Textual representation of the crontab. User can customize the backup frequency and the backup version time using the cron expression. The version time must be in UTC timzeone. The backup will contain an externally consistent copy of the database at the version time. Allowed frequencies are 12 hour, 1 day, 1 week and 1 month. Examples of valid cron specifications: * `0 2/12 * * * ` : every 12 hours at (2, 14) hours past midnight in UTC. * `0 2,14 * * * ` : every 12 hours at (2,14) hours past midnight in UTC. * `0 2 * * * ` : once a day at 2 past midnight in UTC. * `0 2 * * 0 ` : once a week every Sunday at 2 past midnight in UTC. * `0 2 8 * * ` : once a month on 8th day at 2 past midnight in UTC.", +"type": "string" +}, +"timeZone": { +"description": "Output only. The time zone of the times in `CrontabSpec.text`. Currently only UTC is supported.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "Database": { "description": "A Cloud Spanner database.", "id": "Database", @@ -4347,6 +4614,12 @@ }, "type": "object" }, +"FullBackupSpec": { +"description": "The specification for full backups. A full backup stores the entire contents of the database at a given version time.", +"id": "FullBackupSpec", +"properties": {}, +"type": "object" +}, "GetDatabaseDdlResponse": { "description": "The response for GetDatabaseDdl.", "id": "GetDatabaseDdlResponse", @@ -4925,6 +5198,24 @@ }, "type": "object" }, +"ListBackupSchedulesResponse": { +"description": "The response for ListBackupSchedules.", +"id": "ListBackupSchedulesResponse", +"properties": { +"backupSchedules": { +"description": "The list of backup schedules for a database.", +"items": { +"$ref": "BackupSchedule" +}, +"type": "array" +}, +"nextPageToken": { +"description": "`next_page_token` can be sent in a subsequent ListBackupSchedules call to fetch more of the schedules.", +"type": "string" +} +}, +"type": "object" +}, "ListBackupsResponse": { "description": "The response for ListBackups.", "id": "ListBackupsResponse", diff --git a/googleapiclient/discovery_cache/documents/sqladmin.v1.json b/googleapiclient/discovery_cache/documents/sqladmin.v1.json index a687fd07d88..24837b3673f 100644 --- a/googleapiclient/discovery_cache/documents/sqladmin.v1.json +++ b/googleapiclient/discovery_cache/documents/sqladmin.v1.json @@ -644,7 +644,7 @@ ] }, "addServerCa": { -"description": "Adds a new trusted Certificate Authority (CA) version for the specified instance. Required to prepare for a certificate rotation. If a CA version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one CA version waiting to be rotated in.", +"description": "Adds a new trusted Certificate Authority (CA) version for the specified instance. Required to prepare for a certificate rotation. If a CA version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one CA version waiting to be rotated in. For instances that have enabled Certificate Authority Service (CAS) based server CA, please use AddServerCertificate to add a new server certificate.", "flatPath": "v1/projects/{project}/instances/{instance}/addServerCa", "httpMethod": "POST", "id": "sql.instances.addServerCa", @@ -1287,7 +1287,7 @@ ] }, "rotateServerCa": { -"description": "Rotates the server certificate to one signed by the Certificate Authority (CA) version previously added with the addServerCA method.", +"description": "Rotates the server certificate to one signed by the Certificate Authority (CA) version previously added with the addServerCA method. For instances that have enabled Certificate Authority Service (CAS) based server CA, please use RotateServerCertificate to rotate the server certificate.", "flatPath": "v1/projects/{project}/instances/{instance}/rotateServerCa", "httpMethod": "POST", "id": "sql.instances.rotateServerCa", @@ -2267,7 +2267,7 @@ } } }, -"revision": "20240622", +"revision": "20240711", "rootUrl": "https://sqladmin.googleapis.com/", "schemas": { "AclEntry": { @@ -2915,6 +2915,20 @@ false "serverCaCert": { "$ref": "SslCert", "description": "SSL configuration." +}, +"serverCaMode": { +"description": "Specify what type of CA is used for the server certificate.", +"enum": [ +"CA_MODE_UNSPECIFIED", +"GOOGLE_MANAGED_INTERNAL_CA", +"GOOGLE_MANAGED_CAS_CA" +], +"enumDescriptions": [ +"CA mode is unknown.", +"Google-managed self-signed internal CA.", +"Google-managed regional CA part of root CA hierarchy hosted on Google Cloud's Certificate Authority Service (CAS)." +], +"type": "string" } }, "type": "object" @@ -3415,6 +3429,10 @@ true }, "type": "array" }, +"switchTransactionLogsToCloudStorageEnabled": { +"description": "Input only. Whether Cloud SQL is enabled to switch storing point-in-time recovery log files from a data disk to Cloud Storage.", +"type": "boolean" +}, "upgradableDatabaseVersions": { "description": "Output only. All database versions that are available for upgrade.", "items": { @@ -4490,6 +4508,20 @@ false "description": "Use `ssl_mode` instead. Whether SSL/TLS connections over IP are enforced. If set to false, then allow both non-SSL/non-TLS and SSL/TLS connections. For SSL/TLS connections, the client certificate won't be verified. If set to true, then only allow connections encrypted with SSL/TLS and with valid client certificates. If you want to enforce SSL/TLS without enforcing the requirement for valid client certificates, then use the `ssl_mode` flag instead of the `require_ssl` flag.", "type": "boolean" }, +"serverCaMode": { +"description": "Specify what type of CA is used for the server certificate.", +"enum": [ +"CA_MODE_UNSPECIFIED", +"GOOGLE_MANAGED_INTERNAL_CA", +"GOOGLE_MANAGED_CAS_CA" +], +"enumDescriptions": [ +"CA mode is unknown.", +"Google-managed self-signed internal CA.", +"Google-managed regional CA part of root CA hierarchy hosted on Google Cloud's Certificate Authority Service (CAS)." +], +"type": "string" +}, "sslMode": { "description": "Specify how SSL/TLS is enforced in database connections. If you must use the `require_ssl` flag for backward compatibility, then only the following value pairs are valid: For PostgreSQL and MySQL: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false` * `ssl_mode=TRUSTED_CLIENT_CERTIFICATE_REQUIRED` and `require_ssl=true` For SQL Server: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=true` The value of `ssl_mode` has priority over the value of `require_ssl`. For example, for the pair `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false`, `ssl_mode=ENCRYPTED_ONLY` means accept only SSL connections, while `require_ssl=false` means accept both non-SSL and SSL connections. In this case, MySQL and PostgreSQL databases respect `ssl_mode` and accepts only SSL connections.", "enum": [ @@ -4807,7 +4839,8 @@ false "RECONFIGURE_OLD_PRIMARY", "CLUSTER_MAINTENANCE", "SELF_SERVICE_MAINTENANCE", -"SWITCHOVER_TO_REPLICA" +"SWITCHOVER_TO_REPLICA", +"MAJOR_VERSION_UPGRADE" ], "enumDeprecated": [ false, @@ -4854,6 +4887,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -4901,7 +4935,8 @@ false "Reconfigures old primary after a promote replica operation. Effect of a promote operation to the old primary is executed in this operation, asynchronously from the promote replica operation executed to the replica.", "Indicates that the instance, its read replicas, and its cascading replicas are in maintenance. Maintenance typically gets initiated on groups of replicas first, followed by the primary instance. For each instance, maintenance typically causes the instance to be unavailable for 1-3 minutes.", "Indicates that the instance (and any of its replicas) are currently in maintenance. This is initiated as a self-service request by using SSM. Maintenance typically causes the instance to be unavailable for 1-3 minutes.", -"Switches a primary instance to a replica. This operation runs as part of a switchover operation to the original primary instance." +"Switches a primary instance to a replica. This operation runs as part of a switchover operation to the original primary instance.", +"Updates the major version of a Cloud SQL instance." ], "type": "string" }, @@ -5579,7 +5614,8 @@ true "UNSUPPORTED_EXTENSIONS_NOT_MIGRATED", "EXTENSIONS_NOT_MIGRATED", "PG_CRON_FLAG_ENABLED_IN_REPLICA", -"EXTENSIONS_NOT_ENABLED_IN_REPLICA" +"EXTENSIONS_NOT_ENABLED_IN_REPLICA", +"UNSUPPORTED_COLUMNS" ], "enumDescriptions": [ "", @@ -5630,7 +5666,8 @@ true "The warning message indicates the unsupported extensions will not be migrated to the destination.", "The warning message indicates the pg_cron extension and settings will not be migrated to the destination.", "The error message indicates that pg_cron flags are enabled on the destination which is not supported during the migration.", -"This error message indicates that the specified extensions are not enabled on destination instance. For example, before you can migrate data to the destination instance, you must enable the PGAudit extension on the instance." +"This error message indicates that the specified extensions are not enabled on destination instance. For example, before you can migrate data to the destination instance, you must enable the PGAudit extension on the instance.", +"The source database has generated columns that can't be migrated. Please change them to regular columns before migration." ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json b/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json index 4ca895ae430..acc6d6950ac 100644 --- a/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json +++ b/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json @@ -644,7 +644,7 @@ ] }, "addServerCa": { -"description": "Add a new trusted Certificate Authority (CA) version for the specified instance. Required to prepare for a certificate rotation. If a CA version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one CA version waiting to be rotated in.", +"description": "Add a new trusted Certificate Authority (CA) version for the specified instance. Required to prepare for a certificate rotation. If a CA version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one CA version waiting to be rotated in. For instances that have enabled Certificate Authority Service (CAS) based server CA, please use AddServerCertificate to add a new server certificate.", "flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/addServerCa", "httpMethod": "POST", "id": "sql.instances.addServerCa", @@ -1287,7 +1287,7 @@ ] }, "rotateServerCa": { -"description": "Rotates the server certificate to one signed by the Certificate Authority (CA) version previously added with the addServerCA method.", +"description": "Rotates the server certificate to one signed by the Certificate Authority (CA) version previously added with the addServerCA method. For instances that have enabled Certificate Authority Service (CAS) based server CA, please use RotateServerCertificate to rotate the server certificate.", "flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/rotateServerCa", "httpMethod": "POST", "id": "sql.instances.rotateServerCa", @@ -2267,7 +2267,7 @@ } } }, -"revision": "20240622", +"revision": "20240711", "rootUrl": "https://sqladmin.googleapis.com/", "schemas": { "AclEntry": { @@ -2915,6 +2915,20 @@ false "serverCaCert": { "$ref": "SslCert", "description": "SSL configuration." +}, +"serverCaMode": { +"description": "Specify what type of CA is used for the server certificate.", +"enum": [ +"CA_MODE_UNSPECIFIED", +"GOOGLE_MANAGED_INTERNAL_CA", +"GOOGLE_MANAGED_CAS_CA" +], +"enumDescriptions": [ +"CA mode is unknown.", +"Google-managed self-signed internal CA.", +"Google-managed regional CA part of root CA hierarchy hosted on Google Cloud's Certificate Authority Service (CAS)." +], +"type": "string" } }, "type": "object" @@ -3416,6 +3430,10 @@ true }, "type": "array" }, +"switchTransactionLogsToCloudStorageEnabled": { +"description": "Input only. Whether Cloud SQL is enabled to switch storing point-in-time recovery log files from a data disk to Cloud Storage.", +"type": "boolean" +}, "upgradableDatabaseVersions": { "description": "Output only. All database versions that are available for upgrade.", "items": { @@ -4491,6 +4509,20 @@ false "description": "Use `ssl_mode` instead. Whether SSL/TLS connections over IP are enforced. If set to false, then allow both non-SSL/non-TLS and SSL/TLS connections. For SSL/TLS connections, the client certificate won't be verified. If set to true, then only allow connections encrypted with SSL/TLS and with valid client certificates. If you want to enforce SSL/TLS without enforcing the requirement for valid client certificates, then use the `ssl_mode` flag instead of the legacy `require_ssl` flag.", "type": "boolean" }, +"serverCaMode": { +"description": "Specify what type of CA is used for the server certificate.", +"enum": [ +"CA_MODE_UNSPECIFIED", +"GOOGLE_MANAGED_INTERNAL_CA", +"GOOGLE_MANAGED_CAS_CA" +], +"enumDescriptions": [ +"CA mode is unknown.", +"Google-managed self-signed internal CA.", +"Google-managed regional CA part of root CA hierarchy hosted on Google Cloud's Certificate Authority Service (CAS)." +], +"type": "string" +}, "sslMode": { "description": "Specify how SSL/TLS is enforced in database connections. If you must use the `require_ssl` flag for backward compatibility, then only the following value pairs are valid: For PostgreSQL and MySQL: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false` * `ssl_mode=TRUSTED_CLIENT_CERTIFICATE_REQUIRED` and `require_ssl=true` For SQL Server: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=true` The value of `ssl_mode` has priority over the value of `require_ssl`. For example, for the pair `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false`, `ssl_mode=ENCRYPTED_ONLY` means accept only SSL connections, while `require_ssl=false` means accept both non-SSL and SSL connections. In this case, MySQL and PostgreSQL databases respect `ssl_mode` and accepts only SSL connections.", "enum": [ @@ -4808,7 +4840,8 @@ false "RECONFIGURE_OLD_PRIMARY", "CLUSTER_MAINTENANCE", "SELF_SERVICE_MAINTENANCE", -"SWITCHOVER_TO_REPLICA" +"SWITCHOVER_TO_REPLICA", +"MAJOR_VERSION_UPGRADE" ], "enumDeprecated": [ false, @@ -4855,6 +4888,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -4902,7 +4936,8 @@ false "Reconfigures old primary after a promote replica operation. Effect of a promote operation to the old primary is executed in this operation, asynchronously from the promote replica operation executed to the replica.", "Indicates that the instance, its read replicas, and its cascading replicas are in maintenance. Maintenance typically gets initiated on groups of replicas first, followed by the primary instance. For each instance, maintenance typically causes the instance to be unavailable for 1-3 minutes.", "Indicates that the instance (and any of its replicas) are currently in maintenance. This is initiated as a self-service request by using SSM. Maintenance typically causes the instance to be unavailable for 1-3 minutes.", -"Switches a primary instance to a replica. This operation runs as part of a switchover operation to the original primary instance." +"Switches a primary instance to a replica. This operation runs as part of a switchover operation to the original primary instance.", +"Updates the major version of a Cloud SQL instance." ], "type": "string" }, @@ -5580,7 +5615,8 @@ true "UNSUPPORTED_EXTENSIONS_NOT_MIGRATED", "EXTENSIONS_NOT_MIGRATED", "PG_CRON_FLAG_ENABLED_IN_REPLICA", -"EXTENSIONS_NOT_ENABLED_IN_REPLICA" +"EXTENSIONS_NOT_ENABLED_IN_REPLICA", +"UNSUPPORTED_COLUMNS" ], "enumDescriptions": [ "", @@ -5631,7 +5667,8 @@ true "The warning message indicates the unsupported extensions will not be migrated to the destination.", "The warning message indicates the pg_cron extension and settings will not be migrated to the destination.", "The error message indicates that pg_cron flags are enabled on the destination which is not supported during the migration.", -"This error message indicates that the specified extensions are not enabled on destination instance. For example, before you can migrate data to the destination instance, you must enable the PGAudit extension on the instance." +"This error message indicates that the specified extensions are not enabled on destination instance. For example, before you can migrate data to the destination instance, you must enable the PGAudit extension on the instance.", +"The source database has generated columns that can't be migrated. Please change them to regular columns before migration." ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/translate.v3.json b/googleapiclient/discovery_cache/documents/translate.v3.json index 70e8060f012..57fae60cd57 100644 --- a/googleapiclient/discovery_cache/documents/translate.v3.json +++ b/googleapiclient/discovery_cache/documents/translate.v3.json @@ -1260,7 +1260,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-translation" ] } }, @@ -1395,7 +1396,7 @@ ], "parameters": { "name": { -"description": "Required. The resource name of the entry. Format: \"projects/*/locations/*/glossaries/*/glossaryEntries/*\"", +"description": "Identifier. The resource name of the entry. Format: \"projects/*/locations/*/glossaries/*/glossaryEntries/*\"", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/glossaries/[^/]+/glossaryEntries/[^/]+$", "required": true, @@ -1706,7 +1707,7 @@ } } }, -"revision": "20240301", +"revision": "20240718", "rootUrl": "https://translation.googleapis.com/", "schemas": { "AdaptiveMtDataset": { @@ -1817,7 +1818,7 @@ "id": "AdaptiveMtTranslateRequest", "properties": { "content": { -"description": "Required. The content of the input in string format. For now only one sentence per request is supported.", +"description": "Required. The content of the input in string format.", "items": { "type": "string" }, @@ -1826,6 +1827,14 @@ "dataset": { "description": "Required. The resource name for the dataset to use for adaptive MT. `projects/{project}/locations/{location-id}/adaptiveMtDatasets/{dataset}`", "type": "string" +}, +"glossaryConfig": { +"$ref": "TranslateTextGlossaryConfig", +"description": "Optional. Glossary to be applied. The glossary must be within the same region (have the same location-id) as the model, otherwise an INVALID_ARGUMENT (400) error is returned." +}, +"referenceSentenceConfig": { +"$ref": "ReferenceSentenceConfig", +"description": "Configuration for caller provided reference sentences." } }, "type": "object" @@ -1834,6 +1843,13 @@ "description": "An AdaptiveMtTranslate response.", "id": "AdaptiveMtTranslateResponse", "properties": { +"glossaryTranslations": { +"description": "Text translation response if a glossary is provided in the request. This could be the same as 'translation' above if no terms apply.", +"items": { +"$ref": "AdaptiveMtTranslation" +}, +"type": "array" +}, "languageCode": { "description": "Output only. The translation's language code.", "readOnly": true, @@ -2360,7 +2376,7 @@ "type": "string" }, "name": { -"description": "Required. The resource name of the entry. Format: \"projects/*/locations/*/glossaries/*/glossaryEntries/*\"", +"description": "Identifier. The resource name of the entry. Format: \"projects/*/locations/*/glossaries/*/glossaryEntries/*\"", "type": "string" }, "termsPair": { @@ -2848,6 +2864,57 @@ }, "type": "object" }, +"ReferenceSentenceConfig": { +"description": "Message of caller-provided reference configuration.", +"id": "ReferenceSentenceConfig", +"properties": { +"referenceSentencePairLists": { +"description": "Reference sentences pair lists. Each list will be used as the references to translate the sentence under \"content\" field at the corresponding index. Length of the list is required to be equal to the length of \"content\" field.", +"items": { +"$ref": "ReferenceSentencePairList" +}, +"type": "array" +}, +"sourceLanguageCode": { +"description": "Source language code.", +"type": "string" +}, +"targetLanguageCode": { +"description": "Target language code.", +"type": "string" +} +}, +"type": "object" +}, +"ReferenceSentencePair": { +"description": "A pair of sentences used as reference in source and target languages.", +"id": "ReferenceSentencePair", +"properties": { +"sourceSentence": { +"description": "Source sentence in the sentence pair.", +"type": "string" +}, +"targetSentence": { +"description": "Target sentence in the sentence pair.", +"type": "string" +} +}, +"type": "object" +}, +"ReferenceSentencePairList": { +"description": "A list of reference sentence pairs.", +"id": "ReferenceSentencePairList", +"properties": { +"referenceSentencePairs": { +"description": "Reference sentence pairs.", +"items": { +"$ref": "ReferenceSentencePair" +}, +"type": "array" +} +}, +"type": "object" +}, "Romanization": { "description": "A single romanization response.", "id": "Romanization", @@ -3078,7 +3145,7 @@ "type": "string" }, "model": { -"description": "Optional. The `model` type requested for this translation. The format depends on model type: - AutoML Translation models: `projects/{project-number-or-id}/locations/{location-id}/models/{model-id}` - General (built-in) models: `projects/{project-number-or-id}/locations/{location-id}/models/general/nmt`, For global (non-regionalized) requests, use `location-id` `global`. For example, `projects/{project-number-or-id}/locations/global/models/general/nmt`. If not provided, the default Google model (NMT) will be used", +"description": "Optional. The `model` type requested for this translation. The format depends on model type: - AutoML Translation models: `projects/{project-number-or-id}/locations/{location-id}/models/{model-id}` - General (built-in) models: `projects/{project-number-or-id}/locations/{location-id}/models/general/nmt`, - Translation LLM models: `projects/{project-number-or-id}/locations/{location-id}/models/general/translation-llm`, For global (non-regionalized) requests, use `location-id` `global`. For example, `projects/{project-number-or-id}/locations/global/models/general/nmt`. If not provided, the default Google model (NMT) will be used", "type": "string" }, "sourceLanguageCode": { diff --git a/googleapiclient/discovery_cache/documents/vmmigration.v1.json b/googleapiclient/discovery_cache/documents/vmmigration.v1.json index 07fa8a94517..4473bd21aca 100644 --- a/googleapiclient/discovery_cache/documents/vmmigration.v1.json +++ b/googleapiclient/discovery_cache/documents/vmmigration.v1.json @@ -2280,7 +2280,7 @@ } } }, -"revision": "20240704", +"revision": "20240712", "rootUrl": "https://vmmigration.googleapis.com/", "schemas": { "AccessKeyCredentials": { @@ -4056,6 +4056,10 @@ "$ref": "Encryption", "description": "Immutable. The encryption details used by the image import process during the image adaptation for Compute Engine." }, +"machineImageTargetDefaults": { +"$ref": "MachineImageTargetDetails", +"description": "Immutable. Target details for importing a machine image, will be used by ImageImportJob." +}, "name": { "description": "Output only. The resource path of the ImageImport.", "readOnly": true, @@ -4114,6 +4118,11 @@ "readOnly": true, "type": "array" }, +"machineImageTargetDetails": { +"$ref": "MachineImageTargetDetails", +"description": "Output only. Target details used to import a machine image.", +"readOnly": true +}, "name": { "description": "Output only. The resource path of the ImageImportJob.", "readOnly": true, @@ -4653,6 +4662,92 @@ }, "type": "object" }, +"MachineImageParametersOverrides": { +"description": "Parameters overriding decisions based on the source machine image configurations.", +"id": "MachineImageParametersOverrides", +"properties": { +"machineType": { +"description": "Optional. The machine type to create the MachineImage with. If empty, the service will choose a relevant machine type based on the information from the source image. For more information about machine types, please refer to https://cloud.google.com/compute/docs/machine-resource.", +"type": "string" +} +}, +"type": "object" +}, +"MachineImageTargetDetails": { +"description": "The target details of the machine image resource that will be created by the image import job.", +"id": "MachineImageTargetDetails", +"properties": { +"additionalLicenses": { +"description": "Optional. Additional licenses to assign to the instance created by the machine image. Format: https://www.googleapis.com/compute/v1/projects/PROJECT_ID/global/licenses/LICENSE_NAME Or https://www.googleapis.com/compute/beta/projects/PROJECT_ID/global/licenses/LICENSE_NAME", +"items": { +"type": "string" +}, +"type": "array" +}, +"description": { +"description": "Optional. An optional description of the machine image.", +"type": "string" +}, +"encryption": { +"$ref": "Encryption", +"description": "Immutable. The encryption to apply to the machine image." +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. The labels to apply to the instance created by the machine image.", +"type": "object" +}, +"machineImageName": { +"description": "Required. The name of the machine image to be created.", +"type": "string" +}, +"machineImageParametersOverrides": { +"$ref": "MachineImageParametersOverrides", +"description": "Optional. Parameters overriding decisions based on the source machine image configurations." +}, +"networkInterfaces": { +"description": "Optional. The network interfaces to create with the instance created by the machine image. Internal and external IP addresses are ignored for machine image import.", +"items": { +"$ref": "NetworkInterface" +}, +"type": "array" +}, +"osAdaptationParameters": { +"$ref": "ImageImportOsAdaptationParameters", +"description": "Optional. Use to set the parameters relevant for the OS adaptation process." +}, +"serviceAccount": { +"$ref": "ServiceAccount", +"description": "Optional. The service account to assign to the instance created by the machine image." +}, +"shieldedInstanceConfig": { +"$ref": "ShieldedInstanceConfig", +"description": "Optional. Shielded instance configuration." +}, +"singleRegionStorage": { +"description": "Optional. Set to true to set the machine image storageLocations to the single region of the import job. When false, the closest multi-region is selected.", +"type": "boolean" +}, +"skipOsAdaptation": { +"$ref": "SkipOsAdaptation", +"description": "Optional. Use to skip OS adaptation process." +}, +"tags": { +"description": "Optional. The tags to apply to the instance created by the machine image.", +"items": { +"type": "string" +}, +"type": "array" +}, +"targetProject": { +"description": "Required. Reference to the TargetProject resource that represents the target project in which the imported machine image will be created.", +"type": "string" +} +}, +"type": "object" +}, "MigratingVm": { "description": "MigratingVm describes the VM that will be migrated from a Source environment and its replication state.", "id": "MigratingVm", @@ -4945,6 +5040,20 @@ "description": "The network to connect the NIC to.", "type": "string" }, +"networkTier": { +"description": "Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM.", +"enum": [ +"COMPUTE_ENGINE_NETWORK_TIER_UNSPECIFIED", +"NETWORK_TIER_STANDARD", +"NETWORK_TIER_PREMIUM" +], +"enumDescriptions": [ +"An unspecified network tier. Will be used as PREMIUM.", +"A standard network tier.", +"A premium network tier." +], +"type": "string" +}, "subnetwork": { "description": "Optional. The subnetwork to connect the NIC to.", "type": "string" @@ -5342,12 +5451,65 @@ }, "type": "object" }, +"ServiceAccount": { +"description": "Service account to assign to the instance created by the machine image.", +"id": "ServiceAccount", +"properties": { +"email": { +"description": "Required. The email address of the service account.", +"type": "string" +}, +"scopes": { +"description": "Optional. The list of scopes to be made available for this service account.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"ShieldedInstanceConfig": { +"description": "Shielded instance configuration.", +"id": "ShieldedInstanceConfig", +"properties": { +"enableIntegrityMonitoring": { +"description": "Optional. Defines whether the instance created by the machine image has integrity monitoring enabled. This can be set to true only if the image boot option is EFI, and vTPM is enabled.", +"type": "boolean" +}, +"enableVtpm": { +"description": "Optional. Defines whether the instance created by the machine image has vTPM enabled. This can be set to true only if the image boot option is EFI.", +"type": "boolean" +}, +"secureBoot": { +"description": "Optional. Defines whether the instance created by the machine image has Secure Boot enabled. This can be set to true only if the image boot option is EFI.", +"enum": [ +"SECURE_BOOT_UNSPECIFIED", +"TRUE", +"FALSE" +], +"enumDescriptions": [ +"No explicit value is selected. Will use the configuration of the source (if exists, otherwise the default will be false).", +"Use secure boot. This can be set to true only if the image boot option is EFI.", +"Do not use secure boot." +], +"type": "string" +} +}, +"type": "object" +}, "ShuttingDownSourceVMStep": { "description": "ShuttingDownSourceVMStep contains specific step details.", "id": "ShuttingDownSourceVMStep", "properties": {}, "type": "object" }, +"SkipOsAdaptation": { +"description": "Mentions that the machine image import is not using OS adaptation process.", +"id": "SkipOsAdaptation", +"properties": {}, +"type": "object" +}, "Source": { "description": "Source message describes a specific vm migration Source resource. It contains the source environment information.", "id": "Source", diff --git a/googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json b/googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json index 405791e82e9..59fa75be3ab 100644 --- a/googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json @@ -2280,7 +2280,7 @@ } } }, -"revision": "20240704", +"revision": "20240712", "rootUrl": "https://vmmigration.googleapis.com/", "schemas": { "AccessKeyCredentials": { @@ -4091,6 +4091,10 @@ "$ref": "Encryption", "description": "Immutable. The encryption details used by the image import process during the image adaptation for Compute Engine." }, +"machineImageTargetDefaults": { +"$ref": "MachineImageTargetDetails", +"description": "Immutable. Target details for importing a machine image, will be used by ImageImportJob." +}, "name": { "description": "Output only. The resource path of the ImageImport.", "readOnly": true, @@ -4149,6 +4153,11 @@ "readOnly": true, "type": "array" }, +"machineImageTargetDetails": { +"$ref": "MachineImageTargetDetails", +"description": "Output only. Target details used to import a machine image.", +"readOnly": true +}, "name": { "description": "Output only. The resource path of the ImageImportJob.", "readOnly": true, @@ -4688,6 +4697,92 @@ }, "type": "object" }, +"MachineImageParametersOverrides": { +"description": "Parameters overriding decisions based on the source machine image configurations.", +"id": "MachineImageParametersOverrides", +"properties": { +"machineType": { +"description": "Optional. The machine type to create the MachineImage with. If empty, the service will choose a relevant machine type based on the information from the source image. For more information about machine types, please refer to https://cloud.google.com/compute/docs/machine-resource.", +"type": "string" +} +}, +"type": "object" +}, +"MachineImageTargetDetails": { +"description": "The target details of the machine image resource that will be created by the image import job.", +"id": "MachineImageTargetDetails", +"properties": { +"additionalLicenses": { +"description": "Optional. Additional licenses to assign to the instance created by the machine image. Format: https://www.googleapis.com/compute/v1/projects/PROJECT_ID/global/licenses/LICENSE_NAME Or https://www.googleapis.com/compute/beta/projects/PROJECT_ID/global/licenses/LICENSE_NAME", +"items": { +"type": "string" +}, +"type": "array" +}, +"description": { +"description": "Optional. An optional description of the machine image.", +"type": "string" +}, +"encryption": { +"$ref": "Encryption", +"description": "Immutable. The encryption to apply to the machine image." +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. The labels to apply to the instance created by the machine image.", +"type": "object" +}, +"machineImageName": { +"description": "Required. The name of the machine image to be created.", +"type": "string" +}, +"machineImageParametersOverrides": { +"$ref": "MachineImageParametersOverrides", +"description": "Optional. Parameters overriding decisions based on the source machine image configurations." +}, +"networkInterfaces": { +"description": "Optional. The network interfaces to create with the instance created by the machine image. Internal and external IP addresses are ignored for machine image import.", +"items": { +"$ref": "NetworkInterface" +}, +"type": "array" +}, +"osAdaptationParameters": { +"$ref": "ImageImportOsAdaptationParameters", +"description": "Optional. Use to set the parameters relevant for the OS adaptation process." +}, +"serviceAccount": { +"$ref": "ServiceAccount", +"description": "Optional. The service account to assign to the instance created by the machine image." +}, +"shieldedInstanceConfig": { +"$ref": "ShieldedInstanceConfig", +"description": "Optional. Shielded instance configuration." +}, +"singleRegionStorage": { +"description": "Optional. Set to true to set the machine image storageLocations to the single region of the import job. When false, the closest multi-region is selected.", +"type": "boolean" +}, +"skipOsAdaptation": { +"$ref": "SkipOsAdaptation", +"description": "Optional. Use to skip OS adaptation process." +}, +"tags": { +"description": "Optional. The tags to apply to the instance created by the machine image.", +"items": { +"type": "string" +}, +"type": "array" +}, +"targetProject": { +"description": "Required. Reference to the TargetProject resource that represents the target project in which the imported machine image will be created.", +"type": "string" +} +}, +"type": "object" +}, "MigratingVm": { "description": "MigratingVm describes the VM that will be migrated from a Source environment and its replication state.", "id": "MigratingVm", @@ -4990,6 +5085,20 @@ "description": "The network to connect the NIC to.", "type": "string" }, +"networkTier": { +"description": "Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM.", +"enum": [ +"COMPUTE_ENGINE_NETWORK_TIER_UNSPECIFIED", +"NETWORK_TIER_STANDARD", +"NETWORK_TIER_PREMIUM" +], +"enumDescriptions": [ +"An unspecified network tier. Will be used as PREMIUM.", +"A standard network tier.", +"A premium network tier." +], +"type": "string" +}, "subnetwork": { "description": "Optional. The subnetwork to connect the NIC to.", "type": "string" @@ -5393,12 +5502,65 @@ }, "type": "object" }, +"ServiceAccount": { +"description": "Service account to assign to the instance created by the machine image.", +"id": "ServiceAccount", +"properties": { +"email": { +"description": "Required. The email address of the service account.", +"type": "string" +}, +"scopes": { +"description": "Optional. The list of scopes to be made available for this service account.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"ShieldedInstanceConfig": { +"description": "Shielded instance configuration.", +"id": "ShieldedInstanceConfig", +"properties": { +"enableIntegrityMonitoring": { +"description": "Optional. Defines whether the instance created by the machine image has integrity monitoring enabled. This can be set to true only if the image boot option is EFI, and vTPM is enabled.", +"type": "boolean" +}, +"enableVtpm": { +"description": "Optional. Defines whether the instance created by the machine image has vTPM enabled. This can be set to true only if the image boot option is EFI.", +"type": "boolean" +}, +"secureBoot": { +"description": "Optional. Defines whether the instance created by the machine image has Secure Boot enabled. This can be set to true only if the image boot option is EFI.", +"enum": [ +"SECURE_BOOT_UNSPECIFIED", +"TRUE", +"FALSE" +], +"enumDescriptions": [ +"No explicit value is selected. Will use the configuration of the source (if exists, otherwise the default will be false).", +"Use secure boot. This can be set to true only if the image boot option is EFI.", +"Do not use secure boot." +], +"type": "string" +} +}, +"type": "object" +}, "ShuttingDownSourceVMStep": { "description": "ShuttingDownSourceVMStep contains specific step details.", "id": "ShuttingDownSourceVMStep", "properties": {}, "type": "object" }, +"SkipOsAdaptation": { +"description": "Mentions that the machine image import is not using OS adaptation process.", +"id": "SkipOsAdaptation", +"properties": {}, +"type": "object" +}, "Source": { "description": "Source message describes a specific vm migration Source resource. It contains the source environment information.", "id": "Source", diff --git a/googleapiclient/discovery_cache/documents/walletobjects.v1.json b/googleapiclient/discovery_cache/documents/walletobjects.v1.json index dd026c6a9cf..1986fab15e8 100644 --- a/googleapiclient/discovery_cache/documents/walletobjects.v1.json +++ b/googleapiclient/discovery_cache/documents/walletobjects.v1.json @@ -2681,7 +2681,7 @@ } } }, -"revision": "20240708", +"revision": "20240723", "rootUrl": "https://walletobjects.googleapis.com/", "schemas": { "ActivationOptions": { @@ -4244,6 +4244,10 @@ true "$ref": "RotatingBarcode", "description": "The rotating barcode type and value." }, +"saveRestrictions": { +"$ref": "SaveRestrictions", +"description": "Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass." +}, "seatInfo": { "$ref": "EventSeat", "description": "Seating details for this ticket." @@ -4662,15 +4666,15 @@ true "description": "Links module data. If links module data is also defined on the object, both will be displayed." }, "localBoardingDateTime": { -"description": "The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources.", +"description": "The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.", "type": "string" }, "localEstimatedOrActualArrivalDateTime": { -"description": "The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources.", +"description": "The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport.", "type": "string" }, "localEstimatedOrActualDepartureDateTime": { -"description": "The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources.", +"description": "The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.", "type": "string" }, "localGateClosingDateTime": { @@ -4678,7 +4682,7 @@ true "type": "string" }, "localScheduledArrivalDateTime": { -"description": "The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources.", +"description": "The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport.", "type": "string" }, "localScheduledDepartureDateTime": { @@ -4985,6 +4989,10 @@ true "$ref": "RotatingBarcode", "description": "The rotating barcode type and value." }, +"saveRestrictions": { +"$ref": "SaveRestrictions", +"description": "Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass." +}, "securityProgramLogo": { "$ref": "Image", "description": "An image for the security program that applies to the passenger." @@ -5339,6 +5347,10 @@ true "$ref": "RotatingBarcode", "description": "The rotating barcode settings/details." }, +"saveRestrictions": { +"$ref": "SaveRestrictions", +"description": "Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass." +}, "smartTapRedemptionValue": { "description": "The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported.", "type": "string" @@ -5813,6 +5825,10 @@ true "$ref": "RotatingBarcode", "description": "The rotating barcode type and value." }, +"saveRestrictions": { +"$ref": "SaveRestrictions", +"description": "Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass." +}, "smartTapRedemptionValue": { "description": "The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported.", "type": "string" @@ -6637,6 +6653,10 @@ true "$ref": "RotatingBarcode", "description": "The rotating barcode type and value." }, +"saveRestrictions": { +"$ref": "SaveRestrictions", +"description": "Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass." +}, "secondaryLoyaltyPoints": { "$ref": "LoyaltyPoints", "description": "The secondary loyalty reward points label, balance, and type. Shown in addition to the primary loyalty points." @@ -7563,6 +7583,10 @@ true "$ref": "RotatingBarcode", "description": "The rotating barcode type and value." }, +"saveRestrictions": { +"$ref": "SaveRestrictions", +"description": "Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass." +}, "smartTapRedemptionValue": { "description": "The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported.", "type": "string" @@ -8132,6 +8156,17 @@ true }, "type": "object" }, +"SaveRestrictions": { +"description": "Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support.", +"id": "SaveRestrictions", +"properties": { +"restrictToEmailSha256": { +"description": "Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like \".\" or \"+\", except \"@\". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions.", +"type": "string" +} +}, +"type": "object" +}, "SecurityAnimation": { "id": "SecurityAnimation", "properties": { @@ -8994,6 +9029,10 @@ true "$ref": "RotatingBarcode", "description": "The rotating barcode type and value." }, +"saveRestrictions": { +"$ref": "SaveRestrictions", +"description": "Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass." +}, "smartTapRedemptionValue": { "description": "The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/workflowexecutions.v1.json b/googleapiclient/discovery_cache/documents/workflowexecutions.v1.json index e3373cbed58..b47dd7445f0 100644 --- a/googleapiclient/discovery_cache/documents/workflowexecutions.v1.json +++ b/googleapiclient/discovery_cache/documents/workflowexecutions.v1.json @@ -457,7 +457,7 @@ } } }, -"revision": "20240625", +"revision": "20240715", "rootUrl": "https://workflowexecutions.googleapis.com/", "schemas": { "Callback": { @@ -578,6 +578,20 @@ "description": "Output only. The error which caused the execution to finish prematurely. The value is only present if the execution's state is `FAILED` or `CANCELLED`.", "readOnly": true }, +"executionHistoryLevel": { +"description": "Optional. Describes the level of the execution history feature to apply to this execution. If not specified, the level of the execution history feature will be determined by its workflow's execution history level. If the value is different from its workflow's value, it will override the workflow's execution history level for this exeuction.", +"enum": [ +"EXECUTION_HISTORY_LEVEL_UNSPECIFIED", +"EXECUTION_HISTORY_BASIC", +"EXECUTION_HISTORY_DETAILED" +], +"enumDescriptions": [ +"The default/unset value.", +"Enable execution history basic feature for this execution.", +"Enable execution history detailed feature for this execution." +], +"type": "string" +}, "labels": { "additionalProperties": { "type": "string" diff --git a/googleapiclient/discovery_cache/documents/workflows.v1.json b/googleapiclient/discovery_cache/documents/workflows.v1.json index d57c0eeb70c..adae901dbf5 100644 --- a/googleapiclient/discovery_cache/documents/workflows.v1.json +++ b/googleapiclient/discovery_cache/documents/workflows.v1.json @@ -485,7 +485,7 @@ } } }, -"revision": "20240619", +"revision": "20240710", "rootUrl": "https://workflows.googleapis.com/", "schemas": { "Empty": { @@ -722,7 +722,7 @@ "type": "object" }, "Workflow": { -"description": "Workflow program to be executed by Workflows.", +"description": "LINT.IfChange Workflow program to be executed by Workflows.", "id": "Workflow", "properties": { "allKmsKeys": { diff --git a/googleapiclient/discovery_cache/documents/workstations.v1.json b/googleapiclient/discovery_cache/documents/workstations.v1.json index 8c77a7140ec..9b055ec85bb 100644 --- a/googleapiclient/discovery_cache/documents/workstations.v1.json +++ b/googleapiclient/discovery_cache/documents/workstations.v1.json @@ -1195,7 +1195,7 @@ } } }, -"revision": "20240709", +"revision": "20240716", "rootUrl": "https://workstations.googleapis.com/", "schemas": { "Accelerator": { @@ -1435,7 +1435,7 @@ "type": "boolean" }, "enableNestedVirtualization": { -"description": "Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. * **GPUs**: nested virtualization may not be enabled on workstation configurations with accelerators. * **Operating System**: because [Container-Optimized OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos) does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) image.", +"description": "Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Defaults to false. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series.", "type": "boolean" }, "machineType": { @@ -2356,7 +2356,7 @@ "type": "string" }, "enableAuditAgent": { -"description": "Optional. Whether to enable Linux `auditd` logging on the workstation. When enabled, a service account must also be specified that has `logging.buckets.write` permission on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging).", +"description": "Optional. Whether to enable Linux `auditd` logging on the workstation. When enabled, a service_account must also be specified that has `roles/logging.logWriter` and `roles/monitoring.metricWriter` on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging) and [Container output logging](http://cloud/workstations/docs/container-output-logging#overview). Operating system audit logs are available in the [Cloud Logging](https://cloud.google.com/logging/docs) console by querying: resource.type=\"gce_instance\" log_name:\"/logs/linux-auditd\"", "type": "boolean" }, "encryptionKey": { diff --git a/googleapiclient/discovery_cache/documents/workstations.v1beta.json b/googleapiclient/discovery_cache/documents/workstations.v1beta.json index 8dc060a1552..b6e1f3181b5 100644 --- a/googleapiclient/discovery_cache/documents/workstations.v1beta.json +++ b/googleapiclient/discovery_cache/documents/workstations.v1beta.json @@ -1127,7 +1127,7 @@ } } }, -"revision": "20240709", +"revision": "20240716", "rootUrl": "https://workstations.googleapis.com/", "schemas": { "Accelerator": { @@ -1233,7 +1233,7 @@ "type": "integer" }, "enableNestedVirtualization": { -"description": "Optional. Whether to enable nested virtualization on boosted Cloud Workstations VMs running using this boost configuration. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on boost configurations that specify a machine_type in the N1 or N2 machine series. * **GPUs**: nested virtualization may not be enabled on boost configurations with accelerators. * **Operating System**: Because [Container-Optimized OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos) does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) image. Defaults to false.", +"description": "Optional. Whether to enable nested virtualization on boosted Cloud Workstations VMs running using this boost configuration. Defaults to false. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on boost configurations that specify a machine_type in the N1 or N2 machine series.", "type": "boolean" }, "id": { @@ -1410,7 +1410,7 @@ "type": "boolean" }, "enableNestedVirtualization": { -"description": "Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. * **GPUs**: nested virtualization may not be enabled on workstation configurations with accelerators. * **Operating System**: because [Container-Optimized OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos) does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) image.", +"description": "Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Defaults to false. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series.", "type": "boolean" }, "machineType": { @@ -2051,6 +2051,14 @@ "description": "Optional. Client-specified annotations.", "type": "object" }, +"boostConfigs": { +"description": "Output only. List of available boost configuration ids that this workstation can be boosted up to", +"items": { +"$ref": "WorkstationBoostConfig" +}, +"readOnly": true, +"type": "array" +}, "createTime": { "description": "Output only. Time when this workstation was created.", "format": "google-datetime", @@ -2157,6 +2165,18 @@ }, "type": "object" }, +"WorkstationBoostConfig": { +"description": "Boost config for this workstation. This object is populated from the parent workstation config.", +"id": "WorkstationBoostConfig", +"properties": { +"id": { +"description": "Output only. Boost config id.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "WorkstationCluster": { "description": "A workstation cluster resource in the Cloud Workstations API. Defines a group of workstations in a particular region and the VPC network they're attached to.", "id": "WorkstationCluster", @@ -2318,7 +2338,7 @@ "type": "string" }, "enableAuditAgent": { -"description": "Optional. Whether to enable Linux `auditd` logging on the workstation. When enabled, a service account must also be specified that has `logging.buckets.write` permission on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging).", +"description": "Optional. Whether to enable Linux `auditd` logging on the workstation. When enabled, a service_account must also be specified that has `roles/logging.logWriter` and `roles/monitoring.metricWriter` on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging) and [Container output logging](http://cloud/workstations/docs/container-output-logging#overview). Operating system audit logs are available in the [Cloud Logging](https://cloud.google.com/logging/docs) console by querying: resource.type=\"gce_instance\" log_name:\"/logs/linux-auditd\"", "type": "boolean" }, "encryptionKey": {